From 9859036845148d9e85472540504046b77baf69e7 Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Wed, 25 Oct 2023 13:15:55 -0400 Subject: [PATCH 01/31] Add docs and bump chart for Workbench --- charts/rstudio-workbench/Chart.yaml | 2 +- charts/rstudio-workbench/NEWS.md | 4 +++ charts/rstudio-workbench/README.md | 39 ++++++++++++++++++++++++++--- 3 files changed, 41 insertions(+), 4 deletions(-) diff --git a/charts/rstudio-workbench/Chart.yaml b/charts/rstudio-workbench/Chart.yaml index 6ed348ae..d5f0545d 100644 --- a/charts/rstudio-workbench/Chart.yaml +++ b/charts/rstudio-workbench/Chart.yaml @@ -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 diff --git a/charts/rstudio-workbench/NEWS.md b/charts/rstudio-workbench/NEWS.md index 141dda2b..e50da8d7 100644 --- a/charts/rstudio-workbench/NEWS.md +++ b/charts/rstudio-workbench/NEWS.md @@ -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` diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index 301118b7..9c85aaf6 100644 --- a/charts/rstudio-workbench/README.md +++ b/charts/rstudio-workbench/README.md @@ -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 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=licenses/workbench.lic` (replace `licenses/workbench.lic` with the path and name of your license file). + +### 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=` (replace `` 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 From 9b024dec30cef520dd636dfca1ee02dedf8bfc38 Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Wed, 25 Oct 2023 13:16:10 -0400 Subject: [PATCH 02/31] Add docs and bump chart for PPM --- charts/rstudio-pm/Chart.yaml | 2 +- charts/rstudio-pm/NEWS.md | 5 +++++ charts/rstudio-pm/README.md | 41 ++++++++++++++++++++++++++++++++---- 3 files changed, 43 insertions(+), 5 deletions(-) diff --git a/charts/rstudio-pm/Chart.yaml b/charts/rstudio-pm/Chart.yaml index a2011ed4..b4d6cf45 100644 --- a/charts/rstudio-pm/Chart.yaml +++ b/charts/rstudio-pm/Chart.yaml @@ -1,6 +1,6 @@ name: rstudio-pm description: Official Helm chart for RStudio Package Manager -version: 0.5.15 +version: 0.5.16 apiVersion: v2 appVersion: 2023.08.0 icon: https://rstudio.com/wp-content/uploads/2018/10/RStudio-Logo-Flat.png diff --git a/charts/rstudio-pm/NEWS.md b/charts/rstudio-pm/NEWS.md index 389db462..166becb7 100644 --- a/charts/rstudio-pm/NEWS.md +++ b/charts/rstudio-pm/NEWS.md @@ -1,3 +1,7 @@ +# 0.5.16 + +- Add licensing section to the README to provide guidance on using a license file, license key or license server. + # 0.5.15 - Bump rstudio-library to `0.1.27` @@ -6,6 +10,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`) diff --git a/charts/rstudio-pm/README.md b/charts/rstudio-pm/README.md index 344a5cc6..028ab698 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -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.15: +To install the chart with the release name `my-release` at version 0.5.16: ```bash helm repo add rstudio https://helm.rstudio.com -helm upgrade --install my-release rstudio/rstudio-pm --version=0.5.15 +helm upgrade --install my-release rstudio/rstudio-pm --version=0.5.16 ``` To explore other chart versions, take a look at: @@ -45,7 +45,7 @@ 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. @@ -53,7 +53,40 @@ This chart requires the following in order to function: 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=licenses/package-manager.lic` (replace `licenses/package-manager.lic` with the path and name of your license file). + +### 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=` (replace `` with your actual server address). ## S3 Configuration From b91e3d1813c7aa9263b936d4e1a50b4b9e74f499 Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Wed, 25 Oct 2023 13:16:22 -0400 Subject: [PATCH 03/31] Add docs and bump chart for Connect --- charts/rstudio-connect/Chart.yaml | 2 +- charts/rstudio-connect/NEWS.md | 4 ++++ charts/rstudio-connect/README.md | 39 ++++++++++++++++++++++++++++--- 3 files changed, 41 insertions(+), 4 deletions(-) diff --git a/charts/rstudio-connect/Chart.yaml b/charts/rstudio-connect/Chart.yaml index 48c49611..b31100cc 100644 --- a/charts/rstudio-connect/Chart.yaml +++ b/charts/rstudio-connect/Chart.yaml @@ -1,6 +1,6 @@ name: rstudio-connect description: Official Helm chart for RStudio Connect -version: 0.5.8 +version: 0.5.9 apiVersion: v2 appVersion: 2023.09.0 icon: https://rstudio.com/wp-content/uploads/2018/10/RStudio-Logo-Flat.png diff --git a/charts/rstudio-connect/NEWS.md b/charts/rstudio-connect/NEWS.md index 82c1d0ea..b32214e7 100644 --- a/charts/rstudio-connect/NEWS.md +++ b/charts/rstudio-connect/NEWS.md @@ -1,3 +1,7 @@ +# 0.5.9 + +- Add licensing section to the README to provide guidance on using a license file, license key or license server. + # 0.5.8 - Bump rstudio-library to `0.1.27` diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index 7df64e9b..4dc17bcc 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -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.8: +To install the chart with the release name `my-release` at version 0.5.9: ```bash helm repo add rstudio https://helm.rstudio.com -helm upgrade --install my-release rstudio/rstudio-connect --version=0.5.8 +helm upgrade --install my-release rstudio/rstudio-connect --version=0.5.9 ``` 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 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=licenses/connect.lic` (replace `licenses/connect.lic` with the path and name of your license file). + +### 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=` (replace `` 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 From 490b53ee6ba2170c3e6a3d37b44e7b55c23a7689 Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Wed, 25 Oct 2023 13:18:52 -0400 Subject: [PATCH 04/31] Tweak language --- charts/rstudio-connect/README.md | 2 +- charts/rstudio-pm/README.md | 2 +- charts/rstudio-workbench/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index 4dc17bcc..d09cc1dd 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -71,7 +71,7 @@ This chart supports activating the product using a license file, license key, or 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): +First, create the secret declaratively with 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 diff --git a/charts/rstudio-pm/README.md b/charts/rstudio-pm/README.md index 028ab698..9f3e6e40 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -63,7 +63,7 @@ This chart supports activating the product using a license file, license key, or 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): +First, create the secret declaratively with 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 diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index 9c85aaf6..5d85a403 100644 --- a/charts/rstudio-workbench/README.md +++ b/charts/rstudio-workbench/README.md @@ -97,7 +97,7 @@ This chart supports activating the product using a license file, license key, or 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): +First, create the secret declaratively with 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 From ec45958eadfa13a4050939abd90391fb7cc19927 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 25 Oct 2023 17:22:16 +0000 Subject: [PATCH 05/31] Update helm-docs and README.md --- charts/rstudio-connect/README.md | 37 ++-------------------------- charts/rstudio-pm/README.md | 39 +++--------------------------- charts/rstudio-workbench/README.md | 37 ++-------------------------- 3 files changed, 7 insertions(+), 106 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index d09cc1dd..598b3cc0 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -1,6 +1,6 @@ # RStudio Connect -![Version: 0.5.8](https://img.shields.io/badge/Version-0.5.8-informational?style=flat-square) ![AppVersion: 2023.09.0](https://img.shields.io/badge/AppVersion-2023.09.0-informational?style=flat-square) +![Version: 0.5.9](https://img.shields.io/badge/Version-0.5.9-informational?style=flat-square) ![AppVersion: 2023.09.0](https://img.shields.io/badge/AppVersion-2023.09.0-informational?style=flat-square) #### _Official Helm chart for RStudio Connect_ @@ -54,7 +54,7 @@ helm search repo rstudio/rstudio-connect -l This chart requires the following in order to function: -* A license file, license key, or address of a running license server. See the [Licensing](#licensing) section below for more details. +* 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. @@ -63,39 +63,6 @@ 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 (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=licenses/connect.lic` (replace `licenses/connect.lic` with the path and name of your license file). - -### 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=` (replace `` 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 index 9f3e6e40..623c8d2c 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -1,6 +1,6 @@ # RStudio Package Manager -![Version: 0.5.15](https://img.shields.io/badge/Version-0.5.15-informational?style=flat-square) ![AppVersion: 2023.08.0](https://img.shields.io/badge/AppVersion-2023.08.0-informational?style=flat-square) +![Version: 0.5.16](https://img.shields.io/badge/Version-0.5.16-informational?style=flat-square) ![AppVersion: 2023.08.0](https://img.shields.io/badge/AppVersion-2023.08.0-informational?style=flat-square) #### _Official Helm chart for RStudio Package Manager_ @@ -45,7 +45,7 @@ helm search repo rstudio/rstudio-pm -l This chart requires the following in order to function: -* A license file, license key, or address of a running license server. See the [Licensing](#licensing) section below for more details. +* 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 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. @@ -53,40 +53,7 @@ This chart requires the following in order to function: 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 [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 (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=licenses/package-manager.lic` (replace `licenses/package-manager.lic` with the path and name of your license file). - -### 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=` (replace `` with your actual server address). + * Alternatively, S3 storage can be used. See the next section for details. ## S3 Configuration diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index 5d85a403..bbccbc49 100644 --- a/charts/rstudio-workbench/README.md +++ b/charts/rstudio-workbench/README.md @@ -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_ @@ -43,7 +43,7 @@ helm search repo rstudio/rstudio-workbench -l This chart requires the following in order to function: -* A license file, license key, or address of a running license server. See the [Licensing](#licensing) section below for more details. +* 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 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,39 +89,6 @@ 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 (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=licenses/workbench.lic` (replace `licenses/workbench.lic` with the path and name of your license file). - -### 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=` (replace `` 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 From 77ad9be040c51f55e0880526bbd0c14fee85f3a7 Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Wed, 25 Oct 2023 13:27:23 -0400 Subject: [PATCH 06/31] Add back in README changes --- charts/rstudio-connect/README.md | 35 +++++++++++++++++++++++++++- charts/rstudio-pm/README.md | 37 ++++++++++++++++++++++++++++-- charts/rstudio-workbench/README.md | 35 +++++++++++++++++++++++++++- 3 files changed, 103 insertions(+), 4 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index 598b3cc0..917e4ce8 100644 --- 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 declaratively with 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=licenses/connect.lic` (replace `licenses/connect.lic` with the path and name of your license file). + +### 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=` (replace `` 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 index 623c8d2c..b7325a69 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -45,7 +45,7 @@ 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. @@ -53,7 +53,40 @@ This chart requires the following in order to function: 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 (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=licenses/package-manager.lic` (replace `licenses/package-manager.lic` with the path and name of your license file). + +### 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=` (replace `` with your actual server address). ## S3 Configuration diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index bbccbc49..07fea381 100644 --- 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 declaratively with 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=licenses/workbench.lic` (replace `licenses/workbench.lic` with the path and name of your license file). + +### 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=` (replace `` 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 From 59d0b0ea31b91a9c6cb0ef4629983494e79c93ba Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 25 Oct 2023 17:27:54 +0000 Subject: [PATCH 07/31] Update helm-docs and README.md --- charts/rstudio-connect/README.md | 35 +--------------------------- charts/rstudio-pm/README.md | 37 ++---------------------------- charts/rstudio-workbench/README.md | 35 +--------------------------- 3 files changed, 4 insertions(+), 103 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index 917e4ce8..598b3cc0 100644 --- 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 file, license key, or address of a running license server. See the [Licensing](#licensing) section below for more details. +* 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. @@ -63,39 +63,6 @@ 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 (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=licenses/connect.lic` (replace `licenses/connect.lic` with the path and name of your license file). - -### 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=` (replace `` 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 index b7325a69..623c8d2c 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -45,7 +45,7 @@ helm search repo rstudio/rstudio-pm -l This chart requires the following in order to function: -* A license file, license key, or address of a running license server. See the [Licensing](#licensing) section below for more details. +* 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 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. @@ -53,40 +53,7 @@ This chart requires the following in order to function: 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 [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 (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=licenses/package-manager.lic` (replace `licenses/package-manager.lic` with the path and name of your license file). - -### 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=` (replace `` with your actual server address). + * Alternatively, S3 storage can be used. See the next section for details. ## S3 Configuration diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index 07fea381..bbccbc49 100644 --- 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 file, license key, or address of a running license server. See the [Licensing](#licensing) section below for more details. +* 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 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,39 +89,6 @@ 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 (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=licenses/workbench.lic` (replace `licenses/workbench.lic` with the path and name of your license file). - -### 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=` (replace `` 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 From 80d167dcb7db4f2ac07b0f0ab0423d3a511a7d93 Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Wed, 25 Oct 2023 13:36:04 -0400 Subject: [PATCH 08/31] Add README changes to templates --- charts/rstudio-connect/README.md.gotmpl | 35 ++++++++++++++++++++- charts/rstudio-pm/README.md.gotmpl | 37 +++++++++++++++++++++-- charts/rstudio-workbench/README.md.gotmpl | 35 ++++++++++++++++++++- 3 files changed, 103 insertions(+), 4 deletions(-) diff --git a/charts/rstudio-connect/README.md.gotmpl b/charts/rstudio-connect/README.md.gotmpl index 4dbe692a..1c837f98 100644 --- a/charts/rstudio-connect/README.md.gotmpl +++ b/charts/rstudio-connect/README.md.gotmpl @@ -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,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 (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=licenses/connect.lic` (replace `licenses/connect.lic` with the path and name of your license file). + +### 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=` (replace `` 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.gotmpl b/charts/rstudio-pm/README.md.gotmpl index 22702743..892eda53 100644 --- a/charts/rstudio-pm/README.md.gotmpl +++ b/charts/rstudio-pm/README.md.gotmpl @@ -20,7 +20,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 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. @@ -28,7 +28,40 @@ This chart requires the following in order to function: 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 (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=licenses/package-manager.lic` (replace `licenses/package-manager.lic` with the path and name of your license file). + +### 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=` (replace `` with your actual server address). ## S3 Configuration diff --git a/charts/rstudio-workbench/README.md.gotmpl b/charts/rstudio-workbench/README.md.gotmpl index 4c1a3841..3cf97cc6 100644 --- a/charts/rstudio-workbench/README.md.gotmpl +++ b/charts/rstudio-workbench/README.md.gotmpl @@ -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,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 (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=licenses/workbench.lic` (replace `licenses/workbench.lic` with the path and name of your license file). + +### 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=` (replace `` 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 From 074ab95f36607c474e5c00207ff802f085f613a0 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 25 Oct 2023 17:36:51 +0000 Subject: [PATCH 09/31] Update helm-docs and README.md --- charts/rstudio-connect/README.md | 35 +++++++++++++++++++++++++++- charts/rstudio-pm/README.md | 37 ++++++++++++++++++++++++++++-- charts/rstudio-workbench/README.md | 35 +++++++++++++++++++++++++++- 3 files changed, 103 insertions(+), 4 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index 598b3cc0..917e4ce8 100644 --- 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 declaratively with 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=licenses/connect.lic` (replace `licenses/connect.lic` with the path and name of your license file). + +### 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=` (replace `` 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 index 623c8d2c..b7325a69 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -45,7 +45,7 @@ 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. @@ -53,7 +53,40 @@ This chart requires the following in order to function: 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 (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=licenses/package-manager.lic` (replace `licenses/package-manager.lic` with the path and name of your license file). + +### 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=` (replace `` with your actual server address). ## S3 Configuration diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index bbccbc49..07fea381 100644 --- 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 declaratively with 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=licenses/workbench.lic` (replace `licenses/workbench.lic` with the path and name of your license file). + +### 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=` (replace `` 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 From 61f730c4abeb1a18746e5257409dfa33835d6eee Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 8 Nov 2023 18:02:31 +0000 Subject: [PATCH 10/31] Update helm-docs and README.md --- charts/rstudio-connect/README.md | 6 +++--- charts/rstudio-pm/README.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index fe37fd58..314b5c9d 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -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: diff --git a/charts/rstudio-pm/README.md b/charts/rstudio-pm/README.md index 6a9fb7a7..2615e691 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -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: From 028d0213dbb9b69ddc547b10c3eb504deeeca031 Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Mon, 27 Nov 2023 13:15:19 -0500 Subject: [PATCH 11/31] Move licensing section into a template --- charts/_templates.gotmpl | 67 +++++++++++++++++++++++ charts/rstudio-connect/README.md.gotmpl | 33 +---------- charts/rstudio-pm/README.md.gotmpl | 33 +---------- charts/rstudio-workbench/README.md.gotmpl | 33 +---------- 4 files changed, 70 insertions(+), 96 deletions(-) diff --git a/charts/_templates.gotmpl b/charts/_templates.gotmpl index 8bfbfe96..4421b4f4 100644 --- a/charts/_templates.gotmpl +++ b/charts/_templates.gotmpl @@ -96,6 +96,73 @@ 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: + +```bash + {{- if eq .Name "rstudio-connect" -}} +kubectl create secret generic connect-license --from-file=licenses/connect.lic + {{- else if eq .Name "rstudio-pm" -}} +kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic + {{- else if eq .Name "rstudio-workbench" -}} +kubectl create secret generic workbench-license --from-file=licenses/workbench.lic + {{- else -}} +{{ template "chart.header" . }} + {{- end }} +``` + +Second, specify the following values: + +```yaml +license: + file: + {{- if eq .Name "rstudio-connect" -}} + secret: connect-license + secretKey: connect.lic + {{- else if eq .Name "rstudio-pm" -}} + secret: package-manager-license + secretKey: package-manager.lic + {{- else if eq .Name "rstudio-workbench" -}} + secret: workbench-license + secretKey: workbench.lic + {{- else -}} +{{ template "chart.header" . }} + {{- end }} +``` + +Alternatively, license files can be set directly in your values file or during `helm install` with: + +```bash + {{- if eq .Name "rstudio-connect" -}} +--set-file license.file.contents=licenses/connect.lic + {{- else if eq .Name "rstudio-pm" -}} +--set-file license.file.contents=licenses/package-manager.lic + {{- else if eq .Name "rstudio-workbench" -}} +--set-file license.file.contents=licenses/workbench.lic + {{- else -}} +{{ template "chart.header" . }} + {{- end }} +``` + +### 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=` (replace `` with your actual server address). + +{{- end }} + {{ define "rstudio.examples1" -}} {{ . }} {{ kindOf . }} diff --git a/charts/rstudio-connect/README.md.gotmpl b/charts/rstudio-connect/README.md.gotmpl index 1c837f98..4c357016 100644 --- a/charts/rstudio-connect/README.md.gotmpl +++ b/charts/rstudio-connect/README.md.gotmpl @@ -33,38 +33,7 @@ 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 (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=licenses/connect.lic` (replace `licenses/connect.lic` with the path and name of your license file). - -### 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=` (replace `` with your actual server address). +{{ template "rstudio.licensing" . }} ## General Principles diff --git a/charts/rstudio-pm/README.md.gotmpl b/charts/rstudio-pm/README.md.gotmpl index 892eda53..d0d4cc81 100644 --- a/charts/rstudio-pm/README.md.gotmpl +++ b/charts/rstudio-pm/README.md.gotmpl @@ -30,38 +30,7 @@ This chart requires the following in order to function: 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 [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 (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=licenses/package-manager.lic` (replace `licenses/package-manager.lic` with the path and name of your license file). - -### 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=` (replace `` with your actual server address). +{{ template "rstudio.licensing" . }} ## S3 Configuration diff --git a/charts/rstudio-workbench/README.md.gotmpl b/charts/rstudio-workbench/README.md.gotmpl index 3cf97cc6..6daa4090 100644 --- a/charts/rstudio-workbench/README.md.gotmpl +++ b/charts/rstudio-workbench/README.md.gotmpl @@ -64,38 +64,7 @@ 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 (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=licenses/workbench.lic` (replace `licenses/workbench.lic` with the path and name of your license file). - -### 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=` (replace `` with your actual server address). +{{ template "rstudio.licensing" . }} ## General Principles From c3df9b419dabb5f10916fb1ded6575424a7538ea Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 27 Nov 2023 18:15:48 +0000 Subject: [PATCH 12/31] Update helm-docs and README.md --- charts/rstudio-connect/README.md | 13 +++++++------ charts/rstudio-pm/README.md | 13 +++++++------ charts/rstudio-workbench/README.md | 13 +++++++------ 3 files changed, 21 insertions(+), 18 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index 314b5c9d..3bf04679 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -71,22 +71,23 @@ This chart supports activating the product using a license file, license key, or 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 (replace `licenses/connect.lic` with the path and name of your license file): +First, create the secret declaratively with YAML or imperatively using the following command: -```bash -kubectl create secret generic connect-license --from-file=licenses/connect.lic +```bashkubectl create secret generic connect-license --from-file=licenses/connect.lic ``` Second, specify the following values: ```yaml license: - file: - secret: connect-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=licenses/connect.lic` (replace `licenses/connect.lic` with the path and name of your license file). +Alternatively, license files can be set directly in your values file or during `helm install` with: + +```bash--set-file license.file.contents=licenses/connect.lic +``` ### License Key diff --git a/charts/rstudio-pm/README.md b/charts/rstudio-pm/README.md index 2615e691..d34281f7 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -63,22 +63,23 @@ This chart supports activating the product using a license file, license key, or 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 (replace `licenses/package-manager.lic` with the path and name of your license file): +First, create the secret declaratively with YAML or imperatively using the following command: -```bash -kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic +```bashkubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic ``` Second, specify the following values: ```yaml license: - file: - secret: package-manager-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=licenses/package-manager.lic` (replace `licenses/package-manager.lic` with the path and name of your license file). +Alternatively, license files can be set directly in your values file or during `helm install` with: + +```bash--set-file license.file.contents=licenses/package-manager.lic +``` ### License Key diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index 07fea381..f092ea8e 100644 --- a/charts/rstudio-workbench/README.md +++ b/charts/rstudio-workbench/README.md @@ -97,22 +97,23 @@ This chart supports activating the product using a license file, license key, or 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 (replace `licenses/workbench.lic` with the path and name of your license file): +First, create the secret declaratively with YAML or imperatively using the following command: -```bash -kubectl create secret generic workbench-license --from-file=licenses/workbench.lic +```bashkubectl create secret generic workbench-license --from-file=licenses/workbench.lic ``` Second, specify the following values: ```yaml license: - file: - secret: workbench-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=licenses/workbench.lic` (replace `licenses/workbench.lic` with the path and name of your license file). +Alternatively, license files can be set directly in your values file or during `helm install` with: + +```bash--set-file license.file.contents=licenses/workbench.lic +``` ### License Key From 2ab83305f6bedcfdcda1497ffbe80e157b8d55e8 Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Mon, 27 Nov 2023 13:18:05 -0500 Subject: [PATCH 13/31] Indent bash --- charts/_templates.gotmpl | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/charts/_templates.gotmpl b/charts/_templates.gotmpl index 4421b4f4..d2468fc4 100644 --- a/charts/_templates.gotmpl +++ b/charts/_templates.gotmpl @@ -110,11 +110,11 @@ First, create the secret declaratively with YAML or imperatively using the follo ```bash {{- if eq .Name "rstudio-connect" -}} -kubectl create secret generic connect-license --from-file=licenses/connect.lic + kubectl create secret generic connect-license --from-file=licenses/connect.lic {{- else if eq .Name "rstudio-pm" -}} -kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic + kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic {{- else if eq .Name "rstudio-workbench" -}} -kubectl create secret generic workbench-license --from-file=licenses/workbench.lic + kubectl create secret generic workbench-license --from-file=licenses/workbench.lic {{- else -}} {{ template "chart.header" . }} {{- end }} @@ -143,11 +143,11 @@ Alternatively, license files can be set directly in your values file or during ` ```bash {{- if eq .Name "rstudio-connect" -}} ---set-file license.file.contents=licenses/connect.lic + --set-file license.file.contents=licenses/connect.lic {{- else if eq .Name "rstudio-pm" -}} ---set-file license.file.contents=licenses/package-manager.lic + --set-file license.file.contents=licenses/package-manager.lic {{- else if eq .Name "rstudio-workbench" -}} ---set-file license.file.contents=licenses/workbench.lic + --set-file license.file.contents=licenses/workbench.lic {{- else -}} {{ template "chart.header" . }} {{- end }} From f13510fe5d3992f32ba97eb636365356c98b2027 Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Mon, 27 Nov 2023 13:28:05 -0500 Subject: [PATCH 14/31] Fix bash conditionals --- charts/_templates.gotmpl | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/charts/_templates.gotmpl b/charts/_templates.gotmpl index d2468fc4..dd5421fc 100644 --- a/charts/_templates.gotmpl +++ b/charts/_templates.gotmpl @@ -108,17 +108,21 @@ We recommend storing a license file as a `Secret` and setting the `license.file. First, create the secret declaratively with YAML or imperatively using the following command: -```bash {{- if eq .Name "rstudio-connect" -}} - kubectl create secret generic connect-license --from-file=licenses/connect.lic +```bash +kubectl create secret generic connect-license --from-file=licenses/connect.lic +``` {{- else if eq .Name "rstudio-pm" -}} - kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic +```bash +kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic +``` {{- else if eq .Name "rstudio-workbench" -}} - kubectl create secret generic workbench-license --from-file=licenses/workbench.lic +```bash +kubectl create secret generic workbench-license --from-file=licenses/workbench.lic +``` {{- else -}} {{ template "chart.header" . }} {{- end }} -``` Second, specify the following values: @@ -141,17 +145,21 @@ license: Alternatively, license files can be set directly in your values file or during `helm install` with: -```bash {{- if eq .Name "rstudio-connect" -}} - --set-file license.file.contents=licenses/connect.lic +```bash +--set-file license.file.contents=licenses/connect.lic +``` {{- else if eq .Name "rstudio-pm" -}} - --set-file license.file.contents=licenses/package-manager.lic +```bash +--set-file license.file.contents=licenses/package-manager.lic +``` {{- else if eq .Name "rstudio-workbench" -}} - --set-file license.file.contents=licenses/workbench.lic +```bash +--set-file license.file.contents=licenses/workbench.lic +``` {{- else -}} {{ template "chart.header" . }} {{- end }} -``` ### License Key From 468e3730702078d9f41c2e3df0a21dd345f2d0c4 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 27 Nov 2023 18:28:34 +0000 Subject: [PATCH 15/31] Update helm-docs and README.md --- charts/rstudio-connect/README.md | 10 ++++------ charts/rstudio-pm/README.md | 10 ++++------ charts/rstudio-workbench/README.md | 10 ++++------ 3 files changed, 12 insertions(+), 18 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index 3bf04679..d5bbeec7 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -71,9 +71,8 @@ This chart supports activating the product using a license file, license key, or 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: - -```bashkubectl create secret generic connect-license --from-file=licenses/connect.lic +First, create the secret declaratively with YAML or imperatively using the following command:```bash +kubectl create secret generic connect-license --from-file=licenses/connect.lic ``` Second, specify the following values: @@ -84,9 +83,8 @@ license: secretKey: connect.lic ``` -Alternatively, license files can be set directly in your values file or during `helm install` with: - -```bash--set-file license.file.contents=licenses/connect.lic +Alternatively, license files can be set directly in your values file or during `helm install` with:```bash +--set-file license.file.contents=licenses/connect.lic ``` ### License Key diff --git a/charts/rstudio-pm/README.md b/charts/rstudio-pm/README.md index d34281f7..c174fb16 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -63,9 +63,8 @@ This chart supports activating the product using a license file, license key, or 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: - -```bashkubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic +First, create the secret declaratively with YAML or imperatively using the following command:```bash +kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic ``` Second, specify the following values: @@ -76,9 +75,8 @@ license: secretKey: package-manager.lic ``` -Alternatively, license files can be set directly in your values file or during `helm install` with: - -```bash--set-file license.file.contents=licenses/package-manager.lic +Alternatively, license files can be set directly in your values file or during `helm install` with:```bash +--set-file license.file.contents=licenses/package-manager.lic ``` ### License Key diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index f092ea8e..5e20392d 100644 --- a/charts/rstudio-workbench/README.md +++ b/charts/rstudio-workbench/README.md @@ -97,9 +97,8 @@ This chart supports activating the product using a license file, license key, or 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: - -```bashkubectl create secret generic workbench-license --from-file=licenses/workbench.lic +First, create the secret declaratively with YAML or imperatively using the following command:```bash +kubectl create secret generic workbench-license --from-file=licenses/workbench.lic ``` Second, specify the following values: @@ -110,9 +109,8 @@ license: secretKey: workbench.lic ``` -Alternatively, license files can be set directly in your values file or during `helm install` with: - -```bash--set-file license.file.contents=licenses/workbench.lic +Alternatively, license files can be set directly in your values file or during `helm install` with:```bash +--set-file license.file.contents=licenses/workbench.lic ``` ### License Key From e4e4dbbf05f6652c8116ef9c1e7f2c97cc7a2a55 Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Mon, 27 Nov 2023 13:35:40 -0500 Subject: [PATCH 16/31] Fix issue with bash code --- charts/_templates.gotmpl | 28 +++++++--------------------- 1 file changed, 7 insertions(+), 21 deletions(-) diff --git a/charts/_templates.gotmpl b/charts/_templates.gotmpl index dd5421fc..a5af305e 100644 --- a/charts/_templates.gotmpl +++ b/charts/_templates.gotmpl @@ -107,19 +107,12 @@ This chart supports activating the product using a license file, license key, or 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: - {{- if eq .Name "rstudio-connect" -}} -```bash -kubectl create secret generic connect-license --from-file=licenses/connect.lic -``` +`kubectl create secret generic connect-license --from-file=licenses/connect.lic` {{- else if eq .Name "rstudio-pm" -}} -```bash -kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic -``` +`kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic` {{- else if eq .Name "rstudio-workbench" -}} -```bash -kubectl create secret generic workbench-license --from-file=licenses/workbench.lic -``` +`kubectl create secret generic workbench-license --from-file=licenses/workbench.lic` {{- else -}} {{ template "chart.header" . }} {{- end }} @@ -143,20 +136,13 @@ license: {{- end }} ``` -Alternatively, license files can be set directly in your values file or during `helm install` with: - +Alternatively, license files can be set directly in your values file or during `helm install` with the following arguement: {{- if eq .Name "rstudio-connect" -}} -```bash ---set-file license.file.contents=licenses/connect.lic -``` +`--set-file license.file.contents=licenses/connect.lic` {{- else if eq .Name "rstudio-pm" -}} -```bash ---set-file license.file.contents=licenses/package-manager.lic -``` +`--set-file license.file.contents=licenses/package-manager.lic` {{- else if eq .Name "rstudio-workbench" -}} -```bash ---set-file license.file.contents=licenses/workbench.lic -``` +`--set-file license.file.contents=licenses/workbench.lic` {{- else -}} {{ template "chart.header" . }} {{- end }} From cc8155150ca3d94b30ae9f0aaf24b1bc8583d70f Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 27 Nov 2023 18:36:14 +0000 Subject: [PATCH 17/31] Update helm-docs and README.md --- charts/rstudio-connect/README.md | 8 ++------ charts/rstudio-pm/README.md | 8 ++------ charts/rstudio-workbench/README.md | 8 ++------ 3 files changed, 6 insertions(+), 18 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index d5bbeec7..5a8243af 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -71,9 +71,7 @@ This chart supports activating the product using a license file, license key, or 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:```bash -kubectl create secret generic connect-license --from-file=licenses/connect.lic -``` +First, create the secret declaratively with YAML or imperatively using the following command:`kubectl create secret generic connect-license --from-file=licenses/connect.lic` Second, specify the following values: @@ -83,9 +81,7 @@ license: secretKey: connect.lic ``` -Alternatively, license files can be set directly in your values file or during `helm install` with:```bash ---set-file license.file.contents=licenses/connect.lic -``` +Alternatively, license files can be set directly in your values file or during `helm install` with the following arguement:`--set-file license.file.contents=licenses/connect.lic` ### License Key diff --git a/charts/rstudio-pm/README.md b/charts/rstudio-pm/README.md index c174fb16..34b624fe 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -63,9 +63,7 @@ This chart supports activating the product using a license file, license key, or 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:```bash -kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic -``` +First, create the secret declaratively with YAML or imperatively using the following command:`kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic` Second, specify the following values: @@ -75,9 +73,7 @@ license: secretKey: package-manager.lic ``` -Alternatively, license files can be set directly in your values file or during `helm install` with:```bash ---set-file license.file.contents=licenses/package-manager.lic -``` +Alternatively, license files can be set directly in your values file or during `helm install` with the following arguement:`--set-file license.file.contents=licenses/package-manager.lic` ### License Key diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index 5e20392d..f5ce4e70 100644 --- a/charts/rstudio-workbench/README.md +++ b/charts/rstudio-workbench/README.md @@ -97,9 +97,7 @@ This chart supports activating the product using a license file, license key, or 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:```bash -kubectl create secret generic workbench-license --from-file=licenses/workbench.lic -``` +First, create the secret declaratively with YAML or imperatively using the following command:`kubectl create secret generic workbench-license --from-file=licenses/workbench.lic` Second, specify the following values: @@ -109,9 +107,7 @@ license: secretKey: workbench.lic ``` -Alternatively, license files can be set directly in your values file or during `helm install` with:```bash ---set-file license.file.contents=licenses/workbench.lic -``` +Alternatively, license files can be set directly in your values file or during `helm install` with the following arguement:`--set-file license.file.contents=licenses/workbench.lic` ### License Key From 0afa2b7c231c80c780ce09811e0299e61948d321 Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Mon, 27 Nov 2023 13:42:46 -0500 Subject: [PATCH 18/31] Fix yaml formatting issue --- charts/_templates.gotmpl | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/charts/_templates.gotmpl b/charts/_templates.gotmpl index a5af305e..85371a1c 100644 --- a/charts/_templates.gotmpl +++ b/charts/_templates.gotmpl @@ -106,7 +106,7 @@ This chart supports activating the product using a license file, license key, or 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: +First, create the secret declaratively with YAML or imperatively using the following command: {{- if eq .Name "rstudio-connect" -}} `kubectl create secret generic connect-license --from-file=licenses/connect.lic` {{- else if eq .Name "rstudio-pm" -}} @@ -120,15 +120,19 @@ First, create the secret declaratively with YAML or imperatively using the follo Second, specify the following values: ```yaml + {{- if eq .Name "rstudio-connect" -}} license: file: - {{- if eq .Name "rstudio-connect" -}} secret: connect-license secretKey: connect.lic {{- else if eq .Name "rstudio-pm" -}} +license: + file: secret: package-manager-license secretKey: package-manager.lic {{- else if eq .Name "rstudio-workbench" -}} +license: + file: secret: workbench-license secretKey: workbench.lic {{- else -}} @@ -136,7 +140,7 @@ license: {{- end }} ``` -Alternatively, license files can be set directly in your values file or during `helm install` with the following arguement: +Alternatively, license files can be set during `helm install` with the following argument: {{- if eq .Name "rstudio-connect" -}} `--set-file license.file.contents=licenses/connect.lic` {{- else if eq .Name "rstudio-pm" -}} @@ -149,11 +153,11 @@ Alternatively, license files can be set directly in your values file or during ` ### 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`. +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 `--set license.server=` (replace `` with your actual server address). +Set a license server directly in your values file (`license.server`) or during `helm install` with the argument `--set license.server=`. {{- end }} From 8501f36b8b6f018901f1b0ca985353820a0cae04 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 27 Nov 2023 18:43:16 +0000 Subject: [PATCH 19/31] Update helm-docs and README.md --- charts/rstudio-connect/README.md | 12 ++++++------ charts/rstudio-pm/README.md | 12 ++++++------ charts/rstudio-workbench/README.md | 12 ++++++------ 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index 5a8243af..a8d23dc8 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -75,21 +75,21 @@ First, create the secret declaratively with YAML or imperatively using the follo Second, specify the following values: -```yaml -license: - file:secret: connect-license +```yamllicense: + file: + secret: connect-license secretKey: connect.lic ``` -Alternatively, license files can be set directly in your values file or during `helm install` with the following arguement:`--set-file license.file.contents=licenses/connect.lic` +Alternatively, license files can be set during `helm install` with the following argument:`--set-file license.file.contents=licenses/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`. +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 `--set license.server=` (replace `` with your actual server address). +Set a license server directly in your values file (`license.server`) or during `helm install` with the argument `--set license.server=`. ## General Principles diff --git a/charts/rstudio-pm/README.md b/charts/rstudio-pm/README.md index 34b624fe..5ca20164 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -67,21 +67,21 @@ First, create the secret declaratively with YAML or imperatively using the follo Second, specify the following values: -```yaml -license: - file:secret: package-manager-license +```yamllicense: + 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 the following arguement:`--set-file license.file.contents=licenses/package-manager.lic` +Alternatively, license files can be set during `helm install` with the following argument:`--set-file license.file.contents=licenses/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`. +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 `--set license.server=` (replace `` with your actual server address). +Set a license server directly in your values file (`license.server`) or during `helm install` with the argument `--set license.server=`. ## S3 Configuration diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index f5ce4e70..106e97e6 100644 --- a/charts/rstudio-workbench/README.md +++ b/charts/rstudio-workbench/README.md @@ -101,21 +101,21 @@ First, create the secret declaratively with YAML or imperatively using the follo Second, specify the following values: -```yaml -license: - file:secret: workbench-license +```yamllicense: + file: + secret: workbench-license secretKey: workbench.lic ``` -Alternatively, license files can be set directly in your values file or during `helm install` with the following arguement:`--set-file license.file.contents=licenses/workbench.lic` +Alternatively, license files can be set during `helm install` with the following argument:`--set-file license.file.contents=licenses/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`. +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 `--set license.server=` (replace `` with your actual server address). +Set a license server directly in your values file (`license.server`) or during `helm install` with the argument `--set license.server=`. ## General Principles From f789d8487b96889d34e03733def6d901a7de2c54 Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Mon, 27 Nov 2023 13:52:41 -0500 Subject: [PATCH 20/31] Fix YAML issues --- charts/_templates.gotmpl | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/charts/_templates.gotmpl b/charts/_templates.gotmpl index 85371a1c..7c9c2954 100644 --- a/charts/_templates.gotmpl +++ b/charts/_templates.gotmpl @@ -106,7 +106,8 @@ This chart supports activating the product using a license file, license key, or 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: +First, create the secret declaratively with YAML or imperatively using the following command: + {{- if eq .Name "rstudio-connect" -}} `kubectl create secret generic connect-license --from-file=licenses/connect.lic` {{- else if eq .Name "rstudio-pm" -}} @@ -119,28 +120,35 @@ First, create the secret declaratively with YAML or imperatively using the follo Second, specify the following values: -```yaml + {{- if eq .Name "rstudio-connect" -}} +```yaml license: file: secret: connect-license secretKey: connect.lic +``` {{- else if eq .Name "rstudio-pm" -}} +```yaml license: file: secret: package-manager-license secretKey: package-manager.lic +``` {{- else if eq .Name "rstudio-workbench" -}} +```yaml license: file: secret: workbench-license secretKey: workbench.lic +``` {{- else -}} {{ template "chart.header" . }} {{- end }} -``` -Alternatively, license files can be set during `helm install` with the following argument: + +Alternatively, license files can be set during `helm install` with the following argument: + {{- if eq .Name "rstudio-connect" -}} `--set-file license.file.contents=licenses/connect.lic` {{- else if eq .Name "rstudio-pm" -}} From 0f245df25a91eec4ae74fcf63a8e8f4cbf6cd591 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 27 Nov 2023 18:53:14 +0000 Subject: [PATCH 21/31] Update helm-docs and README.md --- charts/rstudio-connect/README.md | 5 ++--- charts/rstudio-pm/README.md | 5 ++--- charts/rstudio-workbench/README.md | 5 ++--- 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index a8d23dc8..b737bcf2 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -73,9 +73,8 @@ We recommend storing a license file as a `Secret` and setting the `license.file. First, create the secret declaratively with YAML or imperatively using the following command:`kubectl create secret generic connect-license --from-file=licenses/connect.lic` -Second, specify the following values: - -```yamllicense: +Second, specify the following values:```yaml +license: file: secret: connect-license secretKey: connect.lic diff --git a/charts/rstudio-pm/README.md b/charts/rstudio-pm/README.md index 5ca20164..f08651c9 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -65,9 +65,8 @@ We recommend storing a license file as a `Secret` and setting the `license.file. First, create the secret declaratively with YAML or imperatively using the following command:`kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic` -Second, specify the following values: - -```yamllicense: +Second, specify the following values:```yaml +license: file: secret: package-manager-license secretKey: package-manager.lic diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index 106e97e6..8c995e07 100644 --- a/charts/rstudio-workbench/README.md +++ b/charts/rstudio-workbench/README.md @@ -99,9 +99,8 @@ We recommend storing a license file as a `Secret` and setting the `license.file. First, create the secret declaratively with YAML or imperatively using the following command:`kubectl create secret generic workbench-license --from-file=licenses/workbench.lic` -Second, specify the following values: - -```yamllicense: +Second, specify the following values:```yaml +license: file: secret: workbench-license secretKey: workbench.lic From 6b6291bee7f9178708b131aa444eb3a6bd42dd3f Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Mon, 27 Nov 2023 13:58:08 -0500 Subject: [PATCH 22/31] Fix for YAML formatting --- charts/_templates.gotmpl | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/charts/_templates.gotmpl b/charts/_templates.gotmpl index 7c9c2954..0365b770 100644 --- a/charts/_templates.gotmpl +++ b/charts/_templates.gotmpl @@ -120,31 +120,23 @@ First, create the secret declaratively with YAML or imperatively using the follo Second, specify the following values: - - {{- if eq .Name "rstudio-connect" -}} ```yaml license: file: + + {{- if eq .Name "rstudio-connect" -}} secret: connect-license secretKey: connect.lic -``` {{- else if eq .Name "rstudio-pm" -}} -```yaml -license: - file: secret: package-manager-license secretKey: package-manager.lic -``` {{- else if eq .Name "rstudio-workbench" -}} -```yaml -license: - file: secret: workbench-license secretKey: workbench.lic -``` {{- else -}} {{ template "chart.header" . }} {{- end }} +``` Alternatively, license files can be set during `helm install` with the following argument: From 886823be162adee4d331747aa7dad4ca4c352de3 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 27 Nov 2023 18:58:42 +0000 Subject: [PATCH 23/31] Update helm-docs and README.md --- charts/rstudio-connect/README.md | 7 ++++--- charts/rstudio-pm/README.md | 7 ++++--- charts/rstudio-workbench/README.md | 7 ++++--- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index b737bcf2..c30a24c3 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -73,10 +73,11 @@ We recommend storing a license file as a `Secret` and setting the `license.file. First, create the secret declaratively with YAML or imperatively using the following command:`kubectl create secret generic connect-license --from-file=licenses/connect.lic` -Second, specify the following values:```yaml +Second, specify the following values: + +```yaml license: - file: - secret: connect-license + file:secret: connect-license secretKey: connect.lic ``` diff --git a/charts/rstudio-pm/README.md b/charts/rstudio-pm/README.md index f08651c9..bb692312 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -65,10 +65,11 @@ We recommend storing a license file as a `Secret` and setting the `license.file. First, create the secret declaratively with YAML or imperatively using the following command:`kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic` -Second, specify the following values:```yaml +Second, specify the following values: + +```yaml license: - file: - secret: package-manager-license + file:secret: package-manager-license secretKey: package-manager.lic ``` diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index 8c995e07..dbcc3b3c 100644 --- a/charts/rstudio-workbench/README.md +++ b/charts/rstudio-workbench/README.md @@ -99,10 +99,11 @@ We recommend storing a license file as a `Secret` and setting the `license.file. First, create the secret declaratively with YAML or imperatively using the following command:`kubectl create secret generic workbench-license --from-file=licenses/workbench.lic` -Second, specify the following values:```yaml +Second, specify the following values: + +```yaml license: - file: - secret: workbench-license + file:secret: workbench-license secretKey: workbench.lic ``` From 6c9ec19b3672d58b3843420457086c02925102dd Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Mon, 27 Nov 2023 14:04:47 -0500 Subject: [PATCH 24/31] Adjust whitespace --- charts/_templates.gotmpl | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/charts/_templates.gotmpl b/charts/_templates.gotmpl index 0365b770..8f8ace90 100644 --- a/charts/_templates.gotmpl +++ b/charts/_templates.gotmpl @@ -108,13 +108,13 @@ We recommend storing a license file as a `Secret` and setting the `license.file. First, create the secret declaratively with YAML or imperatively using the following command: - {{- if eq .Name "rstudio-connect" -}} + {{ if eq .Name "rstudio-connect" -}} `kubectl create secret generic connect-license --from-file=licenses/connect.lic` - {{- else if eq .Name "rstudio-pm" -}} + {{ else if eq .Name "rstudio-pm" -}} `kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic` - {{- else if eq .Name "rstudio-workbench" -}} + {{ else if eq .Name "rstudio-workbench" -}} `kubectl create secret generic workbench-license --from-file=licenses/workbench.lic` - {{- else -}} + {{ else -}} {{ template "chart.header" . }} {{- end }} @@ -123,17 +123,16 @@ Second, specify the following values: ```yaml license: file: - - {{- if eq .Name "rstudio-connect" -}} + {{ if eq .Name "rstudio-connect" -}} secret: connect-license secretKey: connect.lic - {{- else if eq .Name "rstudio-pm" -}} + {{ else if eq .Name "rstudio-pm" -}} secret: package-manager-license secretKey: package-manager.lic - {{- else if eq .Name "rstudio-workbench" -}} + {{ else if eq .Name "rstudio-workbench" -}} secret: workbench-license secretKey: workbench.lic - {{- else -}} + {{ else -}} {{ template "chart.header" . }} {{- end }} ``` @@ -141,13 +140,13 @@ license: Alternatively, license files can be set during `helm install` with the following argument: - {{- if eq .Name "rstudio-connect" -}} + {{ if eq .Name "rstudio-connect" -}} `--set-file license.file.contents=licenses/connect.lic` - {{- else if eq .Name "rstudio-pm" -}} + {{ else if eq .Name "rstudio-pm" -}} `--set-file license.file.contents=licenses/package-manager.lic` - {{- else if eq .Name "rstudio-workbench" -}} + {{ else if eq .Name "rstudio-workbench" -}} `--set-file license.file.contents=licenses/workbench.lic` - {{- else -}} + {{ else -}} {{ template "chart.header" . }} {{- end }} From fcfc93277deeca2646a0032a95ee19ee2801b4ba Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 27 Nov 2023 19:05:16 +0000 Subject: [PATCH 25/31] Update helm-docs and README.md --- charts/rstudio-connect/README.md | 14 +++++++++++--- charts/rstudio-pm/README.md | 14 +++++++++++--- charts/rstudio-workbench/README.md | 14 +++++++++++--- 3 files changed, 33 insertions(+), 9 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index c30a24c3..88af3d69 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -71,17 +71,25 @@ This chart supports activating the product using a license file, license key, or 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 connect-license --from-file=licenses/connect.lic` +First, create the secret declaratively with YAML or imperatively using the following command: + + `kubectl create secret generic connect-license --from-file=licenses/connect.lic` + Second, specify the following values: ```yaml license: - file:secret: connect-license + file: + secret: connect-license secretKey: connect.lic + ``` -Alternatively, license files can be set during `helm install` with the following argument:`--set-file license.file.contents=licenses/connect.lic` +Alternatively, license files can be set during `helm install` with the following argument: + + `--set-file license.file.contents=licenses/connect.lic` + ### License Key diff --git a/charts/rstudio-pm/README.md b/charts/rstudio-pm/README.md index bb692312..702d68b8 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -63,17 +63,25 @@ This chart supports activating the product using a license file, license key, or 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 package-manager-license --from-file=licenses/package-manager.lic` +First, create the secret declaratively with YAML or imperatively using the following command: + + `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 + file: + secret: package-manager-license secretKey: package-manager.lic + ``` -Alternatively, license files can be set during `helm install` with the following argument:`--set-file license.file.contents=licenses/package-manager.lic` +Alternatively, license files can be set during `helm install` with the following argument: + + `--set-file license.file.contents=licenses/package-manager.lic` + ### License Key diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index dbcc3b3c..46705f84 100644 --- a/charts/rstudio-workbench/README.md +++ b/charts/rstudio-workbench/README.md @@ -97,17 +97,25 @@ This chart supports activating the product using a license file, license key, or 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 workbench-license --from-file=licenses/workbench.lic` +First, create the secret declaratively with YAML or imperatively using the following command: + + `kubectl create secret generic workbench-license --from-file=licenses/workbench.lic` + Second, specify the following values: ```yaml license: - file:secret: workbench-license + file: + secret: workbench-license secretKey: workbench.lic + ``` -Alternatively, license files can be set during `helm install` with the following argument:`--set-file license.file.contents=licenses/workbench.lic` +Alternatively, license files can be set during `helm install` with the following argument: + + `--set-file license.file.contents=licenses/workbench.lic` + ### License Key From d0df5c087833cadb97c5c7b9b85c3c812acff124 Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Mon, 27 Nov 2023 14:09:02 -0500 Subject: [PATCH 26/31] Another whitespace fix --- charts/_templates.gotmpl | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/charts/_templates.gotmpl b/charts/_templates.gotmpl index 8f8ace90..541038f9 100644 --- a/charts/_templates.gotmpl +++ b/charts/_templates.gotmpl @@ -123,18 +123,18 @@ Second, specify the following values: ```yaml license: file: - {{ if eq .Name "rstudio-connect" -}} + {{ if eq .Name "rstudio-connect" }} secret: connect-license secretKey: connect.lic - {{ else if eq .Name "rstudio-pm" -}} + {{ else if eq .Name "rstudio-pm" }} secret: package-manager-license secretKey: package-manager.lic - {{ else if eq .Name "rstudio-workbench" -}} + {{ else if eq .Name "rstudio-workbench" }} secret: workbench-license secretKey: workbench.lic - {{ else -}} + {{ else }} {{ template "chart.header" . }} - {{- end }} + {{ end }} ``` From e59423fb0df56ac2873eeb1965853d4022bf05d9 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 27 Nov 2023 19:09:45 +0000 Subject: [PATCH 27/31] Update helm-docs and README.md --- charts/rstudio-connect/README.md | 3 ++- charts/rstudio-pm/README.md | 3 ++- charts/rstudio-workbench/README.md | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index 88af3d69..609471b4 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -81,7 +81,8 @@ Second, specify the following values: ```yaml license: file: - secret: connect-license + + secret: connect-license secretKey: connect.lic ``` diff --git a/charts/rstudio-pm/README.md b/charts/rstudio-pm/README.md index 702d68b8..41d71c94 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -73,7 +73,8 @@ Second, specify the following values: ```yaml license: file: - secret: package-manager-license + + secret: package-manager-license secretKey: package-manager.lic ``` diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index 46705f84..eb504880 100644 --- a/charts/rstudio-workbench/README.md +++ b/charts/rstudio-workbench/README.md @@ -107,7 +107,8 @@ Second, specify the following values: ```yaml license: file: - secret: workbench-license + + secret: workbench-license secretKey: workbench.lic ``` From 652253d01bb539b74e65f05cf40ce1367b978fb8 Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Mon, 27 Nov 2023 14:15:33 -0500 Subject: [PATCH 28/31] Whitespace fix indent --- charts/_templates.gotmpl | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/charts/_templates.gotmpl b/charts/_templates.gotmpl index 541038f9..dade23c9 100644 --- a/charts/_templates.gotmpl +++ b/charts/_templates.gotmpl @@ -115,7 +115,7 @@ First, create the secret declaratively with YAML or imperatively using the follo {{ else if eq .Name "rstudio-workbench" -}} `kubectl create secret generic workbench-license --from-file=licenses/workbench.lic` {{ else -}} -{{ template "chart.header" . }} +`kubectl create secret generic license --from-file=licenses/license.lic` {{- end }} Second, specify the following values: @@ -123,17 +123,18 @@ Second, specify the following values: ```yaml license: file: - {{ if eq .Name "rstudio-connect" }} + {{- if eq .Name "rstudio-connect" }} secret: connect-license secretKey: connect.lic - {{ else if eq .Name "rstudio-pm" }} + {{- else if eq .Name "rstudio-pm" }} secret: package-manager-license secretKey: package-manager.lic - {{ else if eq .Name "rstudio-workbench" }} + {{- else if eq .Name "rstudio-workbench" }} secret: workbench-license secretKey: workbench.lic - {{ else }} -{{ template "chart.header" . }} + {{- else }} + secret: license + secretKey: license.lic {{ end }} ``` @@ -147,7 +148,7 @@ Alternatively, license files can be set during `helm install` with the following {{ else if eq .Name "rstudio-workbench" -}} `--set-file license.file.contents=licenses/workbench.lic` {{ else -}} -{{ template "chart.header" . }} +`--set-file license.file.contents=licenses/license.lic` {{- end }} ### License Key From a8cffbf567a0859e0437483d0a9e1646592e7c44 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 27 Nov 2023 19:16:02 +0000 Subject: [PATCH 29/31] Update helm-docs and README.md --- charts/rstudio-connect/README.md | 2 -- charts/rstudio-pm/README.md | 2 -- charts/rstudio-workbench/README.md | 2 -- 3 files changed, 6 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index 609471b4..89372dc2 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -81,10 +81,8 @@ Second, specify the following values: ```yaml license: file: - secret: connect-license secretKey: connect.lic - ``` Alternatively, license files can be set during `helm install` with the following argument: diff --git a/charts/rstudio-pm/README.md b/charts/rstudio-pm/README.md index 41d71c94..f4ca9dd9 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -73,10 +73,8 @@ Second, specify the following values: ```yaml license: file: - secret: package-manager-license secretKey: package-manager.lic - ``` Alternatively, license files can be set during `helm install` with the following argument: diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index eb504880..d3ee1531 100644 --- a/charts/rstudio-workbench/README.md +++ b/charts/rstudio-workbench/README.md @@ -107,10 +107,8 @@ Second, specify the following values: ```yaml license: file: - secret: workbench-license secretKey: workbench.lic - ``` Alternatively, license files can be set during `helm install` with the following argument: From 0adf45c58504dfda8de5a039320adfb129a04084 Mon Sep 17 00:00:00 2001 From: Trevor Nederlof Date: Mon, 27 Nov 2023 14:53:18 -0500 Subject: [PATCH 30/31] Simplify template --- charts/_templates.gotmpl | 36 ++++-------------------------------- 1 file changed, 4 insertions(+), 32 deletions(-) diff --git a/charts/_templates.gotmpl b/charts/_templates.gotmpl index dade23c9..b8b963c3 100644 --- a/charts/_templates.gotmpl +++ b/charts/_templates.gotmpl @@ -108,48 +108,20 @@ We recommend storing a license file as a `Secret` and setting the `license.file. First, create the secret declaratively with YAML or imperatively using the following command: - {{ if eq .Name "rstudio-connect" -}} -`kubectl create secret generic connect-license --from-file=licenses/connect.lic` - {{ else if eq .Name "rstudio-pm" -}} -`kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic` - {{ else if eq .Name "rstudio-workbench" -}} -`kubectl create secret generic workbench-license --from-file=licenses/workbench.lic` - {{ else -}} -`kubectl create secret generic license --from-file=licenses/license.lic` - {{- end }} +`kubectl create secret generic {{ .Name }}-license --from-file=licenses/{{ .Name }}.lic` Second, specify the following values: ```yaml license: file: - {{- if eq .Name "rstudio-connect" }} - secret: connect-license - secretKey: connect.lic - {{- else if eq .Name "rstudio-pm" }} - secret: package-manager-license - secretKey: package-manager.lic - {{- else if eq .Name "rstudio-workbench" }} - secret: workbench-license - secretKey: workbench.lic - {{- else }} - secret: license - secretKey: license.lic - {{ end }} + secret: {{ .Name }}-license + secretKey: {{ .Name }}.lic ``` - Alternatively, license files can be set during `helm install` with the following argument: - {{ if eq .Name "rstudio-connect" -}} -`--set-file license.file.contents=licenses/connect.lic` - {{ else if eq .Name "rstudio-pm" -}} -`--set-file license.file.contents=licenses/package-manager.lic` - {{ else if eq .Name "rstudio-workbench" -}} -`--set-file license.file.contents=licenses/workbench.lic` - {{ else -}} -`--set-file license.file.contents=licenses/license.lic` - {{- end }} +`--set-file license.file.contents=licenses/{{ .Name }}.lic` ### License Key From 65b100bf89df0ec7942403ef3a63e77d62765bc4 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 27 Nov 2023 20:24:29 +0000 Subject: [PATCH 31/31] Update helm-docs and README.md --- charts/rstudio-connect/README.md | 10 ++++------ charts/rstudio-pm/README.md | 10 ++++------ charts/rstudio-workbench/README.md | 10 ++++------ 3 files changed, 12 insertions(+), 18 deletions(-) diff --git a/charts/rstudio-connect/README.md b/charts/rstudio-connect/README.md index 89372dc2..e4afddc5 100644 --- a/charts/rstudio-connect/README.md +++ b/charts/rstudio-connect/README.md @@ -73,22 +73,20 @@ We recommend storing a license file as a `Secret` and setting the `license.file. First, create the secret declaratively with YAML or imperatively using the following command: - `kubectl create secret generic connect-license --from-file=licenses/connect.lic` - +`kubectl create secret generic rstudio-connect-license --from-file=licenses/rstudio-connect.lic` Second, specify the following values: ```yaml license: file: - secret: connect-license - secretKey: connect.lic + 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/connect.lic` - +`--set-file license.file.contents=licenses/rstudio-connect.lic` ### License Key diff --git a/charts/rstudio-pm/README.md b/charts/rstudio-pm/README.md index f4ca9dd9..8ae10348 100644 --- a/charts/rstudio-pm/README.md +++ b/charts/rstudio-pm/README.md @@ -65,22 +65,20 @@ We recommend storing a license file as a `Secret` and setting the `license.file. First, create the secret declaratively with YAML or imperatively using the following command: - `kubectl create secret generic package-manager-license --from-file=licenses/package-manager.lic` - +`kubectl create secret generic rstudio-pm-license --from-file=licenses/rstudio-pm.lic` Second, specify the following values: ```yaml license: file: - secret: package-manager-license - secretKey: package-manager.lic + 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/package-manager.lic` - +`--set-file license.file.contents=licenses/rstudio-pm.lic` ### License Key diff --git a/charts/rstudio-workbench/README.md b/charts/rstudio-workbench/README.md index d3ee1531..6f2a502a 100644 --- a/charts/rstudio-workbench/README.md +++ b/charts/rstudio-workbench/README.md @@ -99,22 +99,20 @@ We recommend storing a license file as a `Secret` and setting the `license.file. First, create the secret declaratively with YAML or imperatively using the following command: - `kubectl create secret generic workbench-license --from-file=licenses/workbench.lic` - +`kubectl create secret generic rstudio-workbench-license --from-file=licenses/rstudio-workbench.lic` Second, specify the following values: ```yaml license: file: - secret: workbench-license - secretKey: workbench.lic + 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/workbench.lic` - +`--set-file license.file.contents=licenses/rstudio-workbench.lic` ### License Key