Package v2 - This page provides a quick automatically generated reference for the MinIO Operator minio.min.io/v2
CRD.
For more complete documentation on the MinIO Operator CRD, see MinIO Kubernetes Documentation.
The minio.min.io/v2
API was released with the v4.0.0 MinIO Operator.
The MinIO Operator automatically converts existing tenants using the /v1
API to /v2
.
AuditConfig defines configuration parameters for Audit (type) logs
Field | Description |
---|---|
|
Required |
Bucket describes the default created buckets
Field | Description |
---|---|
|
|
|
|
|
CertificateConfig (certConfig
) defines controlling attributes associated to any TLS certificate automatically generated by the Operator as part of tenant creation.
These fields have no effect if spec.autoCert: false
.
Field | Description |
---|---|
|
Optional |
|
Optional |
|
Optional |
CertificateStatus keeps track of all the certificates managed by the operator
Field | Description |
---|---|
|
AutoCertEnabled registers whether we know if the tenant has autocert enabled |
ExposeServices (exposeServices
) defines the exposure of the MinIO object storage and Console services.
Field | Description |
---|---|
|
Optional |
|
Optional |
Features (features
) - Object describing which MinIO features to enable/disable in the MinIO Tenant.
Field | Description |
---|---|
|
Optional |
|
Optional |
HealthStatus represents whether the tenant is healthy, with decreased service or offline
KESConfig (kes
) defines the configuration of the MinIO Key Encryption Service (KES) StatefulSet deployed as part of the MinIO Tenant. KES supports Server-Side Encryption of objects using an external Key Management Service (KMS).
Field | Description |
---|---|
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Required |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Specify the Security Context of MinIO KES pods. The Operator supports only the following pod security fields: |
LocalCertificateReference (externalCertSecret
, externalCaCertSecret
,clientCertSecret
) contains a Kubernetes secret containing TLS certificates or Certificate Authority files for use with enabling TLS in the MinIO Tenant.
Field | Description |
---|---|
|
Required |
|
Required |
LogConfig (log
) defines the configuration of the MinIO Log Search API deployed as part of the MinIO Tenant. The Operator deploys a PostgreSQL instance as part of the tenant to support storing and querying MinIO logs.
If the tenant specification includes the console
object, the Operator automatically configures and enables MinIO Log Search via the Console UI.
Field | Description |
---|---|
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Required |
|
Optional |
|
Optional |
LogDbConfig (db
) defines the configuration of the PostgreSQL StatefulSet deployed to support the MinIO LogSearch API.
Field | Description |
---|---|
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
Logging describes Logging for MinIO tenants.
Field | Description |
---|---|
|
|
|
|
|
Pool (pools
) defines a MinIO server pool on a Tenant. Each pool consists of a set of MinIO server pods which "pool" their storage resources for supporting object storage and retrieval requests. Each server pool is independent of all others and supports horizontal scaling of available storage resources in the MinIO Tenant.
See the MinIO Operator CRD reference for the pools
object for examples and more complete documentation.
Field | Description |
---|---|
|
Optional |
|
Required
The number of MinIO server pods to deploy in the pool. The minimum value is |
|
Required |
|
Required |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
PoolStatus keeps track of all the pools and their current state
Field | Description |
---|---|
|
|
|
|
|
LegacySecurityContext stands for Legacy SecurityContext. It represents that these pool was created before v4.2.3 when we introduced the default securityContext as non-root, thus we should keep running this Pool without a Security Context |
PrometheusConfig (prometheus
) defines the configuration of a Prometheus instance as part of the MinIO tenant. The Operator automatically configures the Prometheus instance to scrape and store metrics from the MinIO tenant.
The Operator deploys each Prometheus pod using the prometheus/prometheus:latest Docker image.
Field | Description |
---|---|
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
S3Features (s3
) - Object describing which MinIO features to enable/disable in the MinIO Tenant. + Deprecated in Operator v4.3.2
Field | Description |
---|---|
|
Optional |
ServiceMetadata (serviceMetadata
) defines custom labels and annotations for the MinIO Object Storage service and/or MinIO Console service.
Field | Description |
---|---|
|
Optional |
|
Optional |
|
Optional |
|
Optional |
SideCars (sidecars
) defines a list of containers that the Operator attaches to each MinIO server pods in the pool
.
Field | Description |
---|---|
|
Optional |
|
Optional |
|
Optional |
Tenant is a Kubernetes object describing a MinIO Tenant.
Field | Description |
---|---|
|
Refer to Kubernetes API documentation for fields of |
|
|
|
Required |
TenantDomains (domains
) - List of domains used to access the tenant from outside the kubernetes clusters. this will only configure MinIO for the domains listed, but external DNS configuration is still needed.
Field | Description |
---|---|
|
List of Domains used by MinIO. This will enable DNS style access to the object store where the bucket name is inferred from a subdomain in the domain. |
TenantScheduler (scheduler
) - Object describing Kubernetes Scheduler to use for deploying the MinIO Tenant.
Field | Description |
---|---|
|
Optional |
TenantSpec (spec
) defines the configuration of a MinIO Tenant object.
The following parameters are specific to the minio.min.io/v2
MinIO CRD API spec
definition added as part of the MinIO Operator v4.0.0.
For more complete documentation on this object, see the MinIO Kubernetes Documentation.
Field | Description |
---|---|
|
Required |
|
Optional |
|
Optional |
|
Optional |
|
Required |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Liveness Probe for container liveness. Container will be restarted if the probe fails. |
|
Readiness Probe for container readiness. Container will be removed from service endpoints if the probe fails. |
|
Optional + Deprecated in Operator v4.3.2 |
|
S3 related features can be disabled or enabled such as |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
|
Optional |
TenantUsage are metrics regarding the usage and capacity of the tenant
Field | Description |
---|---|
|
Capacity the usage capacity of this tenant in bytes. |
|
Capacity the raw capacity of this tenant in bytes. |
|
Usage is how much data is managed by MinIO in bytes. |
|
Usage is the raw usage on disks in bytes. |