Skip to content

docs: add ephemeral namespace workflow how-to - #590

Merged
openshift-merge-bot[bot] merged 7 commits into
openshift:mainfrom
gurnben:ephemeral-namespace-workflow-docs
Apr 3, 2026
Merged

docs: add ephemeral namespace workflow how-to#590
openshift-merge-bot[bot] merged 7 commits into
openshift:mainfrom
gurnben:ephemeral-namespace-workflow-docs

Conversation

@gurnben

Copy link
Copy Markdown
Member

Summary

  • Adds a new how-to page documenting the ephemeral-namespace Prow workflow for reserving and releasing consoledot ephemeral namespaces in OpenShift CI jobs.
  • Covers background concepts (bonfire, the ephemeral namespace operator, Firelink/InScope UIs), architecture, quick start, environment variables, full ci-operator examples, deploying with bonfire, and troubleshooting.

Details

This workflow was recently contributed to openshift/release under ci-operator/step-registry/ephemeral/namespace/. It provides a reusable pre/post step pair that:

  1. Pre: Installs bonfire, logs into the ephemeral cluster, reserves a namespace, and writes connection details to SHARED_DIR
  2. Test: Empty — consumers inject their own test steps
  3. Post: Releases the namespace back to the pool (with CR-patch fallback), runs as best_effort

The documentation is aimed at new users who haven't worked with ephemeral namespaces before and links out to bonfire docs, Firelink, and InScope.

Test plan

  • Verify the page renders correctly in the Hugo site
  • Review YAML examples for accuracy against the actual workflow definitions
  • Confirm all external links resolve

💘 Generated with Crush

Add documentation for the new ephemeral-namespace Prow workflow that
automates reserving and releasing consoledot ephemeral namespaces in
OpenShift CI jobs. Covers background concepts (bonfire, the ephemeral
namespace operator, Firelink/InScope UIs), architecture, quick start,
environment variables, full ci-operator examples, and troubleshooting.
💘 Generated with Crush
Assisted-by: Claude Opus 4.6 via Crush <crush@charm.land>
Remove Clowder/ClowdApp references (Clowder is being decommissioned),
consoledot/console.redhat.com team-specific language (ephemeral is now
open to all engineering teams), and the bonfire deploy documentation
section (deployment API is being reworked to remove Clowder dependency).
💘 Generated with Crush
Assisted-by: Claude Opus 4.6 via Crush <crush@charm.land>
The Konflux ephemeral cluster feature is unrelated enough to omit.
💘 Generated with Crush
Assisted-by: Claude Opus 4.6 via Crush <crush@charm.land>
Add a Namespace Pools section documenting all four available pools
(default, default-pvc, minimal, ai-development) with their pool sizes,
included services, ResourceQuota limits, and shared LimitRange defaults.
Data sourced from app-interface NamespacePool CRs.
💘 Generated with Crush
Assisted-by: Claude Opus 4.6 via Crush <crush@charm.land>
💘 Generated with Crush
Assisted-by: Claude Opus 4.6 via Crush <crush@charm.land>
Show concrete oc commands (apply, wait) and explain that once KUBECONFIG
is set, users can run oc commands exactly as they would against any
OpenShift cluster.
💘 Generated with Crush
Assisted-by: Claude Opus 4.6 via Crush <crush@charm.land>
@gurnben

Copy link
Copy Markdown
MemberAuthor

/cc @bsquizz

@openshift-ci
openshift-ciBot requested a review from bsquizzApril 3, 2026 14:49
@gurnben

Copy link
Copy Markdown
MemberAuthor

/cc @maknop

@openshift-ci
openshift-ciBot requested a review from maknopApril 3, 2026 14:49
@gurnben

Copy link
Copy Markdown
MemberAuthor

Workflow verified to work on this PR: openshift-online/osci-workflow-validation#2

Firelink and InScope URLs are internal Red Hat services that fail SSL
validation in CI. Convert them from hyperlinks to inline code URLs so
the link checker does not try to validate them.
💘 Generated with Crush
Assisted-by: Claude Opus 4.6 via Crush <crush@charm.land>
@gurnben

Copy link
Copy Markdown
MemberAuthor

The ci/prow/links failure is expected and will resolve on merge. The only failure from this PR's page is the Hugo theme's auto-generated "Edit this page" link (https://github.com/openshift/ci-docs/tree/main/content/en/how-tos/ephemeral-namespace-workflow.md), which 404s because the file doesn't exist on main yet.

The remaining 6 link failures are all pre-existing broken links in other docs (ci-operator, testgrid, artifacts, onboarding, steps) — unrelated to this change.

@deepsm007

Copy link
Copy Markdown
Contributor

/lgtm

@openshift-ciopenshift-ciBot added the lgtm Indicates that a PR is ready to be merged. label Apr 3, 2026
@openshift-ci

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: deepsm007, gurnben

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

The pull request process is described 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-ciopenshift-ciBot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 3, 2026
@openshift-merge-bot

Copy link
Copy Markdown
Contributor

/retest-required

Remaining retests: 0 against base HEAD 202c6f3 and 2 for PR HEAD 2713321 in total

@jupierce

Copy link
Copy Markdown
Contributor

/override ci/prow/links

@openshift-ci

Copy link
Copy Markdown
Contributor

@jupierce: Overrode contexts on behalf of jupierce: ci/prow/links

Details

In response to this:

/override ci/prow/links

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.

@openshift-ci

Copy link
Copy Markdown
Contributor

@gurnben: all tests passed!

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.

@openshift-merge-bot
openshift-merge-botBot merged commit 2df68d1 into openshift:mainApr 3, 2026
3 checks passed
redhat-chai-bot pushed a commit to redhat-chai-bot/ci-docs that referenced this pull request Apr 6, 2026
…space workflow
In OpenShift CI, "ephemeral cluster" conventionally refers to temporary
clusters that are created, tested, and destroyed. The permanent central
cluster used for Bonfire namespace management is not ephemeral — it is
a long-lived host cluster.
This commit updates the ephemeral-namespace-workflow documentation
(introduced in PR openshift#590) to use "Bonfire host cluster" instead of
"ephemeral cluster" when referring to the permanent cluster that hosts
the Ephemeral Namespace Operator and namespace pools.
File names in SHARED_DIR (ephemeral-kubeconfig, ephemeral-cluster-server,
ephemeral-namespace) are left unchanged as they are actual artifact names
used by the workflow steps.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approvedIndicates a PR has been approved by an approver from all required OWNERS files.lgtmIndicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@gurnben@deepsm007@jupierce