Add in licensing README changes

rstudio · Oct 24, 2023 · 7d1e3ac · 7d1e3ac
1 parent 64bcbe9
commit 7d1e3ac
Show file tree

Hide file tree

Showing 3 changed files with 103 additions and 4 deletions.
diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md
@@ -54,7 +54,7 @@ helm search repo rstudio/rstudio-connect -l
 
 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 license file, license key, or address of a running license server. See the [Licensing](#licensing) section below for more details.
 * 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.
@@ -63,6 +63,39 @@ This chart requires the following in order to function:
   * 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`.
 
+## Licensing
+
+This chart supports activating the product using a license file, license key, or license server. In the case of a license file or key, we recommend against placing it in your values file directly.
+
+### License File
+
+We recommend storing a license file as a `Secret` and setting the `license.file.secret` and `license.file.secretKey` values accordingly.
+
+First, create the secret using YAML or imperatively using the following command (replace `licenses/connect.lic` with the path and name of your license file):
+
+```bash
+kubectl create secret generic connect-license --from-file=licenses/connect.lic
+```
+
+Second, specify the following values:
+
+```yaml
+license:
+  file:
+    secret: connect-license
+    secretKey: connect.lic
+```
+
+Alternatively, license files can be set directly in your values file or during `helm install` with `--set-file license.file.contents=license_files/connect.lic`.
+
+### License Key
+
+Set a license key directly in your values file (`license.key`) or during `helm install` with `--set license.key=XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX`.
+
+### License Server
+
+Set a license server directly in your values file (`license.server`) or during `helm install` with `--set license.server=<LICENSE_SERVER_HOST_ADDRESS>` (replace `<LICENSE_SERVER_HOST_ADDRESS>` with your actual server address).
+
 ## General Principles
 
 - In most places, we opt to pass helm values over configmaps. We translate these into the valid `.gcfg` file format

diff --git a/charts/rstudio-pm/README.md b/charts/rstudio-pm/README.md
@@ -45,15 +45,48 @@ helm search repo rstudio/rstudio-pm -l
 
 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 license file, license key, or address of a running license server. See the [Licensing](#licensing) section below for more details.
 * A Kubernetes [PersistentVolume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) that contains the data directory for RSPM.
   * 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, or by specifying your `PersistentVolumeClaim` using `sharedStorage.name` and `sharedStorage.mount`.
   * 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`.
-  * Alternatively, S3 storage can be used. See the next section for details.
+  * Alternatively, S3 storage can be used. See the [S3 Configuration](#s3-configuration) section for details.
+
+## Licensing
+
+This chart supports activating the product using a license file, license key, or license server. In the case of a license file or key, we recommend against placing it in your values file directly.
+
+### License File
+
+We recommend storing a license file as a `Secret` and setting the `license.file.secret` and `license.file.secretKey` values accordingly.
+
+First, create the secret using YAML or imperatively using the following command (replace `licenses/package-manager.lic` with the path and name of your license file):
+
+```bash
+kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic
+```
+
+Second, specify the following values:
+
+```yaml
+license:
+  file:
+    secret: package-manager-license
+    secretKey: package-manager.lic
+```
+
+Alternatively, license files can be set directly in your values file or during `helm install` with `--set-file license.file.contents=license_files/package-manager.lic`.
+
+### License Key
+
+Set a license key directly in your values file (`license.key`) or during `helm install` with `--set license.key=XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX`.
+
+### License Server
+
+Set a license server directly in your values file (`license.server`) or during `helm install` with `--set license.server=<LICENSE_SERVER_HOST_ADDRESS>` (replace `<LICENSE_SERVER_HOST_ADDRESS>` with your actual server address).
 
 ## S3 Configuration
 

diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md
@@ -43,7 +43,7 @@ helm search repo rstudio/rstudio-workbench -l
 
 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 license file, license key, or address of a running license server. See the [Licensing](#licensing) section below for more details.
 * A Kubernetes [PersistentVolume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) that contains the
   home directory for users.
   * If `homeStorage.create` is set, a PVC that relies on the default storage class will be created to generate the
@@ -89,6 +89,39 @@ In addition to the above required configuration, we recommend setting the follow
 * Some use-cases may require special PAM profiles to run. By default, no PAM profiles other than the basic `auth` profile will be used to authenticate users.
   If this is not sufficient then you will need to add your PAM profiles into the container using a volume and volumeMount.
 
+## Licensing
+
+This chart supports activating the product using a license file, license key, or license server. In the case of a license file or key, we recommend against placing it in your values file directly.
+
+### License File
+
+We recommend storing a license file as a `Secret` and setting the `license.file.secret` and `license.file.secretKey` values accordingly.
+
+First, create the secret using YAML or imperatively using the following command (replace `licenses/workbench.lic` with the path and name of your license file):
+
+```bash
+kubectl create secret generic workbench-license --from-file=licenses/workbench.lic
+```
+
+Second, specify the following values:
+
+```yaml
+license:
+  file:
+    secret: workbench-license
+    secretKey: workbench.lic
+```
+
+Alternatively, license files can be set directly in your values file or during `helm install` with `--set-file license.file.contents=license_files/workbench.lic`.
+
+### License Key
+
+Set a license key directly in your values file (`license.key`) or during `helm install` with `--set license.key=XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX`.
+
+### License Server
+
+Set a license server directly in your values file (`license.server`) or during `helm install` with `--set license.server=<LICENSE_SERVER_HOST_ADDRESS>` (replace `<LICENSE_SERVER_HOST_ADDRESS>` with your actual server address).
+
 ## General Principles
 
 - In most places, we opt to pass Helm values directly into ConfigMaps. We automatically translate these into the