Skip to content

docs: Document mount-on-start annotation to prevent workspace restarts - #3076

Merged
tolusha merged 4 commits into
mainfrom
docs/mount-on-start-annotation
May 5, 2026
Merged

tolusha merged 4 commits into
mainfrom
docs/mount-on-start-annotation

Conversation

@tolusha

@tolusha tolusha commented Apr 24, 2026

Copy link
Copy Markdown
Contributor

What does this pull request change?

This PR updates three existing articles to document the new controller.devfile.io/mount-on-start annotation introduced in devworkspace-operator PR #1533. This annotation prevents automatic workspace restarts when mounting ConfigMaps, Secrets, and PersistentVolumeClaims.

Updated articles:

  1. modules/administration-guide/pages/configuring-a-user-namespace.adoc

    • Updated the warning to explain the mount-on-start annotation
    • Added mount-on-start annotation documentation for ConfigMaps
    • Added mount-on-start annotation documentation for Secrets
    • Added mount-on-start annotation documentation for PVCs
  2. modules/end-user-guide/pages/mounting-configmaps.adoc

    • Updated the warning to explain the mount-on-start annotation
    • Added mount-on-start to the optional annotations table
  3. modules/end-user-guide/pages/mounting-secrets.adoc

    • Updated the warning to explain the mount-on-start annotation
    • Added mount-on-start to the optional annotations table

Changes made:

  • Updated warnings in all three articles to indicate that the mount-on-start: 'true' annotation prevents workspace restarts
  • Added detailed explanations of how the annotation works
  • Added the annotation to optional annotations tables where applicable

This addresses the user experience issue where global configuration changes cause unexpected workspace restarts.

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.

Document the new controller.devfile.io/mount-on-start annotation
that prevents automatic workspace restarts when mounting resources
(ConfigMaps, Secrets, and PVCs).

Updated articles:
- configuring-a-user-namespace.adoc: Added mount-on-start annotation
  for ConfigMaps, Secrets, and PVCs
- mounting-configmaps.adoc: Added mount-on-start to optional annotations
  table and updated warning
- mounting-secrets.adoc: Added mount-on-start to optional annotations
  table and updated warning

This addresses the issue where applying or modifying global configurations
causes all running workspaces to immediately restart without warning.

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

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@tolusha
tolusha requested a review from amisevsk April 24, 2026 11:16
@github-actions

github-actions Bot commented Apr 24, 2026 •

Copy link
Copy Markdown

🎊 Navigate the preview: https://69f851fb6e74e0d1d7bda58e--eclipse-che-docs-pr.netlify.app 🎊

@github-actions

github-actions Bot commented Apr 24, 2026 •

Copy link
Copy Markdown

Click here to review and test in web IDE: Contribute

@gtrivedi88 gtrivedi88 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.

Added some suggestions. Please review and let me know if you have questions.

tolusha and others added 3 commits April 30, 2026 10:48
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Anatolii Bazko <abazko@redhat.com>
Signed-off-by: Anatolii Bazko <abazko@redhat.com>

@ibuziuk ibuziuk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@gtrivedi88 please, review if all good from your perspective

@tolusha
tolusha merged commit 393b98a into main May 5, 2026
11 checks passed
@tolusha
tolusha deleted the docs/mount-on-start-annotation branch May 5, 2026 12:45
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.

4 participants