Skip to content

docs: document migration, installerChecker, and namespaceDestroyAll jobs #1307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rberrelleza wants to merge 5 commits into
base: main
Choose a base branch
from
+33 −0
Open

docs: document migration, installerChecker, and namespaceDestroyAll jobs #1307

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
44ae069
docs: document migration, installerChecker, and namespaceDestroyAll jobs
rberrelleza Jul 21, 2026
2f7fdd1
docs(#513): move Okteto Jobs page to its own PR
rberrelleza Jul 22, 2026
33ca876
docs(#513): remove Okteto Jobs page references from this PR
rberrelleza Jul 22, 2026
a3a53b0
remove the migration section
codyjlandstrom Aug 6, 2026
90a29c1
Merge branch 'main' into docs/513-okteto-jobs-admin-docs
codyjlandstrom Aug 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions src/content/self-hosted/helm-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -536,6 +536,56 @@ The jobs that deploy your [development environments from Git](development/deploy
`}
</CodeBlock>

### installerChecker

The CronJob that reconciles Development Environment deploys and destroys stuck in a running state.

- `enabled`: Whether to run the installer checker. Defaults to `true`.
- `schedule`: The cron schedule for the checker. Defaults to `*/5 * * * *` (every 5 minutes).
- `priorityClassName`: The priority class for the installer checker pods. The PriorityClass must already exist in your cluster before using this setting. This value has precedence over `globals.priorityClassName` if both are set. If this value is not set, the pods will inherit the priority class defined by the value set in `globals.priorityClassName`.

```yaml
installerChecker:
enabled: true
schedule: "*/5 * * * *"
```

### migration

@ifbyol ifbyol Aug 6, 2026

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.

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

@codyjlandstrom codyjlandstrom Aug 6, 2026

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.

Nacho and I discussed separately - Removing for now would be the safer option and we'll look to delete this flag in the chart

@rberrelleza rberrelleza Aug 6, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@codyjlandstrom can we remove the “enable” keywords in that case but leave all the other configuration?


The Helm hook Job that applies the data and resource migrations required by the Okteto version you are installing. It runs on every install and upgrade.

- `enabled`: Whether to run the migration job. Defaults to `true`.
- `annotations`: Annotations to add to the migration job pods.
- `labels`: Labels to add to the migration job pods.
- `resources`: The resources for the migration job pods.
- `priorityClassName`: The priority class for the migration job pods. The PriorityClass must already exist in your cluster before using this setting. This value has precedence over `globals.priorityClassName` if both are set. If this value is not set, the pods will inherit the priority class defined by the value set in `globals.priorityClassName`.

```yaml
migration:
enabled: true
resources:
requests:
cpu: 10m
memory: 100Mi
```

### namespaceDestroyAll

The Job that destroys every resource in a Namespace, plus the CronJob that recovers Namespaces whose destroy-all Job did not finish.

- `priorityClassName`: The priority class for the per-Namespace destroy-all job pods. The PriorityClass must already exist in your cluster before using this setting. This value has precedence over `globals.priorityClassName` if both are set. If this value is not set, the pods will inherit the priority class defined by the value set in `globals.priorityClassName`.
- `checker`: Configures the CronJob that recovers stuck Namespaces.
- `schedule`: The cron schedule for the checker. Defaults to `*/3 * * * *` (every 3 minutes).
- `timeoutInSeconds`: Maximum duration of each checker run in seconds. Defaults to `120`.
- `priorityClassName`: The priority class for the checker pods, following the same precedence rules as above.

```yaml
namespaceDestroyAll:
checker:
schedule: "*/3 * * * *"
timeoutInSeconds: 120
```

### oktetoAI

The Okteto AI section configures the [Okteto AI](okteto-ai/index.mdx) feature in your cluster:
Expand Down
2 changes: 2 additions & 0 deletions src/content/self-hosted/manage/troubleshooting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,6 +478,8 @@ kubectl get jobs -l=dev.okteto.com/pipeline-name=movies -l=dev.okteto.com/pipeli
kubectl get pods -l=dev.okteto.com/pipeline-name=movies -l=dev.okteto.com/pipeline-namespace=cindy --namespace=okteto
```

The [`installerChecker`](self-hosted/helm-configuration.mdx#installerchecker) CronJob clears deploys that get stuck in this state. If a pipeline stays in `progressing`, check its recent runs for details.

## Using a Custom CNI

If you're using a custom CNI on your cluster then there may be some additional configuration needed for webhooks.
Expand Down