Pulumi ESC: Python SDK
The Python SDK for Pulumi ESC (Environments, Secrets, and Configuration) allows you to automate Pulumi ESC.
Here are some of the scenarios the SDK can automate:
- List environments and read environment definitions
- Open enviroments to access config and resolve secrets
- Create, update, decrypt, and delete environment definitions
- Supports both structured types and yaml text
- List environment revisions and create new revision tags
- Check environment definitions for errors
Install the SDK package
Run pip install pulumi-esc-sdk
to install the SDK package.
Examples
These samples show how to create an EscClient
with an access token and use it to perform varias ESC tasks.
All of these example expects a PULUMI_ACCESS_TOKEN
and PULUMI_ORG
environment variable to be set.
Manage environment example
This example creates a new environment, opens that environment to access a secret, and the list the environments.
import pulumi_esc_sdk as esc
import os
accessToken = os.getenv("PULUMI_ACCESS_TOKEN")
orgName = os.getenv("PULUMI_ORG")
configuration = esc.Configuration(access_token=accessToken)
client = esc.EscClient(configuration)
projName = "examples"
envName = "sdk-python-example"
# Create environment
client.create_environment(orgName, projName, envName)
# create a new EnvironmentDefinition with "my_secret" as a secret in values additional_properties
envDef = esc.EnvironmentDefinition(
imports=[],
values=esc.EnvironmentDefinitionValues(
additional_properties={
"my_secret": {
"fn::secret": "shh! don't tell anyone"
}
}
)
)
# Update environment
client.update_environment(orgName, projName, envName, envDef)
# Open and read the environment
env, values, yaml = client.open_and_read_environment(orgName, projName, envName)
secret = values["my_secret"]
print(f'Secret: {secret}\n')
# List environments
environments = client.list_environments(orgName)
for env in environments.environments:
print(f'Environment: {env.project}/{env.name}')
Tag revision example
This example lists revisions for an environment, tags a revision, and lists revision tags.
import pulumi_esc_sdk as esc
import os
accessToken = os.getenv("PULUMI_ACCESS_TOKEN")
orgName = os.getenv("PULUMI_ORG")
configuration = esc.Configuration(access_token=accessToken)
client = esc.EscClient(configuration)
projName = "examples"
envName = "sdk-python-example"
# list environment revisions
revisions = client.list_environment_revisions(orgName, projName, envName)
# get second latest revision
second_latest_revision = revisions[1]
# create a new environment revision tag
client.create_environment_revision_tag(orgName, projName, envName, "stable", second_latest_revision.number)
print(f'Tagged revision {second_latest_revision.number} as stable')
# list environment revision tags
tags = client.list_environment_revision_tags(orgName, projName, envName)
for tag in tags.tags:
print(f'Tag {tag.name} at revision {tag.revision}')
Thank you for your feedback!
If you have a question about how to use Pulumi, reach out in Community Slack.
Open an issue on GitHub to report a problem or suggest an improvement.