rstudio · colearendt · Nov 27, 2023 · Oct 25, 2023 · Oct 25, 2023 · Oct 25, 2023
@@ -96,6 +96,43 @@ helm search repo {{ if $isDev }}--devel {{ end }}rstudio/{{ template "chart.name
 
 {{- end }}
 
+{{- define "rstudio.licensing" }}
+
+## 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 declaratively with YAML or imperatively using the following command:
+
+`kubectl create secret generic {{ .Name }}-license --from-file=licenses/{{ .Name }}.lic`
+
+Second, specify the following values:
+
+```yaml
+license:
+  file:
+    secret: {{ .Name }}-license
+    secretKey: {{ .Name }}.lic
+```
+
+Alternatively, license files can be set during `helm install` with the following argument:
+
+`--set-file license.file.contents=licenses/{{ .Name }}.lic`
+
+### License Key
+
+Set a license key directly in your values file (`license.key`) or during `helm install` with the argument `--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 the argument `--set license.server=<LICENSE_SERVER_HOST_ADDRESS>`.
+
+{{- end }}
+
 {{ define "rstudio.examples1" -}}
   {{ . }}
   {{ kindOf . }}

@@ -1,6 +1,6 @@
 name: rstudio-connect
 description: Official Helm chart for RStudio Connect
-version: 0.5.9
+version: 0.5.10
 apiVersion: v2
 appVersion: 2023.10.0
 icon: https://rstudio.com/wp-content/uploads/2018/10/RStudio-Logo-Flat.png

@@ -1,3 +1,7 @@
+# 0.5.10
+
+- Add licensing section to the README to provide guidance on using a license file, license key or license server.
+
 # 0.5.9
 
 - Bump Connect version to 2023.10.0

@@ -1,6 +1,6 @@
 # RStudio Connect
 
-![Version: 0.5.9](https://img.shields.io/badge/Version-0.5.9-informational?style=flat-square) ![AppVersion: 2023.10.0](https://img.shields.io/badge/AppVersion-2023.10.0-informational?style=flat-square)
+![Version: 0.5.10](https://img.shields.io/badge/Version-0.5.10-informational?style=flat-square) ![AppVersion: 2023.10.0](https://img.shields.io/badge/AppVersion-2023.10.0-informational?style=flat-square)
 
 #### _Official Helm chart for RStudio Connect_
 
@@ -26,11 +26,11 @@ To ensure reproducibility in your environment and insulate yourself from future
 
 ## Installing the Chart
 
-To install the chart with the release name `my-release` at version 0.5.9:
+To install the chart with the release name `my-release` at version 0.5.10:
 
 ```bash
 helm repo add rstudio https://helm.rstudio.com
-helm upgrade --install my-release rstudio/rstudio-connect --version=0.5.9
+helm upgrade --install my-release rstudio/rstudio-connect --version=0.5.10
 ```
 
 To explore other chart versions, take a look at:
@@ -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 declaratively with YAML or imperatively using the following command:
+
+`kubectl create secret generic rstudio-connect-license --from-file=licenses/rstudio-connect.lic`
+
+Second, specify the following values:
+
+```yaml
+license:
+  file:
+    secret: rstudio-connect-license
+    secretKey: rstudio-connect.lic
+```
+
+Alternatively, license files can be set during `helm install` with the following argument:
+
+`--set-file license.file.contents=licenses/rstudio-connect.lic`
+
+### License Key
+
+Set a license key directly in your values file (`license.key`) or during `helm install` with the argument `--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 the argument `--set license.server=<LICENSE_SERVER_HOST_ADDRESS>`.
+
 ## General Principles
 
 - In most places, we opt to pass helm values over configmaps. We translate these into the valid `.gcfg` file format

@@ -24,7 +24,7 @@
 
 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.
@@ -33,6 +33,8 @@ 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`.
 
+{{ template "rstudio.licensing" . }}
+
 ## General Principles
 
 - In most places, we opt to pass helm values over configmaps. We translate these into the valid `.gcfg` file format

@@ -1,6 +1,6 @@
 name: rstudio-pm
 description: Official Helm chart for RStudio Package Manager
-version: 0.5.16
+version: 0.5.17
 apiVersion: v2
 appVersion: 2023.08.4
 icon: https://rstudio.com/wp-content/uploads/2018/10/RStudio-Logo-Flat.png

@@ -1,3 +1,7 @@
+# 0.5.17
+
+- Add licensing section to the README to provide guidance on using a license file, license key or license server.
+
 # 0.5.16
 
 - Update default Posit Package Manager version to 2023.08.4-20
@@ -10,6 +14,7 @@
 # 0.5.14
 
 - Update default Posit Package Manager version to 2023.08.0-16
+
 # 0.5.13 
 
 - Change default operating system from `bionic` to `ubuntu2204` (`jammy`)

@@ -1,6 +1,6 @@
 # RStudio Package Manager
 
-![Version: 0.5.16](https://img.shields.io/badge/Version-0.5.16-informational?style=flat-square) ![AppVersion: 2023.08.4](https://img.shields.io/badge/AppVersion-2023.08.4-informational?style=flat-square)
+![Version: 0.5.17](https://img.shields.io/badge/Version-0.5.17-informational?style=flat-square) ![AppVersion: 2023.08.4](https://img.shields.io/badge/AppVersion-2023.08.4-informational?style=flat-square)
 
 #### _Official Helm chart for RStudio Package Manager_
 
@@ -21,11 +21,11 @@ To ensure a stable production deployment, please:
 
 ## Installing the Chart
 
-To install the chart with the release name `my-release` at version 0.5.16:
+To install the chart with the release name `my-release` at version 0.5.17:
 
 ```bash
 helm repo add rstudio https://helm.rstudio.com
-helm upgrade --install my-release rstudio/rstudio-pm --version=0.5.16
+helm upgrade --install my-release rstudio/rstudio-pm --version=0.5.17
 ```
 
 To explore other chart versions, take a look at:
@@ -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 declaratively with YAML or imperatively using the following command:
+
+`kubectl create secret generic rstudio-pm-license --from-file=licenses/rstudio-pm.lic`
+
+Second, specify the following values:
+
+```yaml
+license:
+  file:
+    secret: rstudio-pm-license
+    secretKey: rstudio-pm.lic
+```
+
+Alternatively, license files can be set during `helm install` with the following argument:
+
+`--set-file license.file.contents=licenses/rstudio-pm.lic`
+
+### License Key
+
+Set a license key directly in your values file (`license.key`) or during `helm install` with the argument `--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 the argument `--set license.server=<LICENSE_SERVER_HOST_ADDRESS>`.
 
 ## S3 Configuration
 

@@ -20,15 +20,17 @@
 
 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.
+
+{{ template "rstudio.licensing" . }}
 
 ## S3 Configuration
 

@@ -1,6 +1,6 @@
 name: rstudio-workbench
 description: Official Helm chart for RStudio Workbench
-version: 0.6.10
+version: 0.6.11
 apiVersion: v2
 appVersion: 2023.09.1
 icon: https://rstudio.com/wp-content/uploads/2018/10/RStudio-Logo-Flat.png

@@ -1,3 +1,7 @@
+# 0.6.11
+
+- Add licensing section to the README to provide guidance on using a license file, license key or license server.
+
 # 0.6.10
 
 - Bump rstudio-library to `0.1.27`

@@ -1,6 +1,6 @@
 # RStudio Workbench
 
-![Version: 0.6.10](https://img.shields.io/badge/Version-0.6.10-informational?style=flat-square) ![AppVersion: 2023.09.1](https://img.shields.io/badge/AppVersion-2023.09.1-informational?style=flat-square)
+![Version: 0.6.11](https://img.shields.io/badge/Version-0.6.11-informational?style=flat-square) ![AppVersion: 2023.09.1](https://img.shields.io/badge/AppVersion-2023.09.1-informational?style=flat-square)
 
 #### _Official Helm chart for RStudio Workbench_
 
@@ -27,11 +27,11 @@ To ensure a stable production deployment, please:
 
 ## Installing the Chart
 
-To install the chart with the release name `my-release` at version 0.6.10:
+To install the chart with the release name `my-release` at version 0.6.11:
 
 ```bash
 helm repo add rstudio https://helm.rstudio.com
-helm upgrade --install my-release rstudio/rstudio-workbench --version=0.6.10
+helm upgrade --install my-release rstudio/rstudio-workbench --version=0.6.11
 ```
 
 To explore other chart versions, take a look at:
@@ -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 declaratively with YAML or imperatively using the following command:
+
+`kubectl create secret generic rstudio-workbench-license --from-file=licenses/rstudio-workbench.lic`
+
+Second, specify the following values:
+
+```yaml
+license:
+  file:
+    secret: rstudio-workbench-license
+    secretKey: rstudio-workbench.lic
+```
+
+Alternatively, license files can be set during `helm install` with the following argument:
+
+`--set-file license.file.contents=licenses/rstudio-workbench.lic`
+
+### License Key
+
+Set a license key directly in your values file (`license.key`) or during `helm install` with the argument `--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 the argument `--set license.server=<LICENSE_SERVER_HOST_ADDRESS>`.
+
 ## General Principles
 
 - In most places, we opt to pass Helm values directly into ConfigMaps. We automatically translate these into the

@@ -18,7 +18,7 @@
 
 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
@@ -64,6 +64,8 @@ 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.
 
+{{ template "rstudio.licensing" . }}
+
 ## General Principles
 
 - In most places, we opt to pass Helm values directly into ConfigMaps. We automatically translate these into the