docs: Add Minikube deployment to k8s docs (#4133)
parent
2b96d9f706
commit
ebf4c447bb
@ -0,0 +1,47 @@ |
||||
# Deploy distributed Minio locally with minikube [![Slack](https://slack.minio.io/slack?type=svg)](https://slack.minio.io) [![Go Report Card](https://goreportcard.com/badge/minio/minio)](https://goreportcard.com/report/minio/minio) [![Docker Pulls](https://img.shields.io/docker/pulls/minio/minio.svg?maxAge=604800)](https://hub.docker.com/r/minio/minio/) [![codecov](https://codecov.io/gh/minio/minio/branch/master/graph/badge.svg)](https://codecov.io/gh/minio/minio) |
||||
|
||||
Minikube runs a single-node Kubernetes cluster inside a VM on your computer. This makes it easy to deploy distributed Minio server on |
||||
Kubernetes running locally on your computer. |
||||
|
||||
## 1. Prerequisites |
||||
|
||||
[Minikube](https://github.com/kubernetes/minikube/blob/master/README.md#installation) and [`kubectl`](https://kubernetes.io/docs/user-guide/prereqs/) |
||||
installed on your system. |
||||
|
||||
## 2. Steps |
||||
|
||||
* Download `minio_distributed.sh` and `statefulset.yaml` |
||||
|
||||
```sh |
||||
wget https://raw.githubusercontent.com/minio/minio/master/docs/orchestration/minikube/minio_distributed.sh |
||||
wget https://raw.githubusercontent.com/minio/minio/master/docs/orchestration/minikube/statefulset.yaml |
||||
``` |
||||
|
||||
* Execute the `minio_distributed.sh` script in command prompt. |
||||
|
||||
```sh |
||||
./minio_distributed.sh |
||||
``` |
||||
|
||||
After the script is executed successfully, you should get an output like this |
||||
|
||||
```sh |
||||
service "minio-public" created |
||||
service "minio" created |
||||
statefulset "minio" created |
||||
``` |
||||
This means Minio is deployed on your local Minikube installation. |
||||
|
||||
Note that the service `minio-public` is a [clusterIP](https://kubernetes.io/docs/user-guide/services/#publishing-services---service-types) service. It exposes the service on a cluster-internal IP. To connect to your Minio instances via `kubectl port-forward` command, execute |
||||
|
||||
``` |
||||
kubectl port-forward minio-0 9000:9000 |
||||
``` |
||||
|
||||
Minio server can now be accessed at `http://localhost:9000`, with accessKey and secretKey as mentioned in the `statefulset.yaml` file. |
||||
|
||||
## 3. Notes |
||||
|
||||
Minikube currently does not support dynamic provisioning, so we manually create PersistentVolumes(PV) and PersistentVolumeClaims(PVC). Once the PVs and PVCs are created, we call the `statefulset.yaml` configuration file to create the distributed Minio setup. |
||||
|
||||
This setup runs on a laptop/computer. Hence only one disk is used as the backend for all the minio instance PVs. Minio sees these PVs as separate disks and reports the available storage incorrectly. |
@ -0,0 +1,58 @@ |
||||
#!/usr/bin/env bash |
||||
|
||||
# Minio Cloud Storage, (C) 2014, 2015, 2016, 2017 Minio, Inc. |
||||
# Licensed under the Apache License, Version 2.0 (the "License"); |
||||
# you may not use this file except in compliance with the License. |
||||
# You may obtain a copy of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, |
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
# See the License for the specific language governing permissions and |
||||
# limitations under the License. |
||||
|
||||
set -exuo pipefail |
||||
|
||||
# Clean up anything from a prior run: |
||||
kubectl delete statefulsets,persistentvolumes,persistentvolumeclaims,services,poddisruptionbudget -l app=minio |
||||
|
||||
# Make persistent volumes and (correctly named) claims. We must create the |
||||
# claims here manually even though that sounds counter-intuitive. For details |
||||
# see https://github.com/kubernetes/contrib/pull/1295#issuecomment-230180894. |
||||
for i in $(seq 0 3); do |
||||
cat <<EOF | kubectl create -f - |
||||
kind: PersistentVolume |
||||
apiVersion: v1 |
||||
metadata: |
||||
name: pv${i} |
||||
labels: |
||||
type: local |
||||
app: minio |
||||
spec: |
||||
capacity: |
||||
storage: 2Gi |
||||
accessModes: |
||||
- ReadWriteOnce |
||||
hostPath: |
||||
path: "/minio/data-store/${i}" |
||||
EOF |
||||
|
||||
cat <<EOF | kubectl create -f - |
||||
kind: PersistentVolumeClaim |
||||
apiVersion: v1 |
||||
metadata: |
||||
name: data-minio-${i} |
||||
labels: |
||||
app: minio |
||||
spec: |
||||
accessModes: |
||||
- ReadWriteOnce |
||||
resources: |
||||
requests: |
||||
storage: 2Gi |
||||
EOF |
||||
done; |
||||
|
||||
kubectl create -f statefulset.yaml |
@ -0,0 +1,81 @@ |
||||
apiVersion: v1 |
||||
kind: Service |
||||
metadata: |
||||
# This service is meant to be used by clients of the object store. It exposes a ClusterIP that will |
||||
# automatically load balance connections to the different database pods. |
||||
name: minio-public |
||||
labels: |
||||
app: minio |
||||
spec: |
||||
ports: |
||||
- port: 9000 |
||||
targetPort: 9000 |
||||
selector: |
||||
app: minio |
||||
--- |
||||
apiVersion: v1 |
||||
kind: Service |
||||
metadata: |
||||
# This service only exists to create DNS entries for each pod in the stateful |
||||
# set such that they can resolve each other's IP addresses. It does not |
||||
# create a load-balanced ClusterIP and should not be used directly by clients |
||||
# in most circumstances. |
||||
name: minio |
||||
labels: |
||||
app: minio |
||||
spec: |
||||
ports: |
||||
- port: 9000 |
||||
targetPort: 9000 |
||||
clusterIP: None |
||||
selector: |
||||
app: minio |
||||
--- |
||||
apiVersion: apps/v1beta1 |
||||
kind: StatefulSet |
||||
metadata: |
||||
name: minio |
||||
spec: |
||||
serviceName: "minio" |
||||
replicas: 4 |
||||
template: |
||||
metadata: |
||||
labels: |
||||
app: minio |
||||
spec: |
||||
volumes: |
||||
- name: data |
||||
persistentVolumeClaim: |
||||
claimName: data-minio |
||||
containers: |
||||
- name: minio |
||||
env: |
||||
- name: MINIO_ACCESS_KEY |
||||
value: "minio" |
||||
- name: MINIO_SECRET_KEY |
||||
value: "minio123" |
||||
image: minio/minio:RELEASE.2017-02-16T01-47-30Z |
||||
imagePullPolicy: IfNotPresent |
||||
#command: ["df"] |
||||
#args: ["-i", "/data"] |
||||
command: ["minio"] |
||||
args: ["server", "http://minio-0.minio.default.svc.cluster.local/data", "http://minio-1.minio.default.svc.cluster.local/data", "http://minio-2.minio.default.svc.cluster.local/data", "http://minio-3.minio.default.svc.cluster.local/data"] |
||||
ports: |
||||
- containerPort: 9000 |
||||
# These volume mounts are persistent. Each pod in the PetSet |
||||
# gets a volume mounted based on this field. |
||||
volumeMounts: |
||||
- name: data |
||||
mountPath: /data |
||||
# These are converted to volume claims by the controller |
||||
# and mounted at the paths mentioned above. |
||||
volumeClaimTemplates: |
||||
- metadata: |
||||
name: data |
||||
annotations: |
||||
volume.alpha.kubernetes.io/storage-class: anything |
||||
spec: |
||||
accessModes: [ "ReadWriteOnce" ] |
||||
resources: |
||||
requests: |
||||
storage: 2Gi |
Loading…
Reference in new issue