Documentation
¶
Index ¶
- Constants
- Variables
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type AuditConfig
- type CertificateConfig
- type CertificateStatus
- type ConsoleConfiguration
- type ExposeServices
- type KESConfig
- type LocalCertificateReference
- type LogConfig
- type LogDbConfig
- type Pool
- type PoolState
- type PoolStatus
- type PrometheusConfig
- type S3Features
- type ServiceMetadata
- type SideCars
- type Tenant
- type TenantList
- type TenantScheduler
- type TenantSpec
- type TenantStatus
Constants ¶
const ( StatusInitialized = "Initialized" StatusReady = "Ready" )
const (
GroupName = "minio.min.io"
)
MinIO Operator group name.
const MinIOCRDResourceKind = "Tenant"
MinIOCRDResourceKind is the Kind of a Cluster.
const MinIOVolumeMountPath = "/export"
MinIOVolumeMountPath specifies the default mount path for MinIO volumes.
const Version = "v2"
Version specifies the API Version.
Variables ¶
var ( // SchemeBuilder collects the scheme builder functions for the MinIO // Operator API. SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) // AddToScheme applies the SchemeBuilder functions to a specified scheme. AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: Version}
SchemeGroupVersion is group version used to register these objects.
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource.
Types ¶
type AuditConfig ¶
type AuditConfig struct { // *Required* + // // Specify the amount of storage to request in Gigabytes (GB) for storing audit logs. // +optional DiskCapacityGB *int `json:"diskCapacityGB,omitempty"` }
AuditConfig defines configuration parameters for Audit (type) logs.
func (*AuditConfig) DeepCopy ¶
func (in *AuditConfig) DeepCopy() *AuditConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuditConfig.
func (*AuditConfig) DeepCopyInto ¶
func (in *AuditConfig) DeepCopyInto(out *AuditConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateConfig ¶
type CertificateConfig struct { // *Optional* + // // The `CommonName` or `CN` attribute to associate to automatically generated TLS certificates. + CommonName string `json:"commonName,omitempty"` // *Optional* + // // Specify one or more `OrganizationName` or `O` attributes to associate to automatically generated TLS certificates. + OrganizationName []string `json:"organizationName,omitempty"` // *Optional* + // // Specify one or more x.509 Subject Alternative Names (SAN) to associate to automatically generated TLS certificates. MinIO Server pods use SNI to determine which certificate to respond with based on the requested hostname. DNSNames []string `json:"dnsNames,omitempty"` }
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`.
func (*CertificateConfig) DeepCopy ¶
func (in *CertificateConfig) DeepCopy() *CertificateConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateConfig.
func (*CertificateConfig) DeepCopyInto ¶
func (in *CertificateConfig) DeepCopyInto(out *CertificateConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateStatus ¶
type CertificateStatus struct { // AutoCertEnabled registers whether we know if the tenant has autocert enabled // +nullable AutoCertEnabled *bool `json:"autoCertEnabled,omitempty"` }
CertificateStatus keeps track of all the certificates managed by the operator.
func (*CertificateStatus) DeepCopy ¶
func (in *CertificateStatus) DeepCopy() *CertificateStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateStatus.
func (*CertificateStatus) DeepCopyInto ¶
func (in *CertificateStatus) DeepCopyInto(out *CertificateStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConsoleConfiguration ¶
type ConsoleConfiguration struct { // *Optional* + // // Specify the number of replica Console pods to deploy in the tenant. Defaults to `2`. // +optional Replicas int32 `json:"replicas,omitempty"` // *Optional* + // // The Docker image to use for deploying the MinIO Console. Defaults to {console-image}.+ // +optional Image string `json:"image,omitempty"` // *Optional* + // // The pull policy for the MinIO Console Docker image. Specify one of the following: + // // * `Always` + // // * `Never` + // // * `IfNotPresent` (Default) + // // Refer to the Kubernetes documentation for details https://kubernetes.io/docs/concepts/containers/images#updating-images ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"` // *Required* + // // Specify a https://kubernetes.io/docs/concepts/configuration/secret/[Kubernetes opaque secret] which contains environment variables to use for setting up the MinIO Console service. + // // See the https://github.com/minio/operator/blob/master/examples/console-secret.yaml[MinIO Operator `console-secret.yaml`] for an example. ConsoleSecret *corev1.LocalObjectReference `json:"consoleSecret"` // *Optional* + // // The https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/[Kubernetes Service Account] to use for running MinIO Console pods created as part of the Tenant. + // +optional ServiceAccountName string `json:"serviceAccountName,omitempty"` // *Optional* + // // Specify one or more https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#envvar-v1-core[Environment Variables] for use by the MinIO Console. // +optional Env []corev1.EnvVar `json:"env,omitempty"` // *Optional* + // // Object specification for specifying CPU and memory https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource allocations] or limits in the MinIO tenant. + // +optional Resources corev1.ResourceRequirements `json:"resources,omitempty"` // *Optional* + // // Enables TLS with SNI support on each MinIO Console pod in the tenant. If `externalCertSecret` is omitted *and* `spec.requestAutoCert` is set to `false`, MinIO Console pods deploy *without* TLS enabled. + // // Specify a https://kubernetes.io/docs/concepts/configuration/secret/[Kubernetes TLS secret]. The MinIO Operator copies the specified certificate to every MinIO Console pod in the tenant. When the MinIO Console pod/service responds to a TLS connection request, it uses SNI to select the certificate with matching `subjectAlternativeName`. + // // Specify an object containing the following fields: + // // * - `name` - The name of the Kubernetes secret containing the TLS certificate. + // // * - `type` - Specify `kubernetes.io/tls` + // // See the https://docs.min.io/minio/k8s/reference/minio-operator-reference.html#transport-layer-encryption-tls[MinIO Operator CRD] reference for examples and more complete documentation on configuring TLS for MinIO Tenants. // +optional ExternalCertSecret *LocalCertificateReference `json:"externalCertSecret,omitempty"` // *Optional* + // // Allows MinIO Console pods to verify client TLS certificates signed by a Certificate Authority not in the pod's trust store. + // // Specify one or more https://kubernetes.io/docs/concepts/configuration/secret/[Kubernetes TLS secrets]. The MinIO Operator copies the specified CA files to every MinIO Console pod in the tenant. + // // Each element in the `externalCertSecret` array is an object containing the following fields: + // // * - `name` - The name of the Kubernetes secret containing the Certificate Authority files. + // // * - `type` - Specify `kubernetes.io/tls`. + // // See the https://docs.min.io/minio/k8s/reference/minio-operator-reference.html#transport-layer-encryption-tls[MinIO Operator CRD] reference for examples and more complete documentation on configuring TLS for MinIO Tenants. // +optional ExternalCaCertSecret []*LocalCertificateReference `json:"externalCaCertSecret,omitempty"` // *Optional* + // // If provided, use these annotations for Console Object Meta annotations // +optional Annotations map[string]string `json:"annotations,omitempty"` // *Optional* + // // If provided, use these labels for Console Object Meta labels // +optional Labels map[string]string `json:"labels,omitempty"` // *Optional* + // // The filter for the Operator to apply when selecting which nodes on which to deploy MinIO Console pods. The Operator only selects those nodes whose labels match the specified selector. + // // See the Kubernetes documentation on https://kubernetes.io/docs/concepts/configuration/assign-pod-node/[Assigning Pods to Nodes] for more information. // +optional NodeSelector map[string]string `json:"nodeSelector,omitempty"` // *Optional* + // // Specify one or more https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/[Kubernetes tolerations] to apply to MinIO Console pods. // +optional Tolerations []corev1.Toleration `json:"tolerations,omitempty"` // *Optional* + // // Specify the https://kubernetes.io/docs/tasks/configure-pod-container/security-context/[Security Context] of MinIO Console pods. The Operator supports only the following pod security fields: + // // * `fsGroup` + // // * `fsGroupChangePolicy` + // // * `runAsGroup` + // // * `runAsNonRoot` + // // * `runAsUser` + // // * `seLinuxOptions` + // +optional SecurityContext *corev1.PodSecurityContext `json:"securityContext,omitempty"` }
ConsoleConfiguration (`console`) defines configuration of the https://github.com/minio/console[MinIO Console] deployed as part of the MinIO Tenant. The Operator automatically configures the Console for connectivity to MinIO server pods in the tenant. +
For more complete documentation on this object, see the https://docs.min.io/minio/k8s/reference/minio-operator-reference.html#minio-operator-yaml-reference[MinIO Kubernetes Documentation].
func (*ConsoleConfiguration) DeepCopy ¶
func (in *ConsoleConfiguration) DeepCopy() *ConsoleConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleConfiguration.
func (*ConsoleConfiguration) DeepCopyInto ¶
func (in *ConsoleConfiguration) DeepCopyInto(out *ConsoleConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ConsoleConfiguration) EqualImage ¶
func (c ConsoleConfiguration) EqualImage(currentImage string) bool
EqualImage returns true if config image and current input image are same.
type ExposeServices ¶
type ExposeServices struct { // *Optional* + // // Directs the Operator to expose the MinIO service. Defaults to `true`. + // +optional MinIO bool `json:"minio,omitempty"` // *Optional* + // // Directs the Operator to expose the MinIO Console service. Defaults to `true`. + // +optional Console bool `json:"console,omitempty"` }
ExposeServices (`exposeServices`) defines the exposure of the MinIO object storage and Console services.
func (*ExposeServices) DeepCopy ¶
func (in *ExposeServices) DeepCopy() *ExposeServices
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExposeServices.
func (*ExposeServices) DeepCopyInto ¶
func (in *ExposeServices) DeepCopyInto(out *ExposeServices)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KESConfig ¶
type KESConfig struct { // *Optional* + // // Specify the number of replica KES pods to deploy in the tenant. Defaults to `2`. // +optional Replicas int32 `json:"replicas,omitempty"` // *Optional* + // // The Docker image to use for deploying MinIO KES. Defaults to {kes-image}. + // +optional Image string `json:"image,omitempty"` // *Optional* + // // The pull policy for the MinIO Console Docker image. Specify one of the following: + // // * `Always` + // // * `Never` + // // * `IfNotPresent` (Default) + // // Refer to the Kubernetes documentation for details https://kubernetes.io/docs/concepts/containers/images#updating-images ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"` // *Optional* + // // The https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/[Kubernetes Service Account] to use for running MinIO KES pods created as part of the Tenant. + // +optional ServiceAccountName string `json:"serviceAccountName,omitempty"` // *Required* + // // Specify a https://kubernetes.io/docs/concepts/configuration/secret/[Kubernetes opaque secret] which contains environment variables to use for setting up the MinIO KES service. + // // See the https://github.com/minio/operator/blob/master/examples/kes-secret.yaml[MinIO Operator `console-secret.yaml`] for an example. Configuration *corev1.LocalObjectReference `json:"kesSecret"` // *Optional* + // // Enables TLS with SNI support on each MinIO KES pod in the tenant. If `externalCertSecret` is omitted *and* `spec.requestAutoCert` is set to `false`, MinIO KES pods deploy *without* TLS enabled. + // // Specify a https://kubernetes.io/docs/concepts/configuration/secret/[Kubernetes TLS secret]. The MinIO Operator copies the specified certificate to every MinIO Console pod in the tenant. When the MinIO Console pod/service responds to a TLS connection request, it uses SNI to select the certificate with matching `subjectAlternativeName`. + // // Specify an object containing the following fields: + // // * - `name` - The name of the Kubernetes secret containing the TLS certificate. + // // * - `type` - Specify `kubernetes.io/tls` + // // See the https://docs.min.io/minio/k8s/reference/minio-operator-reference.html#transport-layer-encryption-tls[MinIO Operator CRD] reference for examples and more complete documentation on configuring TLS for MinIO Tenants. // +optional ExternalCertSecret *LocalCertificateReference `json:"externalCertSecret,omitempty"` // *Optional* + // // Specify a a https://kubernetes.io/docs/concepts/configuration/secret/[Kubernetes TLS secret] containing a custom root Certificate Authority and x.509 certificate to use for performing mTLS authentication with an external Key Management Service, such as Hashicorp Vault. + // // Specify an object containing the following fields: + // // * - `name` - The name of the Kubernetes secret containing the Certificate Authority and x.509 Certificate. + // // * - `type` - Specify `kubernetes.io/tls` + // +optional ClientCertSecret *LocalCertificateReference `json:"clientCertSecret,omitempty"` // *Optional* + // // If provided, use these annotations for KES Object Meta annotations // +optional Annotations map[string]string `json:"annotations,omitempty"` // *Optional* + // // If provided, use these labels for KES Object Meta labels // +optional Labels map[string]string `json:"labels,omitempty"` // *Optional* + // // The filter for the Operator to apply when selecting which nodes on which to deploy MinIO KES pods. The Operator only selects those nodes whose labels match the specified selector. + // // See the Kubernetes documentation on https://kubernetes.io/docs/concepts/configuration/assign-pod-node/[Assigning Pods to Nodes] for more information. // +optional NodeSelector map[string]string `json:"nodeSelector,omitempty"` // *Optional* + // // Specify one or more https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/[Kubernetes tolerations] to apply to MinIO KES pods. // +optional Tolerations []corev1.Toleration `json:"tolerations,omitempty"` // *Optional* + // // If provided, use this as the name of the key that KES creates on the KMS backend // +optional KeyName string `json:"keyName,omitempty"` // Specify the https://kubernetes.io/docs/tasks/configure-pod-container/security-context/[Security Context] of MinIO KES pods. The Operator supports only the following pod security fields: + // // * `fsGroup` + // // * `fsGroupChangePolicy` + // // * `runAsGroup` + // // * `runAsNonRoot` + // // * `runAsUser` + // // * `seLinuxOptions` + // +optional SecurityContext *corev1.PodSecurityContext `json:"securityContext,omitempty"` }
KESConfig (`kes`) defines the configuration of the https://github.com/minio/kes[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).
func (*KESConfig) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KESConfig.
func (*KESConfig) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LocalCertificateReference ¶
type LocalCertificateReference struct { // *Required* + // // The name of the Kubernetes secret containing the TLS certificate or Certificate Authority file. + Name string `json:"name"` // *Required* + // // The type of Kubernetes secret. Specify `kubernetes.io/tls` + Type string `json:"type,omitempty"` }
LocalCertificateReference (`externalCertSecret`, `externalCaCertSecret`,`clientCertSecret`) contains a Kubernetes secret containing TLS certificates or Certificate Authority files for use with enabling TLS in the MinIO Tenant.
func (*LocalCertificateReference) DeepCopy ¶
func (in *LocalCertificateReference) DeepCopy() *LocalCertificateReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LocalCertificateReference.
func (*LocalCertificateReference) DeepCopyInto ¶
func (in *LocalCertificateReference) DeepCopyInto(out *LocalCertificateReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LogConfig ¶
type LogConfig struct { // *Optional* + // // The Docker image to use for deploying the MinIO Log Search API. Defaults to {logsearch-image}. + // +optional Image string `json:"image,omitempty"` // *Optional* + // // Object specification for specifying CPU and memory https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource allocations] or limits in the MinIO tenant. + // +optional Resources corev1.ResourceRequirements `json:"resources,omitempty"` // *Optional* + // // The filter for the Operator to apply when selecting which nodes on which to deploy MinIO Log Search API pods. The Operator only selects those nodes whose labels match the specified selector. + // // See the Kubernetes documentation on https://kubernetes.io/docs/concepts/configuration/assign-pod-node/[Assigning Pods to Nodes] for more information. // +optional NodeSelector map[string]string `json:"nodeSelector,omitempty"` // *Optional* + // // Specify node affinity, pod affinity, and pod anti-affinity for LogSearch API pods. + // +optional Affinity *corev1.Affinity `json:"affinity,omitempty"` // *Optional* + // // Specify one or more https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/[Kubernetes tolerations] to apply to MinIO Log Search API pods. // +optional Tolerations []corev1.Toleration `json:"tolerations,omitempty"` // *Optional* + // // If provided, use these annotations for Log Search Object Meta annotations // +optional Annotations map[string]string `json:"annotations,omitempty"` // *Optional* + // // If provided, use these labels for Log Search Object Meta labels // +optional Labels map[string]string `json:"labels,omitempty"` // *Optional* + // // Object specification for configuring the backing PostgreSQL database for the LogSearch API. + // +optional Db *LogDbConfig `json:"db,omitempty"` // nolint:stylecheck // *Required* + // // Object specification for configuring LogSearch API. // +optional Audit *AuditConfig `json:"audit,omitempty"` // *Optional* + // // Specify the https://kubernetes.io/docs/tasks/configure-pod-container/security-context/[Security Context] of pods deployed as part of the Log Search API. The Operator supports only the following pod security fields: + // // * `fsGroup` + // // * `fsGroupChangePolicy` + // // * `runAsGroup` + // // * `runAsNonRoot` + // // * `runAsUser` + // // * `seLinuxOptions` + // +optional SecurityContext *corev1.PodSecurityContext `json:"securityContext,omitempty"` }
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.
func (*LogConfig) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LogConfig.
func (*LogConfig) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*LogConfig) EqualImage ¶
EqualImage returns true if image specified in `LogConfig` is equal to `image`.
type LogDbConfig ¶
type LogDbConfig struct { // *Optional* + // // The Docker image to use for deploying PostgreSQL. Defaults to {postgres-image}. + // +optional Image string `json:"image,omitempty"` // *Optional* + // // Specify the configuration options for the MinIO Operator to use when generating Persistent Volume Claims for the PostgreSQL pod. + VolumeClaimTemplate *corev1.PersistentVolumeClaim `json:"volumeClaimTemplate"` // *Optional* + // // Object specification for specifying CPU and memory https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource allocations] or limits for the PostgreSQL pod. // +optional Resources corev1.ResourceRequirements `json:"resources,omitempty"` // *Optional* + // // The filter for the Operator to apply when selecting which nodes on which to deploy the PostgreSQL pod. The Operator only selects those nodes whose labels match the specified selector. + // // See the Kubernetes documentation on https://kubernetes.io/docs/concepts/configuration/assign-pod-node/[Assigning Pods to Nodes] for more information. // +optional NodeSelector map[string]string `json:"nodeSelector,omitempty"` // *Optional* + // // Specify node affinity, pod affinity, and pod anti-affinity for the PostgreSQL pods. + // +optional Affinity *corev1.Affinity `json:"affinity,omitempty"` // *Optional* + // // Specify one or more https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/[Kubernetes tolerations] to apply to the PostgreSQL pods. // +optional Tolerations []corev1.Toleration `json:"tolerations,omitempty"` // *Optional* + // // If provided, use these annotations for PostgreSQL Object Meta annotations // +optional Annotations map[string]string `json:"annotations,omitempty"` // *Optional* + // // If provided, use these labels for PostgreSQL Object Meta labels // +optional Labels map[string]string `json:"labels,omitempty"` // *Optional* + // // Specify the https://kubernetes.io/docs/tasks/configure-pod-container/security-context/[Security Context] of the PostgreSQL pods. The Operator supports only the following pod security fields: + // // * `fsGroup` + // // * `fsGroupChangePolicy` + // // * `runAsGroup` + // // * `runAsNonRoot` + // // * `runAsUser` + // // * `seLinuxOptions` + // +optional SecurityContext *corev1.PodSecurityContext `json:"securityContext,omitempty"` }
LogDbConfig (`db`) defines the configuration of the PostgreSQL StatefulSet deployed to support the MinIO LogSearch API.
func (*LogDbConfig) DeepCopy ¶
func (in *LogDbConfig) DeepCopy() *LogDbConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LogDbConfig.
func (*LogDbConfig) DeepCopyInto ¶
func (in *LogDbConfig) DeepCopyInto(out *LogDbConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Pool ¶
type Pool struct { // *Optional* + // // Specify the name of the pool. The Operator automatically generates the pool name if this field is omitted. // +optional Name string `json:"name,omitempty"` // *Required* // // The number of MinIO server pods to deploy in the pool. The minimum value is `2`. // // The MinIO Operator requires a minimum of `4` volumes per pool. Specifically, the result of `pools.servers X pools.volumesPerServer` must be greater than `4`. + Servers int32 `json:"servers"` // *Required* + // // The number of Persistent Volume Claims to generate for each MinIO server pod in the pool. + // // The MinIO Operator requires a minimum of `4` volumes per pool. Specifically, the result of `pools.servers X pools.volumesPerServer` must be greater than `4`. + VolumesPerServer int32 `json:"volumesPerServer"` // *Required* + // // Specify the configuration options for the MinIO Operator to use when generating Persistent Volume Claims for the MinIO tenant. + // VolumeClaimTemplate *corev1.PersistentVolumeClaim `json:"volumeClaimTemplate"` // *Optional* + // // Object specification for specifying CPU and memory https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource allocations] or limits in the MinIO tenant. + // +optional Resources corev1.ResourceRequirements `json:"resources,omitempty"` // *Optional* + // // The filter for the Operator to apply when selecting which nodes on which to deploy pods in the pool. The Operator only selects those nodes whose labels match the specified selector. + // // See the Kubernetes documentation on https://kubernetes.io/docs/concepts/configuration/assign-pod-node/[Assigning Pods to Nodes] for more information. // +optional NodeSelector map[string]string `json:"nodeSelector,omitempty"` // *Optional* + // // Specify node affinity, pod affinity, and pod anti-affinity for pods in the MinIO pool. + // +optional Affinity *corev1.Affinity `json:"affinity,omitempty"` // *Optional* + // // Specify one or more https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/[Kubernetes tolerations] to apply to pods deployed in the MinIO pool. // +optional Tolerations []corev1.Toleration `json:"tolerations,omitempty"` // *Optional* + // // Specify the https://kubernetes.io/docs/tasks/configure-pod-container/security-context/[Security Context] of pods in the pool. The Operator supports only the following pod security fields: + // // * `fsGroup` + // // * `fsGroupChangePolicy` + // // * `runAsGroup` + // // * `runAsNonRoot` + // // * `runAsUser` + // // * `seLinuxOptions` + // // +optional SecurityContext *corev1.PodSecurityContext `json:"securityContext,omitempty"` }
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 https://docs.min.io/minio/k8s/reference/minio-operator-reference.html#server-pools[MinIO Operator CRD] reference for the `pools` object for examples and more complete documentation.
func (*Pool) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Pool.
func (*Pool) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PoolState ¶
type PoolState string
PoolState represents the state of a pool.
const ( // PoolNotCreated of a pool when it's not even created yet. PoolNotCreated PoolState = "PoolNotCreated" // PoolCreated indicates a pool was created. PoolCreated PoolState = "PoolCreated" // PoolInitialized indicates if a pool has been observed to be online. PoolInitialized PoolState = "PoolInitialized" )
type PoolStatus ¶
PoolStatus keeps track of all the pools and their current state.
func (*PoolStatus) DeepCopy ¶
func (in *PoolStatus) DeepCopy() *PoolStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PoolStatus.
func (*PoolStatus) DeepCopyInto ¶
func (in *PoolStatus) DeepCopyInto(out *PoolStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PrometheusConfig ¶
type PrometheusConfig struct { // *Optional* + // // Defines the Docker image to use for deploying Prometheus pods. Defaults to {prometheus-image}. + // +optional Image string `json:"image,omitempty"` // *Optional* + // // Deprecated: in Operator v4.0.1* + // // Defines the Docker image to use as a sidecar for the Prometheus server. Defaults to `alpine`. + // // The specified Docker image *must* be the https://hub.docker.com/_/alpine[`alpine`] package. + // +optional SideCarImage string `json:"sidecarimage,omitempty"` // *Optional* + // // Deprecated: in Operator v4.0.1* + // // Defines the Docker image to use as the init container for running the Prometheus server. Defaults to `busybox`. + // // The specified Docker image *must* be the https://hub.docker.com/_/busybox[`busybox`] package. + // +optional InitImage string `json:"initimage,omitempty"` // *Optional* + // // Specify the amount of storage to request in Gigabytes (GB) for supporting the Prometheus pod. // +optional DiskCapacityDB *int `json:"diskCapacityGB,omitempty"` // *Optional* + // // If provided, use these annotations for Prometheus Object Meta annotations // +optional Annotations map[string]string `json:"annotations,omitempty"` // *Optional* + // // If provided, use these labels for Prometheus Object Meta labels // +optional Labels map[string]string `json:"labels,omitempty"` // *Optional* + // // The filter for the Operator to apply when selecting which nodes on which to deploy the Prometheus pod. The Operator only selects those nodes whose labels match the specified selector. + // // See the Kubernetes documentation on https://kubernetes.io/docs/concepts/configuration/assign-pod-node/[Assigning Pods to Nodes] for more information. // +optional NodeSelector map[string]string `json:"nodeSelector,omitempty"` // *Optional* + // // Object specification for specifying CPU and memory https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource allocations] or limits of the Prometheus pod. + // +optional Resources corev1.ResourceRequirements `json:"resources,omitempty"` // *Optional* + // // Specify the https://kubernetes.io/docs/tasks/configure-pod-container/security-context/[Security Context] of the Prometheus pod. The Operator supports only the following pod security fields: + // // * `fsGroup` + // // * `fsGroupChangePolicy` + // // * `runAsGroup` + // // * `runAsNonRoot` + // // * `runAsUser` + // // * `seLinuxOptions` + // +optional SecurityContext *corev1.PodSecurityContext `json:"securityContext,omitempty"` }
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-image} Docker image.
func (*PrometheusConfig) DeepCopy ¶
func (in *PrometheusConfig) DeepCopy() *PrometheusConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PrometheusConfig.
func (*PrometheusConfig) DeepCopyInto ¶
func (in *PrometheusConfig) DeepCopyInto(out *PrometheusConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type S3Features ¶
type S3Features struct { // *Optional* + // // Specify `true` to allow clients to access buckets using the DNS path `<bucket>.minio.default.svc.cluster.local`. Defaults to `false`. // BucketDNS bool `json:"bucketDNS"` }
S3Features (`s3`) - Object describing which S3 features to enable/disable in the MinIO Tenant. +
Currently only supports `BucketDNS`.
func (*S3Features) DeepCopy ¶
func (in *S3Features) DeepCopy() *S3Features
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new S3Features.
func (*S3Features) DeepCopyInto ¶
func (in *S3Features) DeepCopyInto(out *S3Features)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ServiceMetadata ¶
type ServiceMetadata struct { // *Optional* + // // If provided, append these labels to the MinIO service // +optional MinIOServiceLabels map[string]string `json:"minioServiceLabels,omitempty"` // *Optional* + // // If provided, append these annotations to the MinIO service // +optional MinIOServiceAnnotations map[string]string `json:"minioServiceAnnotations,omitempty"` // *Optional* + // // If provided, append these labels to the Console service // +optional ConsoleServiceLabels map[string]string `json:"consoleServiceLabels,omitempty"` // *Optional* + // // If provided, append these annotations to the Console service // +optional ConsoleServiceAnnotations map[string]string `json:"consoleServiceAnnotations,omitempty"` }
ServiceMetadata (`serviceMetadata`) defines custom labels and annotations for the MinIO Object Storage service and/or MinIO Console service.
func (*ServiceMetadata) DeepCopy ¶
func (in *ServiceMetadata) DeepCopy() *ServiceMetadata
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceMetadata.
func (*ServiceMetadata) DeepCopyInto ¶
func (in *ServiceMetadata) DeepCopyInto(out *ServiceMetadata)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SideCars ¶
type SideCars struct { // *Optional* + // // List of containers to run inside the Pod // +patchMergeKey=name // +patchStrategy=merge Containers []corev1.Container `json:"containers" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,2,rep,name=containers"` // *Optional* + // // volumeClaimTemplates is a list of claims that pods are allowed to reference. // The StatefulSet controller is responsible for mapping network identities to // claims in a way that maintains the identity of a pod. Every claim in // this list must have at least one matching (by name) volumeMount in one // container in the template. A claim in this list takes precedence over // any volumes in the template, with the same name. // +TODO: Define the behavior if a claim already exists with the same name. // +optional VolumeClaimTemplates []corev1.PersistentVolumeClaim `json:"volumeClaimTemplates,omitempty" protobuf:"bytes,4,rep,name=volumeClaimTemplates"` // *Optional* + // // List of volumes that can be mounted by containers belonging to the pod. // More info: https://kubernetes.io/docs/concepts/storage/volumes // +optional // +patchMergeKey=name // +patchStrategy=merge,retainKeys Volumes []corev1.Volume `json:"volumes,omitempty" patchStrategy:"merge,retainKeys" patchMergeKey:"name" protobuf:"bytes,1,rep,name=volumes"` }
SideCars (`sidecars`) defines a list of containers that the Operator attaches to each MinIO server pods in the `pool`.
func (*SideCars) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SideCars.
func (*SideCars) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Tenant ¶
type Tenant struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Scheduler TenantScheduler `json:"scheduler,omitempty"` // *Required* + // // The root field for the MinIO Tenant object. Spec TenantSpec `json:"spec"` // Status provides details of the state of the Tenant // +optional Status TenantStatus `json:"status"` }
Tenant is a https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/[Kubernetes object] describing a MinIO Tenant.
func (*Tenant) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tenant.
func (*Tenant) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Tenant) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TenantList ¶
type TenantList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []Tenant `json:"items"` }
TenantList is a list of Tenant resources.
func (*TenantList) DeepCopy ¶
func (in *TenantList) DeepCopy() *TenantList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TenantList.
func (*TenantList) DeepCopyInto ¶
func (in *TenantList) DeepCopyInto(out *TenantList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TenantList) DeepCopyObject ¶
func (in *TenantList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TenantScheduler ¶
type TenantScheduler struct { // *Optional* + // // Specify the name of the https://kubernetes.io/docs/concepts/scheduling-eviction/kube-scheduler/[Kubernetes scheduler] to be used to schedule Tenant pods Name string `json:"name"` }
TenantScheduler (`scheduler`) - Object describing Kubernetes Scheduler to use for deploying the MinIO Tenant.
func (*TenantScheduler) DeepCopy ¶
func (in *TenantScheduler) DeepCopy() *TenantScheduler
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TenantScheduler.
func (*TenantScheduler) DeepCopyInto ¶
func (in *TenantScheduler) DeepCopyInto(out *TenantScheduler)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TenantSpec ¶
type TenantSpec struct { // *Optional* + // // An array of https://kubernetes.io/docs/concepts/configuration/secret/[Kubernetes opaque secrets] to use for generating MinIO users during tenant provisioning. + // // Each element in the array is an object consisting of a key-value pair `name: <string>`, where the `<string>` references an opaque Kubernetes secret. + // // Each referenced Kubernetes secret must include the following fields: + // // * `CONSOLE_ACCESS_KEY` - The "Username" for the MinIO user + // // * `CONSOLE_SECRET_KEY` - The "Password" for the MinIO user + // // The Operator creates each user with the `consoleAdmin` policy by default. You can change the assigned policy after the Tenant starts. + // +optional Users []*corev1.LocalObjectReference `json:"users,omitempty"` // *Required* + // // An array of objects describing each MinIO server pool deployed in the MinIO 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. + // // The MinIO Tenant `spec` *must have* at least *one* element in the `pools` array. + // // See the https://docs.min.io/minio/k8s/reference/minio-operator-reference.html#server-pools[MinIO Operator CRD] reference for the `pools` object for examples and more complete documentation. Pools []Pool `json:"pools"` // *Optional* + // // The Docker image to use when deploying `minio` server pods. Defaults to {minio-image}. + // // +optional Image string `json:"image,omitempty"` // *Optional* + // // Specify the secret key to use for pulling images from a private Docker repository. + // +optional ImagePullSecret corev1.LocalObjectReference `json:"imagePullSecret,omitempty"` // *Optional* + // // Pod Management Policy for pod created by StatefulSet // +optional PodManagementPolicy appsv1.PodManagementPolicyType `json:"podManagementPolicy,omitempty"` // *Optional* + // // Specify a https://kubernetes.io/docs/concepts/configuration/secret/[Kubernetes opaque secret] to use for setting the MinIO root access key and secret key. Specify the secret as `name: <secret>`. The Kubernetes secret must contain the following fields: + // // * `data.accesskey` - The access key for the root credentials + // // * `data.secretkey` - The secret key for the root credentials + // // The MinIO Operator automatically generates the secret along with appropriate values for the access key and secret key if this field is omitted. + // // +optional CredsSecret *corev1.LocalObjectReference `json:"credsSecret,omitempty"` // *Optional* + // // If provided, the MinIO Operator the specified environment variables when deploying the Tenant resource. // +optional Env []corev1.EnvVar `json:"env,omitempty"` // *Optional* + // // Enables TLS with SNI support on each MinIO pod in the tenant. If `externalCertSecret` is omitted *and* `requestAutoCert` is set to `false`, the MinIO Tenant deploys *without* TLS enabled. + // // Specify an array of https://kubernetes.io/docs/concepts/configuration/secret/[Kubernetes TLS secrets]. The MinIO Operator copies the specified certificates to every MinIO server pod in the tenant. When the MinIO pod/service responds to a TLS connection request, it uses SNI to select the certificate with matching `subjectAlternativeName`. + // // Each element in the `externalCertSecret` array is an object containing the following fields: + // // * - `name` - The name of the Kubernetes secret containing the TLS certificate. + // // * - `type` - Specify `kubernetes.io/tls` + // // See the https://docs.min.io/minio/k8s/reference/minio-operator-reference.html#transport-layer-encryption-tls[MinIO Operator CRD] reference for examples and more complete documentation on configuring TLS for MinIO Tenants. // +optional ExternalCertSecret []*LocalCertificateReference `json:"externalCertSecret,omitempty"` // *Optional* + // // Allows MinIO server pods to verify client TLS certificates signed by a Certificate Authority not in the pod's trust store. + // // Specify an array of https://kubernetes.io/docs/concepts/configuration/secret/[Kubernetes TLS secrets]. The MinIO Operator copies the specified certificates to every MinIO server pod in the tenant. + // // Each element in the `externalCertSecret` array is an object containing the following fields: + // // * - `name` - The name of the Kubernetes secret containing the Certificate Authority. + // // * - `type` - Specify `kubernetes.io/tls`. + // // See the https://docs.min.io/minio/k8s/reference/minio-operator-reference.html#transport-layer-encryption-tls[MinIO Operator CRD] reference for examples and more complete documentation on configuring TLS for MinIO Tenants. // +optional ExternalCaCertSecret []*LocalCertificateReference `json:"externalCaCertSecret,omitempty"` // *Optional* + // // Enables mTLS authentication between the MinIO Tenant pods and https://github.com/minio/kes[MinIO KES]. *Required* for enabling connectivity between the MinIO Tenant and MinIO KES. + // // Specify a https://kubernetes.io/docs/concepts/configuration/secret/[Kubernetes TLS secrets]. The MinIO Operator copies the specified certificate to every MinIO server pod in the tenant. The secret *must* contain the following fields: + // // * `name` - The name of the Kubernetes secret containing the TLS certificate. + // // * `type` - Specify `kubernetes.io/tls` + // // The specified certificate *must* correspond to an identity on the KES server. See the https://github.com/minio/kes/wiki/Configuration#policy-configuration[KES Wiki] for more information on KES identities. + // // If deploying KES with the MinIO Operator, include the hash of the certificate as part of the <<k8s-api-github-com-minio-operator-pkg-apis-minio-min-io-v2-kesconfig,`kes`>> object specification. + // // See the https://docs.min.io/minio/k8s/reference/minio-operator-reference.html#transport-layer-encryption-tls[MinIO Operator CRD] reference for examples and more complete documentation on configuring TLS for MinIO Tenants. // // +optional ExternalClientCertSecret *LocalCertificateReference `json:"externalClientCertSecret,omitempty"` // *Optional* + // // Mount path for MinIO volume (PV). Defaults to `/export` // +optional Mountpath string `json:"mountPath,omitempty"` // *Optional* + // // Subpath inside mount path. This is the directory where MinIO stores data. Default to `""“ (empty) // +optional Subpath string `json:"subPath,omitempty"` // *Optional* + // // Enables using https://kubernetes.io/docs/tasks/tls/managing-tls-in-a-cluster/[Kubernetes-based TLS certificate generation] and signing for pods and services in the MinIO Tenant. + // // * Specify `true` to explicitly enable automatic certificate generate (Default). + // // * Specify `false` to disable automatic certificate generation. + // // If `requestAutoCert` is set to `false` *and* `externalCertSecret` is omitted, the MinIO Tenant deploys *without* TLS enabled. // // See the https://docs.min.io/minio/k8s/reference/minio-operator-reference.html#transport-layer-encryption-tls[MinIO Operator CRD] reference for examples and more complete documentation on configuring TLS for MinIO Tenants. // +optional RequestAutoCert *bool `json:"requestAutoCert,omitempty"` // *Optional* + // // S3 related features can be disabled or enabled such as `bucketDNS` etc. S3 *S3Features `json:"s3,omitempty"` // *Optional* + // // Enables setting the `CommonName`, `Organization`, and `dnsName` attributes for all TLS certificates automatically generated by the Operator. Configuring this object has no effect if `requestAutoCert` is `false`. + // +optional CertConfig *CertificateConfig `json:"certConfig,omitempty"` // *Optional* + // // Directs the MinIO Operator to deploy the https://github.com/minio/console[MinIO Console] using the specified configuration. The MinIO Console is a first-party graphical user interface for performing administration on the MinIO Tenant. + // //+optional Console *ConsoleConfiguration `json:"console,omitempty"` // *Optional* + // // Directs the MinIO Operator to deploy the https://github.com/minio/kes[MinIO Key Encryption Service] (KES) using the specified configuration. The MinIO KES supports performing server-side encryption of objects on the MiNIO Tenant. + // // //+optional KES *KESConfig `json:"kes,omitempty"` // *Optional* + // // Directs the MinIO Operator to deploy and configure the MinIO Log Search API. The Operator deploys a PostgreSQL instance as part of the tenant to support storing and querying MinIO logs. + // // If the tenant spec includes the `console` configuration, the Operator automatically configures and enables MinIO log search via the Console UI. + //+optional Log *LogConfig `json:"log,omitempty"` // *Optional* + // // Directs the MinIO Operator to deploy and configure Prometheus for collecting tenant metrics. + // // For example, `minio.<namespace>.svc.<cluster-domain>.<example>/minio/v2/metrics/cluster`. The specific DNS name for the service depends on your Kubernetes cluster configuration. See the Kubernetes documentation on https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/[DNS for Services and Pods] for more information. //+optional Prometheus *PrometheusConfig `json:"prometheus,omitempty"` // *Optional* + // // The https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/[Kubernetes Service Account] to use for running MinIO pods created as part of the Tenant. + // +optional ServiceAccountName string `json:"serviceAccountName,omitempty"` // *Optional* + // // Indicates the Pod priority and therefore importance of a Pod relative to other Pods in the cluster. // This is applied to MinIO pods only. + // // Refer Kubernetes https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass[Priority Class documentation] for more complete documentation. // +optional PriorityClassName string `json:"priorityClassName,omitempty"` // *Optional* + // // The pull policy for the MinIO Docker image. Specify one of the following: + // // * `Always` + // // * `Never` + // // * `IfNotPresent` (Default) + // // Refer Kubernetes documentation for details https://kubernetes.io/docs/concepts/containers/images#updating-images ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"` // *Optional* + // // A list of containers to run as sidecars along every MinIO Pod deployed in the tenant. // +optional SideCars *SideCars `json:"sideCars,omitempty"` // *Optional* + // // Directs the Operator to expose the MinIO and/or Console services. + // +optional ExposeServices *ExposeServices `json:"exposeServices,omitempty"` // *Optional* + // // Specify custom labels and annotations to append to the MinIO service and/or Console service. // +optional ServiceMetadata *ServiceMetadata `json:"serviceMetadata,omitempty"` }
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 https://docs.min.io/minio/k8s/reference/minio-operator-reference.html#minio-operator-yaml-reference[MinIO Kubernetes Documentation].
func (*TenantSpec) DeepCopy ¶
func (in *TenantSpec) DeepCopy() *TenantSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TenantSpec.
func (*TenantSpec) DeepCopyInto ¶
func (in *TenantSpec) DeepCopyInto(out *TenantSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TenantStatus ¶
type TenantStatus struct { CurrentState string `json:"currentState"` AvailableReplicas int32 `json:"availableReplicas"` Revision int32 `json:"revision"` SyncVersion string `json:"syncVersion"` // Keeps track of all the TLS certificates managed by the operator. // +nullable Certificates CertificateStatus `json:"certificates"` // All the pools get an individual status. // +nullable Pools []PoolStatus `json:"pools"` }
TenantStatus is the status for a Tenant resource.
func (*TenantStatus) DeepCopy ¶
func (in *TenantStatus) DeepCopy() *TenantStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TenantStatus.
func (*TenantStatus) DeepCopyInto ¶
func (in *TenantStatus) DeepCopyInto(out *TenantStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.