0 Fork 0

mirror of https://github.com/cozystack/cozystack.git synced 2026-11-03 18:47:04 +09:00

Files

T

Aleksei Sviridkin 5af5962edf feat(apps): mark stateful-app storageClass fields as immutable

Annotate storageClass as immutable across every stateful app whose
chart exposes one — clickhouse, foundationdb, harbor, http-cache,
kafka (Kafka + ZooKeeper), kubernetes (top-level only), mariadb,
mongodb, nats, openbao, opensearch, postgres, qdrant, rabbitmq,
redis, vm-disk. Without coverage across the catalogue the UI would
render storageClass read-only on some apps and editable on others —
a worse mental model than uniform behaviour.

The annotation lands at the schema layer (CEL XValidation rule
'self == oldSelf' on values.schema.json / types.go / embedded
openAPISchema in cozyrds/<app>.yaml). The cozystack aggregated
apiserver does not yet evaluate CEL on application-backed resources;
that is tracked at cozystack/cozystack#2657. The UI
(cozystack/cozystack-ui#6) consumes the marker today.

The PVC-pinning argument is identical for every chart: Kubernetes
fixes a PVC's storageClassName at creation time, so editing this
field on an existing resource never migrated data. The schema
annotation makes that contract explicit.

kubernetes.nodeGroups[name].storageClass is intentionally NOT
annotated: the field is optional and undefaulted, so a strict
'self == oldSelf' rule would block any future attempt to set it on
an existing node group. A richer ratcheting form is needed there —
see docs/storage-immutability.md.

A refactor in pkg/registry/apps/application/rest.go extracts the
inline schema-build path into buildSpecSchema so it can be
unit-tested. Three regression tests in rest_spec_schema_test.go pin
the contract that x-kubernetes-validations survives the
v1->internal->structural conversion (loaded from the actual MariaDB
ApplicationDefinition fixture on disk, not a hand-edited mock).

Each per-app README gains a one-line blockquote pointing to a new
docs/storage-immutability.md that explains the contract and which
consumers enforce it today.

Requires cozystack/cozyvalues-gen with @immutable support — bump the
pre-commit pin in .github/workflows/pre-commit.yml once the release
exists.

Assisted-By: Claude <noreply@anthropic.com>
Signed-off-by: Aleksei Sviridkin <f@lex.la>

2026-05-26 23:51:11 +03:00

1.7 KiB

Raw Permalink Blame History

Virtual Machine Disk

A Virtual Machine Disk

storageClass is annotated as immutable in the chart schema — see docs/storage-immutability.md for the contract and which consumers enforce it.

Parameters

Common parameters

Name	Description	Type	Value
`source`	The source image location used to create a disk.	`object`	`{}`
`source.image`	Use image by name from default collection.	`*object`	`null`
`source.image.name`	Name of the image to use.	`string`	`""`
`source.upload`	Upload local image.	`*object`	`null`
`source.http`	Download image from an HTTP source.	`*object`	`null`
`source.http.url`	URL to download the image.	`string`	`""`
`source.disk`	Clone an existing vm-disk.	`*object`	`null`
`source.disk.name`	Name of the vm-disk to clone.	`string`	`""`
`optical`	Defines if disk should be considered optical.	`bool`	`false`
`storage`	The size of the disk allocated for the virtual machine.	`quantity`	`5Gi`
`storageClass`	StorageClass used to store the data.	`string`	`replicated`

1.7 KiB Raw Permalink Blame History

Virtual Machine Disk

Parameters

Common parameters

1.7 KiB

Raw Permalink Blame History