Merge pull request #20 from rstudio/connect-public-readme

Connect public readme

charts/rstudio-connect/Chart.yaml

@@ -1,6 +1,6 @@
 name: rstudio-connect
 description: Kubernetes deployment for RStudio Connect
-version: 0.2.0-rc02
+version: 0.2.0-rc03
 apiVersion: v2
 appVersion: 1.9.0
 icon: https://rstudio.com/wp-content/uploads/2018/10/RStudio-Logo-Flat.png

charts/rstudio-connect/README.md

@@ -2,7 +2,7 @@
 
 Kubernetes deployment for RStudio Connect
 
-![Version: 0.2.0-rc02](https://img.shields.io/badge/Version-0.2.0--rc02-informational?style=flat-square) ![AppVersion: 1.9.0](https://img.shields.io/badge/AppVersion-1.9.0-informational?style=flat-square)
+![Version: 0.2.0-rc03](https://img.shields.io/badge/Version-0.2.0--rc03-informational?style=flat-square) ![AppVersion: 1.9.0](https://img.shields.io/badge/AppVersion-1.9.0-informational?style=flat-square)
 
 ## Disclaimer
 
@@ -20,13 +20,26 @@ changes, as well as documentation below on how to use the chart
 
 ## Installing the Chart
 
-To install the chart with the release name `my-release` at version 0.2.0-rc02:
+To install the chart with the release name `my-release` at version 0.2.0-rc03:
 
 ```bash
 helm repo add rstudio https://helm.rstudio.com
-helm install my-release rstudio/rstudio-connect --version=0.2.0-rc02
+helm install my-release rstudio/rstudio-connect --version=0.2.0-rc03
 ```
 
+## Required Configuration
+
+This chart requires the following in order to function:
+
+* A license key, license file, or address of a running license server. See the `license` configuration below.
+* A Kubernetes [PersistentVolume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) that contains the data directory for Connect.
+  * If `sharedStorage.create` is set, a PVC that relies on the default storage class will be created to generate the PersistentVolume.
+    Most Kubernetes environments do not have a default storage class that you can use with `ReadWriteMany` access mode out-of-the-box.
+    In this case, we recommend you disable `sharedStorage.create` and create your own `PersistentVolume` and `PersistentVolumeClaim`, then
+    mount them into the container by specifying the `pod.volumes` and `pod.volumeMounts` parameters.
+  * If you cannot use a `PersistentVolume` to properly mount your data directory, you'll need to mount your data in the container
+    by using a regular [Kubernetes Volume](https://kubernetes.io/docs/concepts/storage/volumes), specified in `pod.volumes` and `pod.volumeMounts`.
+
 ## General Principles
 
 - In most places, we opt to pass helm values over configmaps. We translate these into the valid `.gcfg` file format

charts/rstudio-connect/README.md.gotmpl

@@ -7,6 +7,19 @@
 
 {{ template "rstudio.install" . }}
 
+## Required Configuration
+
+This chart requires the following in order to function:
+
+* A license key, license file, or address of a running license server. See the `license` configuration below.
+* A Kubernetes [PersistentVolume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) that contains the data directory for Connect.
+  * If `sharedStorage.create` is set, a PVC that relies on the default storage class will be created to generate the PersistentVolume. 
+    Most Kubernetes environments do not have a default storage class that you can use with `ReadWriteMany` access mode out-of-the-box. 
+    In this case, we recommend you disable `sharedStorage.create` and create your own `PersistentVolume` and `PersistentVolumeClaim`, then 
+    mount them into the container by specifying the `pod.volumes` and `pod.volumeMounts` parameters.
+  * If you cannot use a `PersistentVolume` to properly mount your data directory, you'll need to mount your data in the container
+    by using a regular [Kubernetes Volume](https://kubernetes.io/docs/concepts/storage/volumes), specified in `pod.volumes` and `pod.volumeMounts`.
+
 ## General Principles
 
 - In most places, we opt to pass helm values over configmaps. We translate these into the valid `.gcfg` file format