From bd8778069d495fbefdfe955e9f498b1d43885d21 Mon Sep 17 00:00:00 2001 From: Jan Safranek Date: Fri, 4 Nov 2016 13:41:45 +0100 Subject: [PATCH] Add documentation about Quobyte dynamic provisioning --- docs/user-guide/persistent-volumes/index.md | 32 +++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/docs/user-guide/persistent-volumes/index.md b/docs/user-guide/persistent-volumes/index.md index 31f942ad58..082722a829 100644 --- a/docs/user-guide/persistent-volumes/index.md +++ b/docs/user-guide/persistent-volumes/index.md @@ -448,6 +448,38 @@ parameters: $ kubectl create secret ceph-secret --type="kubernetes.io/rbd" --from-literal=key='QVFEQ1pMdFhPUnQrSmhBQUFYaERWNHJsZ3BsMmNjcDR6RFZST0E9PQ==' --namespace=kube-system ``` +#### Quobyte + +```yaml +apiVersion: storage.k8s.io/v1beta1 +kind: StorageClass +metadata: + name: slow +provisioner: kubernetes.io/quobyte +parameters: + quobyteAPIServer: "http://138.68.74.142:7860" + registry: "138.68.74.142:7861" + adminSecretName: "quobyte-admin-secret" + adminSecretNamespace: "kube-system" + user: "root" + group: "root" + quobyteConfig: "BASE" + quobyteTenant: "DEFAULT" +``` + +* `quobyteAPIServer`: API Server of Quobyte in the format `http(s)://api-server:7860` +* `registry`: Quobyte registry to use to mount the volume. You can specifiy the registry as ``:`` pair or if you want to specify multiple registries you just have to put a comma between them e.q. ``:,:,:``. The host can be an IP address or if you have a working DNS you can also provide the DNS names. +* `adminSecretNamespace`: The namespace for `adminSecretName`. Default is "default". +* `adminSecretName`: secret that holds information about the Quobyte user and the password to authenticate agains the API server. The provided secret must have type "kubernetes.io/quobyte", e.g. created in this way: + ``` + $ kubectl create secret quobyte-admin-secret --type="kubernetes.io/quobyte" --from-literal=key='opensesame' --namespace=kube-system + ``` +* `user`: maps all access to this user. Default is "root". +* `group`: maps all access to this group. Default is "nfsnobody". +* `quobyteConfig`: use the specified configuration to create the volume. You can create a new configuration or modify an existing one with the Web console or the quobyte CLI. Default is "BASE". +* `quobyteTenant`: use the specified tenant ID to create/delete the volume. This Quobyte tenant has to be already present in Quobyte. Default is "DEFAULT". + + ## Writing Portable Configuration If you're writing configuration templates or examples that run on a wide range of clusters