Skip to content

Commit

Permalink
Merge pull request #4 from cnunciato/patch-1
Browse files Browse the repository at this point in the history
Make a few docs tweaks
  • Loading branch information
vavsab authored Mar 13, 2024
2 parents 6ddb237 + f8ed6ca commit 399aa29
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
10 changes: 5 additions & 5 deletions docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Control Plane (cpln)
meta_desc: Provides an overview of the Control Plane (cpln) Provider for Pulumi.
layout: overview
layout: package
---

The Control Plane (cpln) pulumi provider enables the scaffolding of any Control Plane(https://controlplane.com/) object as cose. It enables infrastructure as code with all the added benefit of the global virtual cloud (GVC). You can build your VPCs, subnets, databases, queues, caches, etc. and overlay them with a multi-cloud/multi-region universal compute workloads that span regions and clouds. Nearly everything you can do using the Control Plane CLI, UI or API is available using Pulumi.
The Control Plane (cpln) Pulumi provider enables the scaffolding of any Control Plane (https://controlplane.com/) object as code. It enables infrastructure as code with all the added benefit of the global virtual cloud (GVC). You can build your VPCs, subnets, databases, queues, caches, etc., and overlay them with a multi-cloud/multi-region universal compute workloads that span regions and clouds. Nearly everything you can do using the Control Plane CLI, UI or API is available using Pulumi.

## Example

Expand All @@ -15,7 +15,7 @@ The Control Plane (cpln) pulumi provider enables the scaffolding of any Control
import * as cpln from "@pulumiverse/cpln";

const location = new cpln.Location("example", {
name: "aws-us-west-2"
name: "aws-us-west-2"
});
```

Expand Down Expand Up @@ -44,7 +44,7 @@ func main() {
pulumi.Run(func(ctx *pulumi.Context) error {

location, err := cpln.NewLocation(ctx, "example", &cpln.LocationArgs{
Name: pulumi.String("aws-us-west-2"),
Name: pulumi.String("aws-us-west-2"),
})
if err != nil {
return fmt.Errorf("error creating location: %v", err)
Expand Down Expand Up @@ -77,4 +77,4 @@ class cpln : Stack

{{% /choosable %}}

{{< /chooser >}}
{{< /chooser >}}
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 399aa29

Please sign in to comment.