pulumi-org
Manage Pulumi organizations
TLDR
Display the default organization and current backend
Display the default organization
Set the default organization
Search for resources in Pulumi Cloud using Pulumi AI with a plaintext natural language query
Display help
SYNOPSIS
pulumi org command [options]
PARAMETERS
create
Creates a new Pulumi organization.
delete
Deletes an existing Pulumi organization. This action is irreversible.
disable
Disables an organization, preventing new stack updates or deployments within it.
edit
Edits general settings of an organization, such as its display name or description.
feature
Manages feature flags and experimental capabilities for an organization.
get
Retrieves detailed information about a specific organization, including its ID and current status.
invite
Invites a user to join an organization, typically via their email address.
list
Lists all organizations the current authenticated user is a member of.
member
Provides further subcommands for comprehensive management of organization members and their assigned roles.
patch
Patches specific settings of an organization, applying partial updates.
remove
Removes a user from an organization's membership.
rename
Renames an existing organization.
role
Provides subcommands for managing organization roles and their associated permissions.
settings
Manages various organization-wide settings, including billing, security, and integration configurations.
url
Displays the Pulumi Cloud URL for a given organization, allowing direct access to its web console.
validate
Validates the state or configuration of an organization.
upgrade
Upgrades an organization's plan or enables specific premium features.
audit-log
Accesses the audit log for an organization, providing a history of significant actions.
search
Searches for resources, stacks, or other entities within an organization.
DESCRIPTION
The pulumi org command is a fundamental subcommand within the Pulumi Command Line Interface (CLI), designed specifically for the management of Pulumi organizations. In the Pulumi ecosystem, organizations serve as logical containers for projects, stacks, and users, facilitating collaborative infrastructure management and resource isolation. This command empowers administrators and team leads to perform a variety of crucial tasks, including the creation of new organizations, renaming existing ones, inviting and removing members, and retrieving detailed information about organization settings and activity.
It plays a vital role in enabling team collaboration, enforcing access control policies, and segregating cloud resources across different teams or environments. The pulumi org command interacts directly with the Pulumi Cloud backend or a self-hosted Pulumi service to maintain the state of organizations, manage user permissions, and ensure proper governance of infrastructure as code. Successful execution of these commands typically requires the user to possess appropriate administrative permissions within the Pulumi service.
CAVEATS
The pulumi org command is a subcommand of the main pulumi CLI tool, not a standalone Linux command. It requires the Pulumi CLI to be installed and properly configured, including authentication with a Pulumi backend (Pulumi Cloud or a self-hosted service). Actions performed with this command are subject to the user's permissions within the Pulumi organization. Operations like pulumi org delete are irreversible and should be used with extreme caution.
GLOBAL PULUMI CLI OPTIONS
Many Pulumi CLI commands, including pulumi org and its subcommands, support a set of global options that can modify their behavior across the entire CLI. While not specific to pulumi org, these are often used in conjunction with it:
- --json: Emits command output in JSON format, useful for scripting and automation.
- --non-interactive: Disables interactive prompts, making the command suitable for automated environments.
- --debug: Enables verbose debug logging for troubleshooting.
- --logtostderr: Directs log output to stderr.
- --tracing: Enables OpenTracing for command execution.
- --verbose: Enables verbose output.
BACKEND INTERACTION
The pulumi org command operates by communicating with a Pulumi backend. By default, this is the Pulumi Cloud (app.pulumi.com), but it can also be a self-hosted Pulumi Service instance. The command's ability to create, modify, or delete organizations and their members is entirely dependent on a successful connection and authentication with the configured backend, and the user's granted permissions within that backend.
HISTORY
The pulumi org command set emerged as part of the Pulumi platform's evolution to support enterprise-grade infrastructure-as-code deployments. Pulumi, founded in 2017 with its open-source CLI and cloud service launched in 2018, rapidly introduced capabilities for team collaboration and multi-user environments. The org commands were specifically developed to enable organizations to manage shared cloud resources, enforce access control policies through roles, and segregate development, staging, and production environments effectively. Its functionality has continuously expanded, incorporating features like audit logging and more granular security settings, to meet the growing demands for governance and operational visibility in cloud resource management.