Skip to main content

Object Storage Helm Values

Overview

This page is the authoritative reference for every Helm value under the objectStorage.* namespace in the helm_aio chart. Operators wiring the bundled helm_aio release through values files, GitOps, or --set flags should refer to this page for the canonical schema and defaults.

For task-oriented guides built on top of these values, refer to:

Top-level keys

KeyTypeDefaultPurpose
objectStorage.activeProviderstringautoExplicit override for the alias target. Set to a provider name (rustfs, minio, ...) to pin the alias regardless of the resolution rules. Defaults to auto.
objectStorage.previousProviderstringminioNames the data-bearing side when two providers are enabled and activeProvider=auto. Read as the legacy default for installs that predated the registry.
objectStorage.cutoverAcknowledgedboolfalseWhen true, the alias flips from previousProvider to the other enabled provider. The legacy rustfs.migrationAcknowledged is honored as a synonym.
objectStorage.service.enabledbooltrueWhen false, the ilum-objectstorage Service alias is not rendered, even if a provider is enabled. Useful for BYO external S3 deployments.
objectStorage.endpointstringhttp://ilum-objectstorage:9000S3 API endpoint that bundled consumers target. Defaults to the in-cluster alias hostname. Override to point at an external provider.
objectStorage.regionstringus-east-1S3 region passed to AWS SDK and Hadoop S3A clients.
objectStorage.pathStylebooltruePath-style addressing toggle. true matches bundled providers; set to false for AWS S3 virtual-hosted-style addressing.
objectStorage.defaultBucketslist[string][ilum-files, ilum-data, ilum-tables, ilum-mlflow, ilum-kestra, ilum-ducklake, ilum-langfuse]Default bucket list created by the bundled init Jobs and referenced by the migration Job.

Provider registry

The objectStorage.providers map declares each provider known to the chart. Adding a new entry registers the provider; no chart-template change is required. See Add a New Provider.

KeyTypeDefaultPurpose
objectStorage.providers.<name>.enabledbool(unset for bundled; required for new providers)Operator-set enable flag. Bundled providers (rustfs, minio) defer to their chart-level flags (.Values.rustfs.enabled, .Values.minio.enabled). New providers without a chart-level flag set this directly.
objectStorage.providers.<name>.consolePathstringprovider-specificiframe path the Ilum UI renders for this provider's console. Bundled defaults: /rustfs/console/ for RustFS, /external/minio/ for MinIO.
objectStorage.providers.<name>.consoleModestring (same-origin or nginx-rewrite)provider-specificRouting mode the Ilum UI's nginx proxy applies for this provider. same-origin for consoles with a configurable base path (RustFS); nginx-rewrite for consoles pinned to an absolute URL (MinIO).

Bundled provider defaults

objectStorage:
providers:
rustfs:
consolePath: /rustfs/console/
consoleMode: same-origin
minio:
consolePath: /external/minio/
consoleMode: nginx-rewrite

Credentials

The shared Secret ilum-objectstorage-credentials carries the S3 root credentials consumed by every bundled component. See Rotate Object Storage Credentials for the rotation procedure.

KeyTypeDefaultPurpose
objectStorage.credentials.createbooltrueWhether helm_aio should create the Secret on helm install. Disable when the operator manages the Secret externally.
objectStorage.credentials.namestringilum-objectstorage-credentialsName of the Secret. Bundled consumers read from this name; do not change without overriding every consumer chart.
objectStorage.credentials.accessKeystringadminInitial access key. The Secret's lookup clause preserves the live value on helm upgrade, so this default applies only to net-new installs.
objectStorage.credentials.secretKeystringadmin12345Initial secret key. Same lookup preservation as accessKey. Must be at least 8 characters for the bundled mc-based init Pod to authenticate.
objectStorage.credentials.existingSecretstring(unset)Reference an externally-managed Secret instead of having helm_aio create one.
objectStorage.credentials.preserveExistingbooltrueWhen true, the chart's lookup clause reads the live Secret on helm upgrade and preserves its values. Set to false for deterministic helm template output in GitOps pipelines.

Secret key aliases

The ilum-objectstorage-credentials Secret exposes the credential pair under six aliased keys so each consumer can reference it under its native naming convention:

KeyUsed by
access-keybundled consumers using the generic name
secret-keybundled consumers using the generic name
root-userthe bundled MinIO chart
root-passwordthe bundled MinIO chart
RUSTFS_ACCESS_KEYthe bundled RustFS chart
RUSTFS_SECRET_KEYthe bundled RustFS chart

Legacy back-compat shims

The following keys remain accepted in 6.7.2 and later for back-compat with values overlays written against earlier releases. They are deprecated in favour of the new names listed in the table above and will be removed in a future major release.

Legacy keyNew equivalentNotes
rustfs.migrationAcknowledgedobjectStorage.cutoverAcknowledgedEither flag triggers the cutover; both accepted simultaneously.
rustfs.enabledobjectStorage.providers.rustfs.enabledThe chart-level flag remains the single source of truth for the RustFS sub-chart's render condition. The registry entry honors it.
minio.enabledobjectStorage.providers.minio.enabledSame back-compat shape as rustfs.enabled.
MINIO_READ (backend permission)OBJECT_STORAGE_READThe backend continues to accept the legacy permission name and the rolesToMinio / groupsToMinio / minioMinAccessRole Hydra mappings. A one-time deprecation warning is logged on startup when the legacy form is supplied.

Reference

  • Chart source: helm/helm_aio/values.yaml in the Ilum monorepo
  • Helpers reference: helm/helm_aio/templates/_helpers.tpl (defines ilum-aio.activeObjectStorageProvider, ilum-aio.objectStorageConsolePath, ilum-aio.objectStorageConsoleMode)
  • Upgrade notes: helm/UPGRADE_NOTES.md in the Ilum monorepo
  • Task-oriented guides: Object Storage section in User Guides