[incubator-openwhisk-deploy-kube] branch master updated: Document expectations for PersistentVolume creation (#245)

[ma...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

markusthoemmes pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk-deploy-kube.git


The following commit(s) were added to refs/heads/master by this push:
     new 40a45ce  Document expectations for PersistentVolume creation (#245)
40a45ce is described below

commit 40a45ced2cdc259ecefe1921d8097861fe241cff
Author: David Grove <dg...@users.noreply.github.com>
AuthorDate: Wed Jul 18 10:49:54 2018 -0400

    Document expectations for PersistentVolume creation (#245)
    
    Fixes #244.
---
 README.md                    | 3 ++-
 docs/configurationChoices.md | 9 +++++++--
 2 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 1e83747..e32f30c 100644
--- a/README.md
+++ b/README.md
@@ -39,8 +39,9 @@ This repository can be used to deploy OpenWhisk to a Kubernetes cluster.
 ### Requirements
 
 Several requirements must be met for OpenWhisk to deploy on Kubernetes.
-* [Kubernetes](https://github.com/kubernetes/kubernetes) version 1.8+. However, multiple minor releases of Kubernetes, including 1.8.9 and 1.9.4 will not work for OpenWhisk due to bugs with volume mount subpaths (see[[1](https://github.com/kubernetes/kubernetes/issues/61076)]. This bug will surface as a failure when deploying the nginx container.
+* [Kubernetes](https://github.com/kubernetes/kubernetes) version 1.8+. However, multiple minor releases of Kubernetes, including 1.8.9 and 1.9.4 will not work for OpenWhisk due to bugs with volume mount subpaths (see[[kubernetes-61076](https://github.com/kubernetes/kubernetes/issues/61076)]). This bug will surface as a failure when deploying the nginx container.
 * The ability to create Ingresses to make a Kubernetes service available outside of the cluster so you can actually use OpenWhisk.
+* If you enable persistence (see [docs/configurationChoices.md](./docs/configurationChoices.md)), either your cluster is configured to support [Dynamic Volume Provision](https://kubernetes.io/docs/concepts/storage/dynamic-provisioning/) or you must manually create any necessary PersistentVolumes when deploying the Helm chart.
 * Endpoints of Kubernetes services must be able to loopback to themselves (the kubelet's `hairpin-mode` must not be `none`).
 
 ### Using Minikube
diff --git a/docs/configurationChoices.md b/docs/configurationChoices.md
index db8bfe4..30eed7c 100644
--- a/docs/configurationChoices.md
+++ b/docs/configurationChoices.md
@@ -86,12 +86,17 @@ redis:
     size: 256Mi
     storageClass: default
 ```
+If you are deploying to `minikube`, use the storageClass `standard`.
 If you are deploying on a managed Kubernetes cluster, check the cloud
 provider's documentation to determine the appropriate `storageClass`
 and `size` to request.
 
-*Limitation* Currently the persistent volume support assumes that the
-`replicaCount` of the deployment using the persistent volume is 1.
+Note that the Helm charts do not explicitly create the
+PersistentVolumes to satisfy the PersistentVolumeClaims they
+instantiate. We assume that either your cluster is configured to
+support [Dynamic Volume Provision](https://kubernetes.io/docs/concepts/storage/dynamic-provisioning/)
+or that you will manually create any necessary PersistentVolumes when
+deploying the Helm chart.
 
 ### Invoker Container Factory