Skip to content

docs(ci): add operational runbooks for non-migratable Entra ID scripts - #6171

Draft
Ghazi Alchammat (galchammat) wants to merge 2 commits into
Azure:mainfrom
galchammat:aroslsre-1353-entra-id-runbooks
Draft

docs(ci): add operational runbooks for non-migratable Entra ID scripts#6171
Ghazi Alchammat (galchammat) wants to merge 2 commits into
Azure:mainfrom
galchammat:aroslsre-1353-entra-id-runbooks

Conversation

@galchammat

Copy link
Copy Markdown
Collaborator

AROSLSRE-1353 | ARO-27252

What

Adds three SOPs in docs/sops/ documenting the Entra ID management scripts that cannot be migrated to declarative Bicep:

  • ci-bot-secret-provisioning.md -- CI bot client secret creation and Key Vault storage
  • release-bot-msft-test-tenant.md -- Release Bot setup and credential rotation in the Microsoft E2E tenant (cross-tenant + HashiCorp Vault)
  • tenant-quota-service-principals.md -- Tenant quota collector SP creation and secret rotation (cross-tenant + admin consent)

Why

The ARO-27252 assessment classified these scripts as "needs a different approach" due to cross-tenant operations, external secret stores (HashiCorp Vault), and imperative credential rotation. They remain the active management path and had no operational documentation.

Testing

Docs only -- no code changes. Verified all script paths and commands reference existing files.

PR Checklist

  • PR is scoped to a single task (no mixed concerns)
  • Title follows Conventional Commits format
  • Summary explains the "Why" behind the change
  • Linked to relevant ticket/issue
  • Screenshots included (if graph/UI/metrics changes) -- N/A
  • Self-reviewed the diff
  • CI/CD checks are passing (ignore Tide) -- draft, pending CI
  • Draft PR used for WIP (if applicable)
  • Commit history is clean (rebased/squashed)
  • Tricky code blocks are commented -- N/A
  • Specific reviewers tagged -- will tag when ready for review
  • All comment threads resolved before merge

🤖 Generated with Claude Code

Adds SOPs for the three groups of Entra ID management scripts that
cannot be migrated to Bicep due to cross-tenant operations, external
secret stores, or imperative credential rotation.

Refs: ARO-27252, AROSLSRE-1353

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@openshift-ci

openshift-ci Bot commented Jul 20, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: galchammat
Once this PR has been reviewed and has the lgtm label, please assign raelga for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci

openshift-ci Bot commented Jul 20, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

1 similar comment
@openshift-ci

openshift-ci Bot commented Jul 20, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@galchammat Ghazi Alchammat (galchammat) changed the title docs: add operational runbooks for non-migratable Entra ID scripts docs(ci): add operational runbooks for non-migratable Entra ID scripts Jul 20, 2026
@galchammat

Copy link
Copy Markdown
Collaborator Author

/test all

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR adds operational SOP documentation under docs/sops/ for Entra ID management scripts that remain imperative (cross-tenant operations, external secret stores, and credential rotation) and therefore aren’t candidates for declarative Bicep migration.

Changes:

  • Added SOP for CI bot Entra client secret provisioning into Azure Key Vault.
  • Added SOP for Release Bot MSFT Test tenant credential creation/rotation with HashiCorp Vault integration.
  • Added SOP for tenant-quota collector service principal creation and secret rotation workflows.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
docs/sops/tenant-quota-service-principals.md New runbook for creating/rotating tenant-quota collector SPs and secrets across tenants.
docs/sops/release-bot-msft-test-tenant.md New runbook for Release Bot MSFT Test tenant setup and Vault-backed credential rotation.
docs/sops/ci-bot-secret-provisioning.md New runbook for manual backfill/provisioning of CI bot secrets into Key Vault.

Comment thread docs/sops/tenant-quota-service-principals.md Outdated
Comment thread docs/sops/tenant-quota-service-principals.md Outdated
Comment thread docs/sops/tenant-quota-service-principals.md Outdated
@openshift-ci

openshift-ci Bot commented Jul 20, 2026

Copy link
Copy Markdown

Ghazi Alchammat (@galchammat): The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/images 2170399 link true /test images

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

… script update

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@galchammat

Copy link
Copy Markdown
Collaborator Author

Copilot review

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