-
Notifications
You must be signed in to change notification settings - Fork 12
docs: Document usage of Plural Terraform provider from Pulumi #613
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
maciaszczykm
merged 1 commit into
main
from
marcin/prod-5102-document-pulumi-provider-usage
Aug 4, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| --- | ||
| title: Using from Pulumi | ||
| description: >- | ||
| Use the Plural Terraform provider from Pulumi via the Any Terraform Provider bridge | ||
| --- | ||
|
|
||
| Pulumi can consume the same [`pluralsh/plural`](https://registry.terraform.io/providers/pluralsh/plural) Terraform provider through the [Any Terraform Provider](https://www.pulumi.com/docs/iac/concepts/providers/any-terraform-provider/) bridge. There is no separate package on PyPI or npm — the SDK is generated locally in your project. | ||
|
|
||
| ```bash | ||
| pulumi new python # or typescript, go, etc. | ||
| pulumi package add terraform-provider pluralsh/plural <version> | ||
| pulumi install | ||
| ``` | ||
|
|
||
| Pin `<version>` for reproducible builds (recommended), or omit it to use the latest registry release. | ||
|
|
||
| Credentials (either): | ||
|
|
||
| * `plural cd login`, then `use_cli=True` / `PLURAL_USE_CLI=true` | ||
| * `PLURAL_CONSOLE_URL` + `PLURAL_ACCESS_TOKEN` | ||
|
|
||
| Optional kubeconfig at `~/.kube/config` for agent install. See also [Configuring the Provider](/api-reference/terraform#configuring-the-provider). | ||
|
|
||
| ```bash | ||
| pulumi preview | ||
| pulumi up | ||
| ``` | ||
|
|
||
| ## Example | ||
|
|
||
| Python equivalent of a Terraform `plural_cluster`: | ||
|
|
||
| ```python | ||
| import pulumi | ||
| import pulumi_plural as plural | ||
|
|
||
| provider = plural.Provider("plural", use_cli=True) | ||
| opts = pulumi.ResourceOptions(provider=provider) | ||
|
|
||
| default_project = plural.get_project( | ||
| name="default", | ||
| opts=pulumi.InvokeOptions(provider=provider), | ||
| ) | ||
|
|
||
| cluster = plural.Cluster( | ||
| "test", | ||
| name="test-cluster", | ||
| handle="test", | ||
| project_id=default_project.id, | ||
| opts=opts, | ||
| ) | ||
|
|
||
| pulumi.export("cluster_id", cluster.id) | ||
| ``` | ||
|
|
||
| | Terraform | Pulumi Python | | ||
| | --- | --- | | ||
| | `provider "plural"` | `plural.Provider(...)` | | ||
| | `plural_cluster` | `plural.Cluster` | | ||
| | `data.plural_project` | `plural.get_project(...)` | | ||
| | `use_cli` | `use_cli` | | ||
| | `kubeconfig.config_path` | `ProviderKubeconfigArgs(config_path=...)` | | ||
|
|
||
| See [pluralsh/pulumi-plural](https://github.com/pluralsh/pulumi-plural) for a fuller example. | ||
|
|
||
| {% callout severity="info" %} | ||
| To run Pulumi programs through Plural Stacks, create an `InfrastructureStack` with `type: PULUMI` (see [Pulumi stacks](/plural-features/stacks-iac-management/pulumi)). | ||
| {% /callout %} | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a reader copies this setup command as shown, Bash interprets
<version>as input redirection from a file namedversion, causing the command to fail before Pulumi can generate the SDK.