Skip to content

Commit

Permalink
update workbench documentation reference for job-json-overrides
Browse files Browse the repository at this point in the history
  • Loading branch information
colearendt committed Apr 12, 2022
1 parent 977722e commit 99eb5b2
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 6 deletions.
2 changes: 1 addition & 1 deletion charts/rstudio-workbench/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: rstudio-workbench
description: Official Helm chart for RStudio Workbench
version: 0.5.10
version: 0.5.11
apiVersion: v2
appVersion: 2022.02.1-461.pro1
icon: https://rstudio.com/wp-content/uploads/2018/10/RStudio-Logo-Flat.png
Expand Down
4 changes: 4 additions & 0 deletions charts/rstudio-workbench/NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# 0.5.11

- Update docs for `job-json-overrides` (fix a key reference issue and link to new docs in the helm repo)

# 0.5.10

- Fix ingress definition issues with older Kubernetes clusters ([#139](https://github.com/rstudio/helm/issues/139))
Expand Down
10 changes: 6 additions & 4 deletions charts/rstudio-workbench/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RStudio Workbench

![Version: 0.5.10](https://img.shields.io/badge/Version-0.5.10-informational?style=flat-square) ![AppVersion: 2022.02.1-461.pro1](https://img.shields.io/badge/AppVersion-2022.02.1--461.pro1-informational?style=flat-square)
![Version: 0.5.11](https://img.shields.io/badge/Version-0.5.11-informational?style=flat-square) ![AppVersion: 2022.02.1-461.pro1](https://img.shields.io/badge/AppVersion-2022.02.1--461.pro1-informational?style=flat-square)

#### _Official Helm chart for RStudio Workbench_

Expand All @@ -23,11 +23,11 @@ As a result, please:

## Installing the Chart

To install the chart with the release name `my-release` at version 0.5.10:
To install the chart with the release name `my-release` at version 0.5.11:

```bash
helm repo add rstudio https://helm.rstudio.com
helm install my-release rstudio/rstudio-workbench --version=0.5.10
helm install my-release rstudio/rstudio-workbench --version=0.5.11
```

## Required Configuration
Expand Down Expand Up @@ -286,7 +286,7 @@ some-key2: value2

If you want to customize the job launch process (i.e. how sessions are defined), you will need to edit the following
configuration:
- modify `config.profiles.launcher.kubernetes.profiles.conf.<< some selector >>.job-json-overrides`
- modify `config.profiles.launcher\.kubernetes\.profiles\.conf.<< some selector >>.job-json-overrides`
- create an array of maps with the following keys:
- `target`: the "target" part of the job spec to replace
- `name`: a unique identifier (ideally with no spaces) that will become a config filename on disk
Expand All @@ -296,6 +296,8 @@ Note that several examples are provided
in [this support article](https://support.rstudio.com/hc/en-us/articles/360051652094-Using-Job-Json-Overrides-with-RStudio-Server-Pro-and-Kubernetes)
(however, examples do not use the helm chart syntax there).

Alternatively, you can explore the docs in the [helm repository](https://github.com/rstudio/helm/blob/main/docs/customize.md)

```yaml
config:
profiles:
Expand Down
4 changes: 3 additions & 1 deletion charts/rstudio-workbench/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ some-key2: value2

If you want to customize the job launch process (i.e. how sessions are defined), you will need to edit the following
configuration:
- modify `config.profiles.launcher.kubernetes.profiles.conf.<< some selector >>.job-json-overrides`
- modify `config.profiles.launcher\.kubernetes\.profiles\.conf.<< some selector >>.job-json-overrides`
- create an array of maps with the following keys:
- `target`: the "target" part of the job spec to replace
- `name`: a unique identifier (ideally with no spaces) that will become a config filename on disk
Expand All @@ -274,6 +274,8 @@ Note that several examples are provided
in [this support article](https://support.rstudio.com/hc/en-us/articles/360051652094-Using-Job-Json-Overrides-with-RStudio-Server-Pro-and-Kubernetes)
(however, examples do not use the helm chart syntax there).

Alternatively, you can explore the docs in the [helm repository](https://github.com/rstudio/helm/blob/main/docs/customize.md)

```yaml
config:
profiles:
Expand Down

0 comments on commit 99eb5b2

Please sign in to comment.