docs/source/reference/kubectl-minio-plugin/kubectl-minio-tenant-create.rst

kubectl minio tenant create

minio

Table of Contents

kubectl minio tenant create

Description

kubectl minio tenant create adds a new MinIO tenant and associated resources to a Kubernetes cluster. The Operator Console <minio-operator-console> provides a rich user interface for deploying and managing MinIO Tenants <minio-k8s-deploy-minio-tenant>.

~kubectl minio tenant create always uses the latest stable version of the MinIO Server <minio/releases> and MinIO Console <console/releases>.

On success, the command returns the following:

• The administrative username and password for the Tenant.

  Important

  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.

Syntax

EXAMPLE

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                             \
                     minio-tenant-1                     \
                     --servers          4               \
                     --volumes          8               \
                     --capacity         32Ti            \
                     --namespace        minio-tenant-1  \
                     --storage-class    local-storage

SYNTAX

The command has the following syntax:

kubectl minio tenant create                      \
                     TENANT_NAME                 \                          
                     [--interactive]             \
                     [--disable-tls]             \
                     [--enable-audit-logs]       \
                     [--enable-prometheus]       \
                     [--expose-console-service]  \
                     [--expose-minio-service]    \
                     [--image]                   \
                     [--image-pull-secret]       \
                     [--kes-config]              \
                     [--namespace]               \
                     [--output]                  \
                     [--pool]                    \
                     [--storage-class]           \
                     --capacity                  \
                     --servers                   \
                     --volumes                   \

Flags

The command supports the following flags:

--interactive

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:

• Tenant name
• Total servers
• Total volumes
• Namespace
• Capacity
• Disable TLS
• Disable audit logs
• Disable prometheus

TENANT_NAME

The name of the MinIO tenant which the command creates. The name must be unique in the ~kubectl minio tenant create --namespace.

--capacity

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 minio divides the capacity by the number of ~kubectl minio tenant create --volumes to determine the amount of resources.requests.storage to set for each Persistent Volume Claim (PVC).

If no Persistent Volumes (PV) can satisfy the requested storage, kubectl minio tenant create hangs and waits until the required storage exists.

--servers

The number of minio servers to deploy on the Kubernetes cluster.

Ensure that the specified number of ~kubectl minio tenant create --servers does not exceed the number of nodes in the Kubernetes cluster.

--volumes

Total number of volumes to use in the MinIO tenant.

kubectl minio tenant create generates one Persistent Volume Claim (PVC) <concepts/storage/persistent-volumes/#persistentvolumeclaims> for each volume.

The number of volumes affects both the requested storage of each PVC and the number of PVC to associate to each MinIO Pod in the cluster:

• The command kubectl minio divides the ~kubectl minio tenant create --capacity by the number of volumes to determine the amount of resources.requests.storage to set for each PVC.
• kubectl minio determines the number of PVC to associate to each minio server by dividing ~kubectl minio tenant create --volumes by ~kubectl minio tenant create --servers.

The command generates each PVC with Pod-specific selectors, such that each Pod only uses PV that are locally-attached to the node running that Pod.

If the specified number of volumes exceeds the number of unbound PV available on the cluster, kubectl minio tenant create hangs and waits until the required PV exist.

--disable-tls

Disables automatic TLS certificate provisioning on the Tenant.

--enable-audit-logs

Defaults to true.

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:

Option	Description
--audit-logs-disk-space <int>	Specify the amount of storage to provision for the PostgreSQL pod. The Operator provisions a PVC requesting the specified amount of storage in gigabytes. Defaults to 5 If no Persistent Volume can meet the PVC request, the pod fails to deploy.
--audit-logs-pg-image	Specify the Docker image to use for deploying the PostgreSQL pod.
--audit-logs-storage-class	Specify the storage class to assign to the generated PVC for the PostgreSQL Pod.

Specify false to deploy the Tenant without the PostgreSQL and Audit Logging Console feature.

--enable-prometheus

Defaults to true.

Deploys the MinIO Tenant with a Prometheus pod which enables the MinIO Console Metrics <minio-console-monitoring> view.

You can control the configuration of the Prometheus pod using the following optional parameters:

Option	Description
--prometheus-disk-space <int>	Specify the amount of storage to provision for the Prometheus pod. The Operator provisions a PVC requesting the specified amount of storage in gigabytes. Defaults to 5.
--prometheus-image	Specify the Docker image to use for deploying the Prometheus pod.
--prometheus-storage-class	Specify the storage class to assign to the generated PVC for the Prometheus pod.

--expose-console-service

Directs the Operator to configure the MinIO Tenant Console service with the LoadBalancer <concepts/services-networking/service/#loadbalancer> networking type. For Kubernetes clusters configured with a global load balancer, this option allows the Console to request an external IP address automatically.

--expose-minio-service

Directs the Operator to configure the MinIO API service with the LoadBalancer <concepts/services-networking/service/#loadbalancer> networking type. For Kubernetes clusters configured with a global load balancer, this option allows the Console to request an external IP address automatically.

--image

MinIO image to use for the tenant. Defaults to the latest minio release.

--image-pull-secret

The image secret to use for pulling MinIO.

--kes-config

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.

--namespace

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.

Defaults to minio.

--output

Dry run the command and generate the YAML.

~kubectl minio tenant create --output does not create the MinIO Tenant. Use kubectl apply -f <FILE> to manually create the MinIO tenant using the generated file.

--pool

Assign a name for the pool added for the tenant.

--storage-class

The type of storage to use for this tenant.

The name of the Kubernetes Storage Class <concepts/storage/storage-classes/> to use when creating Persistent Volume Claims (PVC) for the MinIO Tenant. The specified ~kubectl minio tenant create --storage-class must match the storage-class of the Persistent Volumes (PVs) to which the PVCs should bind.

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 <minio-k8s-deploy-minio-tenant> tutorial for guidance on creating Storage Classes for supporting the MinIO Tenant.

Defaults to default.