Skip to content

procedures: Document mount-on-start annotation to prevent workspace restarts#3074

Closed
tolusha wants to merge 1 commit intomainfrom
docs-mount-on-start-annotation
Closed

procedures: Document mount-on-start annotation to prevent workspace restarts#3074
tolusha wants to merge 1 commit intomainfrom
docs-mount-on-start-annotation

Conversation

@tolusha
Copy link
Copy Markdown
Contributor

@tolusha tolusha commented Apr 24, 2026

What does this pull request change?

This PR updates existing documentation to explain the new controller.devfile.io/mount-on-start annotation introduced in devfile/devworkspace-operator#1533. This annotation allows administrators and users to mount ConfigMaps, Secrets, and PVCs to workspaces without triggering unwanted workspace restarts.

Articles updated:

  • mounting-configmaps.adoc - Added documentation for the mount-on-start annotation with usage examples
  • mounting-secrets.adoc - Added mount-on-start annotation documentation including special handling for git credential Secrets
  • configuring-a-user-namespace.adoc - Updated administrator guidance for preventing workspace restarts when applying global configurations

Key changes:

  • Updated warnings to mention the mount-on-start annotation as a solution
  • Added new procedure steps explaining how to use the annotation
  • Documented special collective behavior for git credential Secrets and TLS ConfigMaps
  • Added code examples showing proper annotation usage

What issues does this pull request fix or reference?

Source PR: devfile/devworkspace-operator#1533
Related issue: eclipse-che/che#23553

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.

🤖 Generated with Claude Code

…estarts

This update documents the new controller.devfile.io/mount-on-start annotation
that allows administrators and users to mount ConfigMaps, Secrets, and PVCs
to workspaces without triggering unwanted workspace restarts.

Changes:
- Updated mounting-configmaps.adoc to document mount-on-start annotation
- Updated mounting-secrets.adoc with mount-on-start usage and git credential notes
- Updated configuring-a-user-namespace.adoc for administrators

Related to: devfile/devworkspace-operator#1533

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@tolusha tolusha requested a review from ibuziuk April 24, 2026 10:33
@github-actions
Copy link
Copy Markdown

⚡️ Deploying pull request preview...

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 24, 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.

1 participant