Skip to content
This repository has been archived by the owner on Jul 1, 2024. It is now read-only.

Update deployment runners docs to include new oidc capabilities #4284

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,19 @@ Agents poll Pulumi Cloud every 30 seconds to check for pending deployments and w
If you are running the agent inside a firewall ensure to allow outbound requests to api.pulumi.com. Ensure agents have the cloud provider credentials to be able to deploy in your environments.
{{% /notes %}}

### Leveraging OpenID authentication
glena marked this conversation as resolved.
Show resolved Hide resolved

It is possible to use OpenID authentication to fetch Pulumi Pool tokens dinamically instead of having to configure a static token for the agents. To configure it, first it is required to register the OpenID provider as a trusted OIDC issuer in your pulumi account. For more information about this, refer to the [OIDC documentation](/docs/pulumi-cloud/oidc/client).
glena marked this conversation as resolved.
Show resolved Hide resolved

After that, there are a few configurations required by the agent:
glena marked this conversation as resolved.
Show resolved Hide resolved

- `organization_name`: your Pulumi organization name
glena marked this conversation as resolved.
Show resolved Hide resolved
- `runner_pool_id`: the pool id the instance will connect to
glena marked this conversation as resolved.
Show resolved Hide resolved
- `token_expiration` (optional): the expiration for the tokens requested by the agent
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is the format for this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in seconds, I just updated it

- `oidc_token_file`: the location of the file where the OIDC token will be dumped
glena marked this conversation as resolved.
Show resolved Hide resolved

The agent will attempt to read the `oidc_token_file` for a fresh OIDC token and exchange it automatically for a Pulumi token after each time the Pulumi token expires.
glena marked this conversation as resolved.
Show resolved Hide resolved

## Providing Credentials to Agents

There are two methods to provide cloud provider credentials to the agents:
Expand Down
Loading