Skip to content

Commit

Permalink
Update installation-configuration.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cnunciato authored Mar 13, 2024
1 parent 40cf9dd commit f8ed6ca
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/installation-configuration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Control Plane (cpln) Installation & Configuration
meta_desc: Information on how to install the Control Plane (cpln) provider.
layout: installation
layout: package
---

## Installation
Expand All @@ -15,7 +15,9 @@ The Pulumi Control Plane (cpln) provider is available as a package in all Pulumi

## Setup

To provision resources with the Pulumi Control Plane (cpln) provider, you need to [authenticate with one of the available options](https://registry.terraform.io/providers/controlplane-com/cpln/latest/docs#authentication).
To provision resources with the Pulumi Control Plane (cpln) provider, you need to authenticate with one of the available options.

TODO: Enumerate those here.

## Configuration Options

Expand All @@ -24,7 +26,7 @@ Use `pulumi config set cpln:<option>`.
| Option | Required/Optional | Description |
|-----|------|----|
| `org`| Required | The Control Plane org that this provider will perform actions against. Can be specified with the `CPLN_ORG` environment variable. |
| `endpoint`| Optional | The Control Plane Data Service API endpoint. Default is: `https://api.cpln.io`. Can be specified with the `CPLN_ENDPOINT` environment variable |
| `endpoint`| Optional | The Control Plane Data Service API endpoint. Default is: `https://api.cpln.io`. Can be specified with the `CPLN_ENDPOINT` environment variable. |
| `profile`| Optional | The user/service account profile that this provider will use to authenticate to the data service. Can be specified with the `CPLN_PROFILE` environment variable. |
| `token`| Optional | A generated token that can be used to authenticate to the data service API. Can be specified with the `CPLN_TOKEN` environment variable |
| `refreshToken`| Optional | A generated token that can be used to authenticate to the data service API. Can be specified with the `CPLN_REFRESH_TOKEN` environment variable. Used when the provider is required to create an org or update the `authConfig` property. Refer to the [auth docs](https://registry.terraform.io/providers/controlplane-com/cpln/latest/docs#authentication) on how to obtain the refresh token. |
| `refreshToken`| Optional | A generated token that can be used to authenticate to the data service API. Can be specified with the `CPLN_REFRESH_TOKEN` environment variable. Used when the provider is required to create an org or update the `authConfig` property. Refer to the [auth docs](https://registry.terraform.io/providers/controlplane-com/cpln/latest/docs#authentication) on how to obtain the refresh token. |

0 comments on commit f8ed6ca

Please sign in to comment.