Prerequisites

• An existing Kubernetes deployment whereat least one Worker Node has a locally-attached drive.

• A localkubectl installation configured to create and access resources on the target Kubernetes deployment.

• Familiarity with Kubernetes environments

• Familiarity with using a Terminal or Shell environment

Procedure

1. Download the MinIO Object

   Download the MinIO Kubernetes Object Definition

   Downloadminio-dev.yaml to your host machine:

   curlhttps://raw.githubusercontent.com/minio/docs/master/source/extra/examples/minio-dev.yaml-O

   The file describes two Kubernetes resources:

   • A new namespaceminio-dev, and

   • A MinIO pod using a drive or volume on the Worker Node for serving data

   Select theOverview of the MinIO Object YAML for a more detailed description of the object.

   Overview of the MinIO Object YAML

   Theminio-dev.yaml contains the following Kubernetes resources:

   # Deploys a new Namespace for the MinIO PodapiVersion:v1kind:Namespacemetadata:name:minio-dev# Change this value if you want a different namespace namelabels:name:minio-dev# Change this value to match metadata.name---# Deploys a new MinIO Pod into the metadata.namespace Kubernetes namespace## The `spec.containers[0].args` contains the command run on the pod# The `/data` directory corresponds to the `spec.containers[0].volumeMounts[0].mountPath`# That mount path corresponds to a Kubernetes HostPath which binds `/data` to a local drive or volume on the worker node where the pod runs#apiVersion:v1kind:Podmetadata:labels:app:minioname:minionamespace:minio-dev# Change this value to match the namespace metadata.namespec:containers:-name:minioimage:quay.io/minio/minio:latestcommand:-/bin/bash--cargs:-minio server /data --console-address :9001volumeMounts:-mountPath:/dataname:localvolume# Corresponds to the `spec.volumes` Persistent VolumenodeSelector:kubernetes.io/hostname:kubealpha.local# Specify a node label associated to the Worker Node on which you want to deploy the pod.volumes:-name:localvolumehostPath:# MinIO generally recommends using locally-attached volumespath:/mnt/disk1/data# Specify a path to a local drive or volume on the Kubernetes worker nodetype:DirectoryOrCreate# The path to the last directory must exist

   The object deploys two resources:

   • A new namespaceminio-dev, and

   • A MinIO pod using a drive or volume on the Worker Node for serving data

   The MinIO resource definition uses KubernetesNode Selectors and Labels to restrict the pod to a node with matching hostname label.Usekubectlgetnodes--show-labels to view all labels assigned to each node in the cluster.

   The MinIO Pod uses ahostPath volume for storing data. This pathmust correspond to a local drive or folder on the Kubernetes worker node.

   Users familiar with Kubernetes scheduling and volume provisioning may modify thespec.nodeSelector,volumeMounts.name, andvolumes fields to meet more specific requirements.

2. Apply the MinIO Object Definition

   The following command applies theminio-dev.yaml configuration and deploys the objects to Kubernetes:

   kubectlapply-fminio-dev.yaml

   The command output should resemble the following:

   namespace/minio-devcreatedpod/miniocreated

   You can verify the state of the pod by runningkubectlgetpods:

   kubectlgetpods-nminio-dev

   The output should resemble the following:

   NAMEREADYSTATUSRESTARTSAGEminio1/1Running077s

   You can also use the following commands to retrieve detailed information on the pod status:

   kubectldescribepod/minio-nminio-devkubectllogspod/minio-nminio-dev

3. Temporarily Access the MinIO S3 API and Console

   Use thekubectlport-forward command to temporarily forward traffic from the MinIO pod to the local machine:

   kubectlport-forwardpod/minio90009090-nminio-dev

   The command forwards the pod ports9000 and9090 to the matching port on the local machine while active in the shell.Thekubectlport-forward command only functions while active in the shell session.Terminating the session closes the ports on the local machine.

   Note

   The following steps of this procedure assume an activekubectlport-forward command.

   To configure long term access to the pod, configureIngress or similar network control components within Kubernetes to route traffic to and from the pod. Configuring Ingress is out of the scope for this documentation.

4. Connect your Browser to the MinIO Server

   Access theMinIO Console by opening a browser on the local machine and navigating tohttp://127.0.0.1:9001.

   Log in to the Console with the credentialsminioadmin|minioadmin.These are the defaultroot user credentials.

   

   You can use the MinIO Console for general administration tasks like Identity and Access Management, Metrics and Log Monitoring, or Server Configuration.Each MinIO server includes its own embedded MinIO Console.

   

   For more information, see theMinIO Console documentation.

5. (Optional) Connect the MinIO Client

   If your local machine hasmcinstalled, use themcaliasset command to authenticate and connect to the MinIO deployment:

   mcaliassetk8s-minio-devhttp://127.0.0.1:9000minioadminminioadminmcadmininfok8s-minio-dev

   • The name of the alias

   • The hostname or IP address and port of the MinIO server

   • The Access Key for a MinIOuser

   • The Secret Key for a MinIOuser

Next Steps

• Connect your applications to MinIO

• Configure Object Retention

• Configure Security

• Deploy MinIO for Production Environments