From eca12c127d4bc0e3e447e0a1408724037b405080 Mon Sep 17 00:00:00 2001 From: Jan Safranek Date: Thu, 21 Mar 2019 14:28:21 +0100 Subject: [PATCH] Fifth round --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7df31f9f7..0cdd36c1e 100644 --- a/README.md +++ b/README.md @@ -17,14 +17,14 @@ This information reflects the head of this branch. ## Feature status -Various external-provisioner releases come with different alpha / beta features. Alpha features are disabled by default and must be explicitly enabled on command line. Beta features are enabled by default and can be disabled on command line. Check `--help` output for alpha/beta features in each release. +Various external-provisioner releases come with different alpha / beta features. Check `--help` output for alpha/beta features in each release. Following table reflects the head of this branch. -| Feature | Status | Default | Description | -| ---------- | ------- | ------- | -------------------------------------------------------------------------------------------- | -| Topology | Beta | On | [Topology aware dynamic provisioning](https://kubernetes-csi.github.io/docs/topology.html) | -| Snapshots* | Alpha | On | [Snapshots and Restore](https://kubernetes-csi.github.io/docs/snapshot-restore-feature.html) | +| Feature | Status | Default | Description | +| ---------- | ------- | ------- | --------------------------------------------------------------------------------------------- | +| Topology | Beta | On | [Topology aware dynamic provisioning](https://kubernetes-csi.github.io/docs/topology.html) (requires kubelet 1.14 on nodes). | +| Snapshots* | Alpha | On | [Snapshots and Restore](https://kubernetes-csi.github.io/docs/snapshot-restore-feature.html). | *) There is no special feature gate for snapshots, it is enabled by running [external-snapshotter](https://github.com/kubernetes-csi/external-snapshotter/) and creating its CRDs. @@ -44,21 +44,21 @@ Note that the external-provisioner does not scale with more replicas. Only one e ### Command line options -#### Important optional arguments that are highly recommended to be used +#### Recommended optional arguments" * `--csi-address `: This is the path to the CSI driver socket inside the pod that the external-provisioner container will use to issue CSI operations (`/run/csi/socket` is used by default). -* `--enable-leader-election`: Enables leader election. This is useful when there are multiple replicas of the same external-provisioner running for one CSI driver. Only one of them may be active (=leader). A new leader will be re-elected when current leader dies or becomes unresponsive for ~15 seconds. +* `--enable-leader-election`: Enables leader election. This is mandatory when there are multiple replicas of the same external-provisioner running for one CSI driver. Only one of them may be active (=leader). A new leader will be re-elected when current leader dies or becomes unresponsive for ~15 seconds. * `--timeout `: Timeout of all calls to CSI driver. It should be set to value that accommodates majority of `ControllerCreateVolume` and `ControllerDeleteVolume` calls. See [CSI error and timeout handling](#csi-error-and-timeout-handling) for details. 15 seconds is used by default. -* `--retry-interval-start ` - Initial retry interval of failed provisioning or deletion. It doubles with each failure, up to `--retry-interval-max` and then it stops increasing. Default value is 1 second. [CSI error and timeout handling](#csi-error-and-timeout-handling) for details. +* `--retry-interval-start ` - Initial retry interval of failed provisioning or deletion. It doubles with each failure, up to `--retry-interval-max` and then it stops increasing. Default value is 1 second. See [CSI error and timeout handling](#csi-error-and-timeout-handling) for details. -* `--retry-interval-max ` - Maximum retry interval of failed provisioning or deletion. See [CSI error and timeout handling](#csi-error-and-timeout-handling) for details. +* `--retry-interval-max ` - Maximum retry interval of failed provisioning or deletion. Default value is 5 minutes. See [CSI error and timeout handling](#csi-error-and-timeout-handling) for details. * `--worker-threads `: Number of simultaneously running `ControllerCreateVolume` and `ControllerDeleteVolume` operations. Default value is `100`. #### Other recognized arguments -* `--feature-gates `: A set of comma separated `=` pairs that describe feature gates for alpha/experimental features. See [list of features](#feature-status) or `--help` output for list of recognized features. Example: `--feature-gates Topology=true`. +* `--feature-gates `: A set of comma separated `=` pairs that describe feature gates for alpha/experimental features. See [list of features](#feature-status) or `--help` output for list of recognized features. Example: `--feature-gates Topology=false` to disable Topology feature that's enabled by default. * `--kubeconfig `: Path to Kubernetes client configuration that the external-provisioner uses to connect to Kubernetes API server. When omitted, default token provided by Kubernetes will be used. This option is useful only when the external-provisioner does not run as a Kubernetes pod, e.g. for debugging. Either this or `--master` needs to be set if the external-provisioner is being run out of cluster.