Files
cozystack/packages/apps/vm-disk/templates
Aleksei Sviridkin ea4968cf46 fix(apps): keep Job and CronJob names within the Kubernetes limits (#4945)
## What this PR does

The apps API admits release names of up to 53 characters, the release
prefix included (less for Kafka and Kubernetes, which cap their own
names). Kubernetes copies a Job name into the `job-name` label of its
pods, and a label value takes at most 63 characters, so the apiserver
refuses a Job with a longer name. A CronJob name is refused over 52
characters, because the controller names each Job it starts
`<cronjob>-<timestamp>`. I rendered every Job and CronJob in
`packages/apps` and `packages/extra` with the longest release name each
application admits, and eight of them go over.

| Application | Object | Name | Longest on main | After |
| --- | --- | --- | --- | --- |
| bucket | post-delete Job | `<release>-cleanup-acme` | 66 | 63 |
| qdrant | post-delete Job | `<release>-qdrant-cleanup` | 68 | 63 |
| kafka | pre-install and pre-upgrade Job | `<release>-kafka-migration`
| 66 (release capped at 50) | 63 |
| vm-disk | resize Job, rendered when the disk grows |
`<release>-volume-resize-hook` | 72 | 63 |
| vm-instance | update Job and the `app` label of its pod |
`<release>-update-hook` | 65 | 63 |
| mariadb | backup CronJob | `<release>-backup` | 60 | 52 |
| clickhouse | legacy backup CronJob | `<release>-backup` | 60 | 52 |
| tenant | pre-delete Job in `cozy-system` | `<tenant
namespace>-cleanup` | 71 (nested namespace of 63) | 63 |

Counted in characters of the application name, a Kafka of 42 to 44
cannot be installed today, a VMDisk of 37 or more cannot grow, and a
VMInstance of 40 or 41 cannot take an instance type, profile or external
change. Deleting a Bucket of 44 or more or a Qdrant of 42 or more fails
in the post-delete hook. With the backup CronJob enabled, a MariaDB of
38 or more and a ClickHouse of 35 or more fail the whole release. A
nested tenant whose namespace is longer than 55 characters cannot be
deleted.

The Jobs of bucket, qdrant, kafka, vm-disk and vm-instance are now named
`printf "%s-<suffix>" .Release.Name | trunc 63 | trimSuffix "-"`, and
vm-instance uses the same value for the pod label. A release name is
never longer than 53, so only the fixed suffix is cut, and a brute-force
check over every pair of release name lengths found no two release names
that render the same Job name.

A plain cut to 52 would reach into the release name of a CronJob, and
two 53-character names that differ in the last character would share
one. So a CronJob name that does not fit becomes the release name cut to
38 characters, the first six hex characters of its sha256 and `-backup`,
the shape #4133 gave the ClickHouse Keeper name. The tenant cleanup Job
takes the same form with the namespace cut to 48, because it runs in
`cozy-system` next to the cleanup Job of every other tenant. There a
plain cut gives a parent and a child named `clea` the same name, and the
child's `before-hook-creation` would delete the parent's Job while it
runs.

Names that fit render exactly as before. The hook documents rendered
from main and from this branch with the short release names the tests
use are identical in all eight charts. A name that did not fit never
produced an object, so nothing is renamed on upgrade. The
ServiceAccounts, Roles and RoleBindings of these hooks keep their names,
since they have no such limit, so the ones a pre-install hook left
behind are replaced rather than orphaned. Helm runs the delete hooks
stored with a release, so an existing Bucket, Qdrant or tenant picks up
the fix with its next upgrade.

Every other Job and CronJob fits at the longest name. The cleanup Jobs
of clickhouse, harbor, mariadb and opensearch and the Kafka pre-delete
Job reach 61, the Postgres init Job 62, and the Kubernetes and
KubernetesNodes Jobs either stay under 63 or already cut their names.
The etcd and monitoring modules require their chart name as the release
name, and the gateway and seaweedfs cleanup Jobs reach 61.

Each of the eight charts gets a new helm-unittest suite. It pins a short
name, a name that lands exactly on the limit and the longest admitted
name, a cut that would end in a dash wherever one can happen, and for
the hooks the unchanged ServiceAccount and RBAC names. The CronJob
suites also pin two 53-character names that differ in the last
character, and the tenant suite pins the parent and child pair. Against
the templates on main, 18 of the 41 new cases fail, every one with a
name over the limit. With the hash forms replaced by a plain cut, the
tenant parent and child both render
`tenant-abcdefghijklmnopqrstuvwxyz-0123456789abcdefghijklmn-clea` and
the two MariaDB names both render
`mariadb-abcdefghijklmnopqrstuvwxyz0123456789abcdefgh`.
`hack/helm-unit-tests.sh` passes over all 106 packages with tests. The
Bats files that exercise these hooks and charts
(`app-cleanup-hooks_test`, `kafka-migration-hook`,
`kafka-pre-delete-hook`, `tenant-pre-delete-hook`,
`check-hook-request-timeout`, `pod-label-census_test`,
`mariadb-first-boot-waits`, `check-render-matrix`) give 96 ok on main
and on this branch. `make generate` with cozyvalues-gen v1.7.0 in the
eight packages changes nothing. A local kube-apiserver v1.35.0 refuses
the longest name each chart renders on main, with `must be no more than
63 bytes` on the job-name label or `must be no more than 52 characters`
on the CronJob, and creates the name from this branch. For vm-disk and
vm-instance, whose hooks render only after a live lookup, that check
used a Job with the same name and labels.

This is related to #4875 but does not depend on it. #4875 adds a
cozy-lib cleanup Job and cuts its name to 63 the same way, while this PR
covers the Jobs already on main. Neither needs the other, and the two
merge cleanly.

### Screenshots

Not a UI change.

### Downstream repositories

Templates and tests only. No values, schema, README, defaults,
`ApplicationDefinition`, Secret or Service name changes, and none of the
changed Job or CronJob names appears in the website, the Terraform
provider, the Ansible collection or the other repositories on the list.

- [x] No downstream repository is affected by this change
- [ ] [cozystack/website](https://github.com/cozystack/website) -
follow-up:
- [ ]
[cozystack/terraform-provider-cozystack](https://github.com/cozystack/terraform-provider-cozystack)
- follow-up:
- [ ]
[cozystack/ansible-cozystack](https://github.com/cozystack/ansible-cozystack)
- follow-up:
- [ ] [cozystack/ccp](https://github.com/cozystack/ccp) - follow-up:
- [ ] [cozystack/talm](https://github.com/cozystack/talm) - follow-up:
- [ ] [cozystack/cozyhr](https://github.com/cozystack/cozyhr) -
follow-up:
- [ ] [cozystack/cozy-proxy](https://github.com/cozystack/cozy-proxy) -
follow-up:
- [ ]
[cozystack/cozystack-telemetry-server](https://github.com/cozystack/cozystack-telemetry-server)
- follow-up:
- [ ]
[cozystack/external-apps-example](https://github.com/cozystack/external-apps-example)
- follow-up:
- [ ] [cozystack/examples](https://github.com/cozystack/examples) -
follow-up:
- [ ] [cozystack/community](https://github.com/cozystack/community) -
follow-up:

### Release note

```release-note
fix(apps): Job and CronJob names now fit the Kubernetes limits for the longest application names. A Kafka with a name of 42 to 44 characters can now be installed, long VMDisk and VMInstance names no longer fail a resize or an instance type change, long Bucket and Qdrant names and long nested tenant namespaces no longer fail deletion, and long MariaDB and ClickHouse names no longer fail the release with the backup CronJob enabled.
```


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Bug Fixes**
* Cleanup, migration, resize, and update Jobs now use names that fit
Kubernetes naming limits, including for long release or tenant names.
* ClickHouse and MariaDB backup CronJobs now use names within
Kubernetes’ length limit. Longer names are shortened with a hash suffix
to help distinguish them.
* Short names and names at the supported limit retain their existing
naming format.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-11-13 18:18:40 +03:00
..