Skip to content

docs(secrets): document secret set readiness and async provisioning#801

Merged
markbackman merged 1 commit into
mainfrom
ms/pcc-secret-set-readiness
May 7, 2026
Merged

docs(secrets): document secret set readiness and async provisioning#801
markbackman merged 1 commit into
mainfrom
ms/pcc-secret-set-readiness

Conversation

@mattshep
Copy link
Copy Markdown
Contributor

@mattshep mattshep commented May 7, 2026

The API now treats secret-set provisioning as asynchronous and exposes a per-set readiness status (ready / pending / failed) on GET responses. Deploys that bind a secret set or image pull secret are gated on the ready state and rejected with 409 Conflict otherwise.

  • Fundamentals: add a "Provisioning and readiness" section to secrets.mdx and a 409-deploy entry in error-codes.mdx.
  • REST reference: PUT /secrets/{setName} returns 202; add 409 for concurrent modification; GET single + list responses include the new status and errorMessage fields.
  • CLI reference: note the readiness state shown in pcc secrets list, and that --secrets, --credentials, secret_set, and image_credentials must reference a ready set.

The API now treats secret-set provisioning as asynchronous and exposes
a per-set readiness status (ready / pending / failed) on GET responses.
Deploys that bind a secret set or image pull secret are gated on the
ready state and rejected with 409 Conflict otherwise.

- Fundamentals: add a "Provisioning and readiness" section to
  secrets.mdx and a 409-deploy entry in error-codes.mdx.
- REST reference: PUT /secrets/{setName} returns 202; add 409 for
  concurrent modification; GET single + list responses include the new
  status and errorMessage fields.
- CLI reference: note the readiness state shown in `pcc secrets list`,
  and that `--secrets`, `--credentials`, `secret_set`, and
  `image_credentials` must reference a ready set.
@mattshep mattshep requested a review from markbackman May 7, 2026 15:00
@mattshep mattshep self-assigned this May 7, 2026
@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 7, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
daily 🟢 Ready View Preview May 7, 2026, 3:02 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mattshep
Copy link
Copy Markdown
Contributor Author

mattshep commented May 7, 2026

This is good to merge now, the corresponding changes are live in prod.

Copy link
Copy Markdown
Contributor

@markbackman markbackman left a comment

Choose a reason for hiding this comment

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

LGTM

@markbackman markbackman merged commit c472f88 into main May 7, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants