Command Requires MinIO Operator
Use the following command to validate that the operator is online and available prior to running this command:
kubectl get deployments -A --field-selector metadata.name=minio-operator
kubectl minio init command to initiate the operator
if it is not already running in the Kubernetes cluster.
On success, the command returns the following:
The administrative username and password for the Tenant.
Store these credentials in a secure location, such as a password protected key manager. MinIO does not show these credentials again.
The Service created for connecting to the MinIO Console. The Console supports administrative operations on the Tenant, such as configuring Identity and Access Management (IAM) and bucket configurations.
The Service created for connecting to the MinIO Tenant. Applications should use this service for performing operations against the MinIO Tenant.
The following example creates a MinIO Tenant in the namespace
minio-tenant-1 consisting of 4 MinIO servers with 8 drives each and a total capacity of 32Ti.
kubectl minio tenant create \
--servers 4 \
--volumes 8 \
--capacity 32Ti \
--namespace minio-tenant-1 \
The command has the following syntax:
kubectl minio tenant create \
The command supports the following flags:
Offers command line prompts to request the information required to set up a new tenant. This command is mutually exclusive of the other flags when creating a new tenant.
When added, prompts ask for input for the following values:
Disable audit logs
The name of the MinIO tenant which the command creates. The name must be unique in the
Total raw capacity of the MinIO tenant, such as 16Ti. Include a string that is a number and a standard storage capacity unit.
The total capacity of the MinIO tenant.
kubectl miniodivides the capacity by the number of
--volumesto determine the amount of
resources.requests.storageto set for each Persistent Volume Claim (
If no Persistent Volumes (
PV) can satisfy the requested storage,
kubectl minio tenant createhangs and waits until the required storage exists.
The number of
minioservers to deploy on the Kubernetes cluster.
Ensure that the specified number of
--serversdoes not exceed the number of nodes in the Kubernetes cluster.
Total number of volumes to use in the MinIO tenant.
The number of volumes affects both the requested storage of each
PVCand the number of
PVCto associate to each MinIO Pod in the cluster:
The command generates each
PVCwith Pod-specific selectors, such that each Pod only uses
PVthat are locally-attached to the node running that Pod.
If the specified number of volumes exceeds the number of unbound
PVavailable on the cluster,
kubectl minio tenant createhangs and waits until the required
MinIO plans to deprecate the Tenant Console Audit Log feature and remove it in an upcoming release. MinIO recommends disabling this feature in preparation for this change.
As an alternative, use any webhook-capable database or logging service to capture audit logs from the Tenant.
Deploys the MinIO Tenant with a PostgreSQL Pod which, combined with an additional auto-deployed service, enables Audit Logging in the Tenant Console.
You can control the configuration of the PostgreSQL pod using the following optional parameters:
Specify the amount of storage to provision for the PostgreSQL pod. The Operator provisions a PVC requesting the specified amount of storage in gigabytes.
If no Persistent Volume can meet the PVC request, the pod fails to deploy.
Specify the Docker image to use for deploying the PostgreSQL pod.
Specify the storage class to assign to the generated PVC for the PostgreSQL Pod.
falseto deploy the Tenant without the PostgreSQL and Audit Logging Console feature.
MinIO plans to deprecate the Tenant Prometheus pod feature and remove it in an upcoming release. MinIO recommends setting this value to
falsein preparation for this change.
As an alternative, use any Prometheus service deployed within the Kubernetes cluster or externally to capture Tenant metrics.
Deploys the MinIO Tenant with a Prometheus pod which enables the MinIO Console Metrics view.
You can control the configuration of the Prometheus pod using the following optional parameters:
Specify the amount of storage to provision for the Prometheus pod. The Operator provisions a PVC requesting the specified amount of storage in gigabytes.
Specify the Docker image to use for deploying the Prometheus pod.
Specify the storage class to assign to the generated PVC for the Prometheus pod.
Directs the Operator to configure the MinIO Tenant Console service with the LoadBalancer networking type. For Kubernetes clusters configured with a global load balancer, this option allows the Console to request an external IP address automatically.
Directs the Operator to configure the MinIO API service with the LoadBalancer networking type. For Kubernetes clusters configured with a global load balancer, this option allows the Console to request an external IP address automatically.
The name of the Kubernetes Secret which contains the MinIO Key Encryption Service (KES) configuration. Required for enabling Server Side Encryption of objects (SSE-S3).
For more, see the Github documentation.
New in version v5.0.11.
The KES image to use when deploying KES pods in the tenant.
You cannot downgrade KES images after deployment.
The namespace in which to create the MinIO Tenant and its associated resources.
MinIO supports exactly one MinIO Tenant per namespace. Create a unique namespace for each MinIO Tenant deployed into the cluster.
Dry run the command and generate the
--outputdoes not create the MinIO Tenant. Use
kubectl apply -f <FILE>to manually create the MinIO tenant using the generated file.
The type of storage to use for this tenant.
The name of the Kubernetes Storage Class to use when creating Persistent Volume Claims (
PVC) for the MinIO Tenant. The specified
--storage-classmust match the
storage-classof the Persistent Volumes (
PVs) to which the
MinIO strongly recommends creating a Storage Class that corresponds to locally-attached volumes on the host machines on which the Tenant deploys. This ensures each pod can use locally-attached storage for maximum performance and throughput. See the Deploy MinIO Tenant tutorial for guidance on creating Storage Classes for supporting the MinIO Tenant.