minio/docs/orchestration/kubernetes

Deploy Minio on Kubernetes

Kubernetes concepts like Deployments and StatefulSets provide perfect platform to deploy Minio server in standalone, distributed or shared mode. There are multiple options to deploy Minio on Kubernetes, you can choose the one that suits you the most.

• Minio Helm Chart offers a customizable and easy Minio deployment, with a single command. Read more about Minio Helm deployment here.

• You can also explore Kubernetes Minio example to deploy Minio using .yaml files.

• If you'd like to get started with Minio on Kubernetes without having to create a real container cluster, you can also deploy Minio locally with MiniKube.

1. Prerequisites

• Kubernetes 1.4+ with Beta APIs enabled for default standalone mode.
• Kubernetes 1.5+ with Beta APIs enabled to run Minio in distributed mode.
• PV provisioner support in the underlying infrastructure.
• Helm package manager installed on your Kubernetes cluster.

2. Deploy Minio using Helm Chart

Install Minio chart by

$ helm install stable/minio

Above command deploys Minio on the Kubernetes cluster in the default configuration. Below section lists all the configurable parameters of the Minio chart and their default values.

Configuration

Parameter	Description	Default
image	Minio image name	minio/minio
imageTag	Minio image tag. Possible values listed here.	RELEASE.2018-10-18T00-28-58Z
imagePullPolicy	Image pull policy	Always
mode	Minio server mode (standalone, shared or distributed)	standalone
numberOfNodes	Number of nodes (applicable only for Minio distributed mode). Should be 4 <= x <= 16	4
accessKey	Default access key	AKIAIOSFODNN7EXAMPLE
secretKey	Default secret key	wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
configPath	Default config file location	~/.minio
mountPath	Default mount location for persistent drive	/export
serviceType	Kubernetes service type	LoadBalancer
servicePort	Kubernetes port where service is exposed	9000
persistence.enabled	Use persistent volume to store data	true
persistence.size	Size of persistent volume claim	10Gi
persistence.storageClass	Type of persistent volume claim	generic
persistence.accessMode	ReadWriteOnce or ReadOnly	ReadWriteOnce
resources	CPU/Memory resource requests/limits	Memory: 256Mi, CPU: 100m

You can specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install --name my-release \
  --set persistence.size=100Gi \
    stable/minio

The above command deploys Minio server with a 100Gi backing persistent volume.

Alternately, you can provide a YAML file that specifies parameter values while installing the chart. For example,

$ helm install --name my-release -f values.yaml stable/minio

Distributed Minio

This chart provisions a Minio server in standalone mode, by default. To provision Minio server in distributed mode, set the mode field to distributed,

$ helm install --set mode=distributed stable/minio

This provisions Minio server in distributed mode with 4 nodes. To change the number of nodes in your distributed Minio server, set the numberOfNodes field,

$ helm install --set mode=distributed,numberOfNodes=8 stable/minio

This provisions Minio server in distributed mode with 8 nodes. Note that the numberOfNodes value should be an integer between 4 and 16 (inclusive).

StatefulSet limitations applicable to distributed Minio

• StatefulSets need persistent storage, so the persistence.enabled flag is ignored when mode is set to distributed.
• When uninstalling a distributed Minio release, you'll need to manually delete volumes associated with the StatefulSet.

Shared Minio

To provision Minio servers in shared mode, set the mode field to shared,

$ helm install --set mode=shared stable/minio

This provisions 4 Minio server nodes backed by single storage. To change the number of nodes in your shared Minio deployment, set the numberOfNodes field,

$ helm install --set mode=shared,numberOfNodes=8 stable/minio

This provisions Minio server in shared mode with 8 nodes.

Persistence

This chart provisions a PersistentVolumeClaim and mounts corresponding persistent volume to default location /export. You'll need physical storage available in the Kubernetes cluster for this to work. If you'd rather use emptyDir, disable PersistentVolumeClaim by:

$ helm install --set persistence.enabled=false stable/minio

"An emptyDir volume is first created when a Pod is assigned to a Node, and exists as long as that Pod is running on that node. When a Pod is removed from a node for any reason, the data in the emptyDir is deleted forever."

3. Updating Minio Release using Helm

You can update an existing Minio Helm Release to use a newer Minio Docker image. To do this, use the helm upgrade command:

$ helm upgrade --set imageTag=<replace-with-minio-docker-image-tag> <helm-release-name> stable/minio

On successful update, you should see the output below

Release "your-helm-release" has been upgraded. Happy Helming!

4. Uninstalling the Chart

Assuming your release is named as my-release, delete it using the command:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Notes

• An instance of a chart running in a Kubernetes cluster is called a release. Helm automatically assigns a unique release name after installing the chart. You can also set your preferred name by:

$ helm install --name my-release stable/minio

• To override the default keys, pass the access and secret keys as arguments to helm install.

$ helm install --set accessKey=myaccesskey,secretKey=mysecretkey \
    stable/minio

Explore Further

• Minio Erasure Code QuickStart Guide
• Kubernetes Documentation
• Helm package manager for kubernetes