-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
273 additions
and
273 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,80 @@ | ||
| --- | ||
| title: Control Plane (cpln) | ||
| meta_desc: Provides an overview of the Control Plane (cpln) Provider for Pulumi. | ||
| layout: overview | ||
| --- | ||
|
|
||
| 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. | ||
|
|
||
| ## Example | ||
|
|
||
| {{< chooser language "typescript,python,go,csharp" >}} | ||
| {{% choosable language typescript %}} | ||
|
|
||
| ```typescript | ||
| import * as cpln from "@pulumiverse/cpln"; | ||
|
|
||
| const location = new cpln.Location("example", { | ||
| name: "aws-us-west-2" | ||
| }); | ||
| ``` | ||
|
|
||
| {{% /choosable %}} | ||
| {{% choosable language python %}} | ||
|
|
||
| ```python | ||
| import pulumiverse_cpln as cpln | ||
|
|
||
| db = cpln.Location("example", | ||
| name="aws-us-west-2" | ||
| ) | ||
| ``` | ||
|
|
||
| {{% /choosable %}} | ||
| {{% choosable language go %}} | ||
|
|
||
| ```go | ||
| import ( | ||
| "fmt" | ||
| cpln "github.com/pulumiverse/pulumi-cpln/sdk/go/cpln" | ||
| "github.com/pulumi/pulumi/sdk/v3/go/pulumi" | ||
| ) | ||
|
|
||
| func main() { | ||
| pulumi.Run(func(ctx *pulumi.Context) error { | ||
|
|
||
| location, err := cpln.NewLocation(ctx, "example", &cpln.LocationArgs{ | ||
| Name: pulumi.String("aws-us-west-2"), | ||
| }) | ||
| if err != nil { | ||
| return fmt.Errorf("error creating location: %v", err) | ||
| } | ||
|
|
||
| ctx.Export("location.enabled", location.enabled) | ||
|
|
||
| return nil | ||
| }) | ||
| } | ||
| ``` | ||
|
|
||
| {{% /choosable %}} | ||
| {{% choosable language csharp %}} | ||
|
|
||
| ```csharp | ||
| using Pulumi; | ||
| using Pulumiverse.cpln; | ||
|
|
||
| class cpln : Stack | ||
| { | ||
| public cpln() | ||
| { | ||
| var location = new Location("example", new LocationArgs{ | ||
| Name: "example" | ||
| }); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| {{% /choosable %}} | ||
|
|
||
| --- | ||
| title: Control Plane (cpln) | ||
| meta_desc: Provides an overview of the Control Plane (cpln) Provider for Pulumi. | ||
| layout: overview | ||
| --- | ||
|
|
||
| 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. | ||
|
|
||
| ## Example | ||
|
|
||
| {{< chooser language "typescript,python,go,csharp" >}} | ||
| {{% choosable language typescript %}} | ||
|
|
||
| ```typescript | ||
| import * as cpln from "@pulumiverse/cpln"; | ||
|
|
||
| const location = new cpln.Location("example", { | ||
| name: "aws-us-west-2" | ||
| }); | ||
| ``` | ||
|
|
||
| {{% /choosable %}} | ||
| {{% choosable language python %}} | ||
|
|
||
| ```python | ||
| import pulumiverse_cpln as cpln | ||
|
|
||
| db = cpln.Location("example", | ||
| name="aws-us-west-2" | ||
| ) | ||
| ``` | ||
|
|
||
| {{% /choosable %}} | ||
| {{% choosable language go %}} | ||
|
|
||
| ```go | ||
| import ( | ||
| "fmt" | ||
| cpln "github.com/pulumiverse/pulumi-cpln/sdk/go/cpln" | ||
| "github.com/pulumi/pulumi/sdk/v3/go/pulumi" | ||
| ) | ||
|
|
||
| func main() { | ||
| pulumi.Run(func(ctx *pulumi.Context) error { | ||
|
|
||
| location, err := cpln.NewLocation(ctx, "example", &cpln.LocationArgs{ | ||
| Name: pulumi.String("aws-us-west-2"), | ||
| }) | ||
| if err != nil { | ||
| return fmt.Errorf("error creating location: %v", err) | ||
| } | ||
|
|
||
| ctx.Export("location.enabled", location.enabled) | ||
|
|
||
| return nil | ||
| }) | ||
| } | ||
| ``` | ||
|
|
||
| {{% /choosable %}} | ||
| {{% choosable language csharp %}} | ||
|
|
||
| ```csharp | ||
| using Pulumi; | ||
| using Pulumiverse.cpln; | ||
|
|
||
| class cpln : Stack | ||
| { | ||
| public cpln() | ||
| { | ||
| var location = new Location("example", new LocationArgs{ | ||
| Name: "example" | ||
| }); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| {{% /choosable %}} | ||
|
|
||
| {{< /chooser >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,30 @@ | ||
| --- | ||
| title: Control Plane (cpln) Installation & Configuration | ||
| meta_desc: Information on how to install the Control Plane (cpln) provider. | ||
| layout: installation | ||
| --- | ||
|
|
||
| ## Installation | ||
|
|
||
| The Pulumi Control Plane (cpln) provider is available as a package in all Pulumi languages: | ||
|
|
||
| * JavaScript/TypeScript: [`@pulumiserve/cpln`](https://www.npmjs.com/package/@pulumiverse/cpln) | ||
| * Python: [`pulumiverse_cpln`](https://pypi.org/project/pulumiverse-cpln/) | ||
| * Go: [`github.com/pulumiverse/pulumi-cpln/sdk/go/cpln`](https://pkg.go.dev/github.com/pulumiverse/pulumi-cpln/sdk) | ||
| * .NET: [`Pulumiverse.cpln`](https://www.nuget.org/packages/Pulumiverse.cpln) | ||
|
|
||
| ## 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). | ||
|
|
||
| ## Configuration Options | ||
|
|
||
| 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 | | ||
| | `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 | | ||
| --- | ||
| title: Control Plane (cpln) Installation & Configuration | ||
| meta_desc: Information on how to install the Control Plane (cpln) provider. | ||
| layout: installation | ||
| --- | ||
|
|
||
| ## Installation | ||
|
|
||
| The Pulumi Control Plane (cpln) provider is available as a package in all Pulumi languages: | ||
|
|
||
| * JavaScript/TypeScript: [`@pulumiserve/cpln`](https://www.npmjs.com/package/@pulumiverse/cpln) | ||
| * Python: [`pulumiverse_cpln`](https://pypi.org/project/pulumiverse-cpln/) | ||
| * Go: [`github.com/pulumiverse/pulumi-cpln/sdk/go/cpln`](https://pkg.go.dev/github.com/pulumiverse/pulumi-cpln/sdk) | ||
| * .NET: [`Pulumiverse.cpln`](https://www.nuget.org/packages/Pulumiverse.cpln) | ||
|
|
||
| ## 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). | ||
|
|
||
| ## Configuration Options | ||
|
|
||
| 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 | | ||
| | `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. | |
Oops, something went wrong.