Skip to content

procedures: clarify conditional registry auth secret copying for DevWorkspace backups#3091

Closed
tolusha wants to merge 1 commit into
mainfrom
doc-devworkspace-backup-registry-auth-pr1618
Closed

procedures: clarify conditional registry auth secret copying for DevWorkspace backups#3091
tolusha wants to merge 1 commit into
mainfrom
doc-devworkspace-backup-registry-auth-pr1618

Conversation

@tolusha
Copy link
Copy Markdown
Contributor

@tolusha tolusha commented May 11, 2026

What does this pull request change?

Updates the DevWorkspace backup documentation to accurately reflect the conditional registry authentication secret copying behavior introduced in devfile/devworkspace-operator#1618.

The key changes documented:

  • The DevWorkspace operator only copies registry auth secrets from the operator namespace to workspace namespaces when the authSecret field is configured in DevWorkspaceOperatorConfig
  • The operator never overwrites user-provided secrets in workspace namespaces - they always take precedence
  • When no authSecret is configured, the backup job assumes anonymous registry access (for public registries)
  • Clarified that authSecret specifies the secret name in the operator installation namespace, not the workspace namespace
  • The secret copied to workspace namespaces always uses the canonical name devworkspace-backup-registry-auth

Articles updated:

  • modules/administration-guide/pages/devworkspace-backup-regular-oci-registry.adoc - Replaced the WARNING section with a comprehensive IMPORTANT section explaining the conditional copying logic, updated command examples to include namespace specification
  • modules/administration-guide/pages/devworkspace-backup.adoc - Clarified the registry.authSecret field description to explain conditional copying

What issues does this pull request fix or reference?

Specify the version of the product this pull request applies to

next

Pull Request checklist

The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.

  • Any procedure:
    • Successfully tested.
  • Any page or link rename:
    • The page contains a redirection for the previous URL.
    • Propagate the URL change in:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

…orkspace backups

Update documentation to reflect the new conditional secret copying behavior
introduced in devfile/devworkspace-operator#1618:

- The operator only copies registry auth secrets when authSecret is configured
- User-provided secrets in workspace namespaces are never overwritten
- When no authSecret is configured, anonymous registry access is assumed
- Clarify that authSecret specifies the secret name in the operator namespace
- The secret copied to workspace namespaces always uses the canonical name

Updated articles:
- modules/administration-guide/pages/devworkspace-backup-regular-oci-registry.adoc
- modules/administration-guide/pages/devworkspace-backup.adoc

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@tolusha tolusha requested a review from nickboldt May 11, 2026 08:36
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 11, 2026

🎊 Navigate the preview: 🎊

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 11, 2026

Click here to review and test in web IDE: Contribute

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants