docs: document migration, installerChecker, and namespaceDestroyAll jobs - #1307
docs: document migration, installerChecker, and namespaceDestroyAll jobs#1307rberrelleza wants to merge 5 commits into
Conversation
Add an admin-focused reference and troubleshooting page for the three Kubernetes jobs Okteto runs in the okteto namespace, plus Helm config value sections for each so priorityClassName and related settings have a documented home. - New page self-hosted/manage/okteto-jobs.mdx: what each job is, when it runs, the resources it acts on, and how to inspect it (component label selectors, kubectl commands, logs). - helm-configuration.mdx: add installerChecker, migration, and namespaceDestroyAll sections under Okteto Components. - troubleshooting.mdx: cross-link the installerChecker from the "progressing forever" section. - sidebars.js: add the new page to Operating Okteto. Closes #513 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Ramiro Berrelleza <ramiro@okteto.com>
✅ Deploy Preview for okteto-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Remove the new okteto-jobs.mdx page and its sidebar entry from this PR; they now live in a dedicated PR (#1310). This PR keeps the helm-configuration.mdx config sections and the troubleshooting.mdx cross-link, which reference that page. Merge #1310 first. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Drop the "See Okteto Jobs" cross-links from the installerChecker, migration, and namespaceDestroyAll config sections, and point the troubleshooting installerChecker link at its Helm configuration section instead. This PR is now self-contained and no longer depends on the separate Okteto Jobs page PR. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ifbyol
left a comment
ifbyol
left a comment
There was a problem hiding this comment.
Approving it, but it is important to add a note in the migration section, or not documented enabled property
| schedule: "*/5 * * * *" | ||
| ``` | ||
|
|
||
| ### migration |
There was a problem hiding this comment.
I have doubts about documenting this. I'm in the fence. At least, if we document it, we have to be clear that the migration is important, and I would even say mandatory for Okteto, so it shouldn't be disabled. The setting to disable is there for historical reasons, but nobody should change it. The rest of properties are fine to be documented. They might be important in some scenarios
There was a problem hiding this comment.
Nacho and I discussed separately - Removing for now would be the safer option and we'll look to delete this flag in the chart
There was a problem hiding this comment.
@codyjlandstrom can we remove the “enable” keywords in that case but leave all the other configuration?
3 participants
Closes #513
Documents the three Kubernetes jobs Okteto runs in the
oktetonamespace (migration,installerChecker,namespaceDestroyAll) in the Helm configuration reference.What changed
helm-configuration.mdx: addsinstallerChecker,migration, andnamespaceDestroyAllconfig sections under Okteto Components, givingpriorityClassNameand the other values a documented home (the gap raised in the Document priorityClassName #511 review). Each section describes the job and its configurable values.troubleshooting.mdx: notes that theinstallerCheckerCronJob clears pipelines stuck in "progressing", linking to its Helm configuration section.Self-contained; no dependency on other PRs.
🤖 Generated with Claude Code