github/deprecated-helm-charts
1
0
Fork 0
mirror of https://github.com/helm/charts.git synced 2026-08-23 22:37:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

minio: Added configuration options and updated README (#348)

Browse Source 
* Image tag details updated

* Updated README and added new configurations

* Added service type specific notes

* Send configPath flag only if its present

* Updated notes.txt

* Added distributed Minio support.

* Fix documentation

* Fix documentation

* Fix documentation

* Fix documentation

* Added loop in configMap

* Updated storage class annotation

* Changed the default service type to LoadBalancer

* Use .Values.resources for cpu and memory
This commit is contained in:
Nitish Tiwari
2017-01-11 18:42:19 -08:00
committed by Vic Iglesias
parent f9265b0169
commit 70811f1f37
10 changed files with 282 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files
stable/minio/Chart.yaml
+3 -1
View File
@@ -1,7 +1,7 @@
apiVersion: v1
description: A Minio Helm chart for Kubernetes
name: minio
version: 0.0.1
version: 0.0.2
keywords:
- storage
- object-storage
@@ -12,3 +12,5 @@ sources:
maintainers:
- name: Acaleph
email: hello@acale.ph
- name: Minio
email: hello@minio.io
stable/minio/README.md
+71 -31
View File
@@ -1,36 +1,54 @@
Minio
=====
[Minio](https://minio.io) is a distributed S3-compatible object storage server built for cloud applications and devops.
[Minio](https://minio.io) is a lightweight, AWS S3 compatible object storage server. It is best suited for storing unstructured data such as photos, videos, log files, backups, VM and container images. Size of an object can range from a few KBs to a maximum of 5TB. Minio server is light enough to be bundled with the application stack, similar to NodeJS, Redis and MySQL.
Minio supports [distributed mode](https://docs.minio.io/docs/distributed-minio-quickstart-guide). In distributed mode, you can pool multiple drives (even on different machines) into a single object storage server.
Introduction
------------
This chart bootstraps a single node Minio deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
This chart bootstraps Minio deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
Prerequisites
-------------
- Kubernetes 1.4+ with Beta APIs enabled
- PV provisioner support in the underlying infrastructure
- Kubernetes 1.4+ with Beta APIs enabled for default standalone mode.
- Kubernetes 1.5+ with Beta APIs enabled to run Minio in [distributed mode](#distributed-minio).
- PV provisioner support in the underlying infrastructure.
Installing the Chart
--------------------
To install the chart with the release name `my-release`:
Install this chart using:
```bash
$ helm install stable/minio
```
The command deploys Minio on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
### Release name
An instance of a chart running in a Kubernetes cluster is called a release. Each release is identified by a unique name within the cluster. Helm automatically assigns a unique release name after installing the chart. You can also set your preferred name by:
```bash
$ helm install --name my-release stable/minio
```
The command deploys Minio on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
### Access and Secret keys
By default a pre-generated Access Key and Secret will be used. If you'd like to set your own password change the AccessKey and SecretKey in the values.yaml.
By default a pre-generated access and secret key will be used. To override the default keys, pass the access and secret keys as arguments to helm install.
```bash
$ helm install --set accessKey=myaccesskey,secretKey=mysecretkey \
stable/minio
```
Uninstalling the Chart
----------------------
To uninstall/delete the `my-release` deployment:
Assuming your release is named as `my-release`, delete it using the command:
```bash
$ helm delete my-release
@@ -45,32 +63,36 @@ The following tables lists the configurable parameters of the Minio chart and th
| Parameter | Description | Default |
|----------------------------|-------------------------------------|---------------------------------------------------------|
| `image` | `minio` image. | `minio/minio` The official release on Docker Hub |
| `imageTag` | `minio` image tag. | The latest release |
| `imagePullPolicy` | Image pull policy | `Always` if `imageTag` is `latest`, else `IfNotPresent` |
| `ServiceType` | Kubernetes Service Type | `ClusterIP` |
| `ServicePort` | Kuberntes Service Port | `9000` |
| `AccessKey` | Default Access Key | `AKIAIOSFODNN7EXAMPLE` |
| `SecretKey` | Default Secret Key | `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY` |
| `persistence.enabled` | Create a volume to store data | true |
| `persistence.size` | Size of persistent volume claim | 8Gi RW |
| `persistence.storageClass` | Type of persistent volume claim | generic |
| `persistence.accessMode` | ReadWriteOnce or ReadOnly | ReadWriteOnce |
| `image` | Minio image name | `minio/minio` |
| `imageTag` | Minio image tag. Possible values listed [here](https://hub.docker.com/r/minio/minio/tags/).| `latest`|
| `imagePullPolicy` | Image pull policy | `Always` |
| `mode` | Minio server mode (`standalone` 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` |
Some of the parameters above map to the env variables defined in the [Minio DockerHub image](https://hub.docker.com/r/minio/minio/).
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
You can specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
```bash
$ helm install --name my-release \
--set AccessKey=myaccesskey,SecretKey=mysecretkey \
--set persistence.size=100Gi \
stable/minio
```
The above command sets the Minio Access Key to `myaccesskey` and Secret Key to `mysecretkey`.
The above command deploys Minio server with a 100Gi backing persistent volume.
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
Alternately, you can provide a YAML file that specifies parameter values while installing the chart. For example,
```bash
$ helm install --name my-release -f values.yaml stable/minio
@@ -78,17 +100,35 @@ $ helm install --name my-release -f values.yaml stable/minio
> **Tip**: You can use the default [values.yaml](values.yaml)
Distributed Minio
-----------
This chart provisions a Minio server in standalone mode, by default. To provision Minio server in [distributed mode](https://docs.minio.io/docs/distributed-minio-quickstart-guide), set the `mode` field to `distributed`,
```bash
$ 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,
```bash
$ 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](http://kubernetes.io/docs/concepts/abstractions/controllers/statefulsets/#limitations) applicable to distributed Minio
1. StatefulSets need persistent storage, so the `persistence.enabled` flag is ignored when `mode` is set to `distributed`.
2. When uninstalling a distributed Minio release, you'll need to manually delete volumes associated with the StatefulSet.
Persistence
-----------
The [Minio](https://hub.docker.com/r/minio/minio/) image stores the Minio data at the `/export` path of the container.
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:
By default a PersistentVolumeClaim is created and mounted into that directory. In order to disable this functionality you can change the values.yaml to disable persistence and use an emptyDir instead.
```bash
$ 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."*
TODO:
-----
- Erasure encoding and distributed server
- Configmap for the Minio config
stable/minio/templates/NOTES.txt
+30 -6
View File
@@ -1,14 +1,38 @@
Minio can be accessed via port {{ .Values.ServicePort }} on the following DNS name from within your cluster:
{{- if eq .Values.serviceType "ClusterIP" }}
Minio can be accessed via port {{ .Values.servicePort }} on the following DNS name from within your cluster:
{{ template "fullname" . }}.{{ .Release.Namespace }}.svc.cluster.local
To connect to minio:
To access Minio from localhost, run the below commands:
1. export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app={{ template "fullname" . }}" -o jsonpath="{.items[0].metadata.name}")
2. kubectl port-forward $POD_NAME 9000 --namespace {{ .Release.Namespace }}
Read more about port forwarding here: http://kubernetes.io/docs/user-guide/kubectl/kubectl_port-forward/
You can now access Minio server on http://localhost:9000. Follow the below steps to connect to Minio server with mc client:
1. Download the Minio mc client - https://docs.minio.io/docs/minio-client-quickstart-guide
2. export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app={{ template "fullname" . }}" -o jsonpath="{.items[0].metadata.name}")
2. mc config host add {{ template "fullname" . }}-local http://localhost:9000 {{ .Values.accessKey }} {{ .Values.secretKey }} S3v4
3. kubectl port-forward $POD_NAME 9000 --namespace {{ .Release.Namespace }}
3. mc ls {{ template "fullname" . }}-local
4. mc config host add {{ template "fullname" . }}-local http://localhost:9000 {{ .Values.AccessKey }} {{ .Values.SecretKey }} S3v4
Alternately, you can use your browser or the Minio SDK to access the server - https://docs.minio.io/categories/17
{{- end }}
{{- if eq .Values.serviceType "LoadBalancer" }}
Minio can be accessed via port {{ .Values.servicePort }} on an external IP address. Get the service external IP address by:
kubectl get svc --namespace {{ .Release.Namespace }} -l app={{ template "fullname" . }}
5. mc ls {{ template "fullname" . }}-local
Note that the public IP may take a couple of minutes to be available.
You can now access Minio server on http://<External-IP>:9000. Follow the below steps to connect to Minio server with mc client:
1. Download the Minio mc client - https://docs.minio.io/docs/minio-client-quickstart-guide
2. mc config host add {{ template "fullname" . }}-local http://<External-IP>:{{ .Values.servicePort }} {{ .Values.accessKey }} {{ .Values.secretKey }} S3v4
3. mc ls {{ template "fullname" . }}-local
Alternately, you can use your browser or the Minio SDK to access the server - https://docs.minio.io/categories/17
{{- end }}
stable/minio/templates/minio_configmap.yaml
+23
View File
@@ -0,0 +1,23 @@
{{- if eq .Values.mode "distributed" }}
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ template "fullname" . }}-cm
labels:
app: {{ template "fullname" . }}
chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
release: "{{ .Release.Name }}"
heritage: "{{ .Release.Service }}"
{{ $nodeCount := .Values.replicas | int }}
data:
start.sh: |
#!/bin/sh
{{- if .Values.configPath }}
minio -C {{ .Values.configPath }} server \
{{- else }}
minio server \
{{- end }}
{{- range $i := until $nodeCount }}
http://{{ template "fullname" $ }}-{{$i}}.{{ template "fullname" $ }}.{{ $.Release.Namespace }}.svc.cluster.local{{ $.Values.mountPath }} \
{{- end }}
{{- end }}
stable/minio/templates/minio_deployment.yaml
+11 -7
View File
@@ -1,3 +1,4 @@
{{- if eq .Values.mode "standalone" }}
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
@@ -8,7 +9,6 @@ metadata:
release: "{{ .Release.Name }}"
heritage: "{{ .Release.Service }}"
spec:
replicas: 1
selector:
matchLabels:
app: {{ template "fullname" . }}
@@ -34,14 +34,17 @@ spec:
secretName: {{ template "fullname" . }}-user
containers:
- name: minio
image: {{ .Values.Image }}:{{ .Values.ImageTag }}
imagePullPolicy: {{ .Values.ImagePullPolicy }}
args:
- server
- /export
image: {{ .Values.image }}:{{ .Values.imageTag }}
imagePullPolicy: {{ .Values.imagePullPolicy }}
command: ["minio"]
{{- if .Values.configPath }}
args: ["-C", "{{ .Values.configPath }}", "server", "{{ .Values.mountPath }}"]
{{- else }}
args: ["server", "{{ .Values.mountPath }}"]
{{- end }}
volumeMounts:
- name: export
mountPath: /export
mountPath: {{ .Values.mountPath }}
ports:
- name: service
containerPort: 9000
@@ -62,3 +65,4 @@ spec:
timeoutSeconds: 1
resources:
{{ toYaml .Values.resources | indent 12 }}
{{- end }}
stable/minio/templates/minio_pvc.yaml
+7 -1
View File
@@ -1,10 +1,15 @@
{{- if eq .Values.mode "standalone" }}
{{- if .Values.persistence.enabled }}
kind: PersistentVolumeClaim
apiVersion: v1
metadata:
name: {{ template "fullname" . }}
annotations:
volume.alpha.kubernetes.io/storage-class: {{ .Values.persistence.storageClass | quote }}
{{- if .Values.persistence.storageClass }}
volume.beta.kubernetes.io/storage-class: {{ .Values.persistence.storageClass | quote }}
{{- else }}
volume.alpha.kubernetes.io/storage-class: default
{{- end }}
spec:
accessModes:
- {{ .Values.persistence.accessMode | quote }}
@@ -12,3 +17,4 @@ spec:
requests:
storage: {{ .Values.persistence.size | quote }}
{{- end }}
{{- end }}
stable/minio/templates/minio_secret.yaml
+2 -2
View File
@@ -9,5 +9,5 @@ metadata:
heritage: "{{ .Release.Service }}"
type: Opaque
data:
accesskey: {{ .Values.AccessKey | b64enc }}
secretkey: {{ .Values.SecretKey | b64enc }}
accesskey: {{ .Values.accessKey | b64enc }}
secretkey: {{ .Values.secretKey | b64enc }}
stable/minio/templates/minio_statefulset.yaml
+95
View File
@@ -0,0 +1,95 @@
{{- if eq .Values.mode "distributed" }}
apiVersion: v1
kind: Service
metadata:
name: {{ template "fullname" . }}
labels:
app: {{ template "fullname" . }}
chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
release: "{{ .Release.Name }}"
heritage: "{{ .Release.Service }}"
spec:
clusterIP: None
ports:
- name: service
port: 9000
targetPort: {{ .Values.servicePort }}
protocol: TCP
selector:
app: {{ template "fullname" . }}
---
apiVersion: apps/v1beta1
kind: StatefulSet
metadata:
name: {{ template "fullname" . }}
labels:
app: {{ template "fullname" . }}
chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
release: "{{ .Release.Name }}"
heritage: "{{ .Release.Service }}"
spec:
serviceName: {{ template "fullname" . }}
replicas: {{ .Values.replicas }}
selector:
matchLabels:
app: {{ template "fullname" . }}
template:
metadata:
name: {{ template "fullname" . }}
labels:
app: {{ template "fullname" . }}
chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
release: "{{ .Release.Name }}"
heritage: "{{ .Release.Service }}"
spec:
volumes:
- name: minio-user
secret:
secretName: {{ template "fullname" . }}-user
- name: minio-configmap
configMap:
name: {{ template "fullname" . }}-cm
containers:
- name: minio
image: {{ .Values.image }}:{{ .Values.imageTag }}
imagePullPolicy: {{ .Values.imagePullPolicy }}
command:
- /bin/sh
- /go/bin/start.sh
volumeMounts:
- name: export
mountPath: {{ .Values.mountPath }}
- name: minio-configmap
mountPath: /go/bin/start.sh
subPath: start.sh
ports:
- name: service
containerPort: 9000
env:
- name: MINIO_ACCESS_KEY
valueFrom:
secretKeyRef:
name: {{ template "fullname" . }}-user
key: accesskey
- name: MINIO_SECRET_KEY
valueFrom:
secretKeyRef:
name: {{ template "fullname" . }}-user
key: secretkey
resources:
{{ toYaml .Values.resources | indent 12 }}
volumeClaimTemplates:
- metadata:
name: export
annotations:
{{- if .Values.persistence.storageClass }}
volume.beta.kubernetes.io/storage-class: {{ .Values.persistence.storageClass }}
{{- else }}
volume.alpha.kubernetes.io/storage-class: default
{{- end }}
spec:
accessModes: [ {{ .Values.persistence.accessMode | quote }} ]
resources:
requests:
storage: {{ .Values.persistence.size }}
{{- end }}
stable/minio/templates/minio_svc.yaml
+7 -2
View File
@@ -1,16 +1,21 @@
kind: Service
apiVersion: v1
metadata:
name: {{ template "fullname" . }}
name: {{ template "fullname" . }}-svc
labels:
app: {{ template "fullname" . }}
chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
release: "{{ .Release.Name }}"
heritage: "{{ .Release.Service }}"
spec:
type: {{ .Values.serviceType }}
{{- if eq .Values.serviceType "LoadBalancer" }}
loadBalancerIP: {{ default "" .Values.minioLoadBalancerIP }}
{{- end }}
selector:
app: {{ template "fullname" . }}
ports:
- name: service
port: 9000
targetPort: {{ .Values.ServicePort }}
targetPort: {{ .Values.servicePort }}
protocol: TCP
stable/minio/values.yaml
+33 -11
View File
@@ -1,23 +1,45 @@
## Set default image, imageTag, and imagePullPolicy. mode is used to indicate the
## minio server mode, i.e. standalone or distributed.
## Distributed Minio ref: https://docs.minio.io/docs/distributed-minio-quickstart-guide
##
image: "minio/minio"
imageTag: "latest"
imagePullPolicy: "Always"
mode: "standalone"
Image: "minio/minio"
ImageTag: "latest"
ImagePullPolicy: "Always"
## Set default accesskey, secretkey, Minio config file path, volume mount path and
## number of nodes (only used for Minio distributed mode)
## Distributed Minio ref: https://docs.minio.io/docs/distributed-minio-quickstart-guide
##
accessKey: "AKIAIOSFODNN7EXAMPLE"
secretKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
configPath: ""
mountPath: "/export"
replicas: 4
ServiceType: ClusterIP
ServicePort: 9000
## Set default access key and secret
AccessKey: "AKIAIOSFODNN7EXAMPLE"
SecretKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
## loadBalancerIP for the Minio Service (optional, cloud specific)
## ref: http://kubernetes.io/docs/user-guide/services/#type-loadbalancer
##
# minioLoadBalancerIP:
## Enable persistence using Persistent Volume Claims
## ref: http://kubernetes.io/docs/user-guide/persistent-volumes/
##
persistence:
enabled: true
storageClass: generic
## If defined, volume.beta.kubernetes.io/storage-class: <storageClass>
## Default: volume.alpha.kubernetes.io/storage-class: default
##
# storageClass: <storageClass>
accessMode: ReadWriteOnce
size: 8Gi
size: 10Gi
## Expose the Minio service to be accessed from outside the cluster (LoadBalancer service).
## or access it from within the cluster (ClusterIP service). Set the service type and the port to serve it.
## ref: http://kubernetes.io/docs/user-guide/services/
##
serviceType: LoadBalancer
servicePort: 9000
## Configure resource requests and limits
## ref: http://kubernetes.io/docs/user-guide/compute-resources/