Skip to content

Deployments: Fix OIDC Setup Instructions #15085

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

Closed
jkodroff opened this issue May 16, 2025 · 0 comments · Fixed by #15090
Closed

Deployments: Fix OIDC Setup Instructions #15085

jkodroff opened this issue May 16, 2025 · 0 comments · Fixed by #15090
Assignees
Labels
kind/enhancement Improvements or new features resolution/fixed This issue was fixed

Comments

@jkodroff
Copy link
Member

jkodroff commented May 16, 2025

We have OIDC setup pages in the Pulumi Cloud docs:

These pages are attempting to serve two purposes in a single page: configuring OIDC for both Deployments and ESC.

We already have pages that cover OIDC setup end-to-end specifically for ESC:

In order to fix this issue, we should:

  1. Move the "Open ID provider" page and its children under "Deployments" in the navigation, add the appropriate aliases, and re-title the main page to "OIDC Setup" since that's what it's called in the Deployments settings UI (OIDC). (This needs to be a git mv operation in order to preserve document history and make the diff easier to review).
  2. In the main OIDC setup page, clearly explain that this page is describing how a deployment can get the necessary cloud credentials in order to manage resources. If the reader is looking for what permissions a deployment has within Pulumi Cloud itself, they should go to https://www.pulumi.com/docs/pulumi-cloud/deployments/reference/#deployment-permissions instead.
  3. Remove the content from "OIDC Setup" and each of its children each cloud setup page that pertains to ESC.
  4. Add a note shortcode of type "info" with identical text on each page that states that ESC should be the preferred approach over the Deployments OIDC integrations since it's more portable and easier to set up.
  5. Remove the section on automation from each cloud's setup page because the code it links to is out of date.
@jkodroff jkodroff added the needs-triage Needs attention from the triage team label May 16, 2025
@jkodroff jkodroff self-assigned this May 16, 2025
@jkodroff jkodroff added kind/enhancement Improvements or new features and removed needs-triage Needs attention from the triage team labels May 16, 2025
@github-project-automation github-project-automation bot moved this to 🤔 Triage in Docs 📚 May 16, 2025
@github-project-automation github-project-automation bot moved this from 🤔 Triage to 🏁 Done in Docs 📚 May 29, 2025
@pulumi-bot pulumi-bot added the resolution/fixed This issue was fixed label May 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement Improvements or new features resolution/fixed This issue was fixed
Projects
Status: 🏁 Done
2 participants