Skip to content

Commit 8889798

Browse files
kfeinauerkfeinauer
authored
Merge pull request #7 from rstudio/rstudio-pm-public-readme
Rstudio pm public readme
2 parents da98ba3 + 7a272f1 commit 8889798

File tree

6 files changed

+92
-17
lines changed

6 files changed

+92
-17
lines changed

‎README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,13 @@
1818

1919
## Support
2020

21-
We have a few outlets for getting support with our projects:
21+
**IMPORTANT:**
2222

23-
- Bugs or feature requests should be opened in an [issue](https://github.com/rstudio/helm/issues/new/choose).
24-
- Professional support for our Helm charts can be obtained by emailing [email protected]. Please note that email support is limited to our professional products customers.
23+
These charts are provided as a convenience to RStudio customers and are not formally supported by RStudio. If you
24+
have questions about these charts, you can ask them in the [issues](https://github.com/rstudio/helm/issues/new/choose)
25+
in the repository or to your support representative, who will route them appropriately.
26+
27+
Bugs or feature requests should be opened in an [issue](https://github.com/rstudio/helm/issues/new/choose).
2528

2629
## Contributing
2730

‎charts/rstudio-pm/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: rstudio-pm
22
description: Kubernetes deployment for RStudio Package Manager
3-
version: 0.2.0-rc04
3+
version: 0.2.0-rc05
44
apiVersion: v2
55
appVersion: 1.2.2.1-17
66
icon: https://rstudio.com/wp-content/uploads/2018/10/RStudio-Logo-Flat.png

‎charts/rstudio-pm/README.md

+36-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Kubernetes deployment for RStudio Package Manager
44

5-
![Version: 0.2.0-rc04](https://img.shields.io/badge/Version-0.2.0--rc04-informational?style=flat-square) ![AppVersion: 1.2.2.1-17](https://img.shields.io/badge/AppVersion-1.2.2.1--17-informational?style=flat-square)
5+
![Version: 0.2.0-rc05](https://img.shields.io/badge/Version-0.2.0--rc05-informational?style=flat-square) ![AppVersion: 1.2.2.1-17](https://img.shields.io/badge/AppVersion-1.2.2.1--17-informational?style=flat-square)
66

77
## Disclaimer
88

@@ -20,11 +20,44 @@ changes, as well as documentation below on how to use the chart
2020

2121
## Installing the Chart
2222

23-
To install the chart with the release name `my-release` at version 0.2.0-rc04:
23+
To install the chart with the release name `my-release` at version 0.2.0-rc05:
2424

2525
```bash
2626
helm repo add rstudio https://helm.rstudio.com
27-
helm install my-release rstudio/rstudio-pm --version=0.2.0-rc04
27+
helm install my-release rstudio/rstudio-pm --version=0.2.0-rc05
28+
```
29+
30+
## Required Configuration
31+
32+
This chart requires the following in order to function:
33+
34+
* A license key, license file, or address of a running license server. See the `license` configuration below.
35+
* A Kubernetes [PersistentVolume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) that contains the data directory for RSPM.
36+
* If `sharedStorage.create` is set, a PVC that relies on the default storage class will be created to generate the PersistentVolume.
37+
Most Kubernetes environments do not have a default storage class that you can use with `ReadWriteMany` access mode out-of-the-box.
38+
In this case, we recommend you disable `sharedStorage.create` and create your own `PersistentVolume` and `PersistentVolumeClaim`, then
39+
mount them into the container by specifying the `pod.volumes` and `pod.volumeMounts` parameters.
40+
* If you cannot use a `PersistentVolume` to properly mount your data directory, you'll need to mount your data in the container
41+
by using a regular [Kubernetes Volume](https://kubernetes.io/docs/concepts/storage/volumes), specified in `pod.volumes` and `pod.volumeMounts`.
42+
* Alternatively, S3 storage can be used. See the next section for details.
43+
44+
## S3 Configuration
45+
46+
Package Manager can be configured to store data in S3 buckets (see the [Admin Guide](https://docs.rstudio.com/rspm/admin/files-directories/#data-destinations)
47+
for more details). When configured this way, AWS access credentials are required. You must set the `awsAccessKeyId` and `awsSecretAccessKey` chart values
48+
to ensure that RSPM will be able to authenticate with your configured S3 buckets.
49+
50+
Configuring Package Manager to use S3 requires modifying the `.gfcg` configuration file as explained below. A sample chart values configuration might look like the following:
51+
52+
```
53+
awsAccessKeyId: your-access-key-id
54+
awsSecretAccessKey: your-secret-access-key
55+
56+
config:
57+
Storage:
58+
Default: s3
59+
S3Storage:
60+
Bucket: your-s3-bucket
2861
```
2962

3063
## General Principles

‎charts/rstudio-pm/README.md.gotmpl

+33
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,39 @@
77

88
{{ template "rstudio.install" . }}
99

10+
## Required Configuration
11+
12+
This chart requires the following in order to function:
13+
14+
* A license key, license file, or address of a running license server. See the `license` configuration below.
15+
* A Kubernetes [PersistentVolume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) that contains the data directory for RSPM.
16+
* If `sharedStorage.create` is set, a PVC that relies on the default storage class will be created to generate the PersistentVolume.
17+
Most Kubernetes environments do not have a default storage class that you can use with `ReadWriteMany` access mode out-of-the-box.
18+
In this case, we recommend you disable `sharedStorage.create` and create your own `PersistentVolume` and `PersistentVolumeClaim`, then
19+
mount them into the container by specifying the `pod.volumes` and `pod.volumeMounts` parameters.
20+
* If you cannot use a `PersistentVolume` to properly mount your data directory, you'll need to mount your data in the container
21+
by using a regular [Kubernetes Volume](https://kubernetes.io/docs/concepts/storage/volumes), specified in `pod.volumes` and `pod.volumeMounts`.
22+
* Alternatively, S3 storage can be used. See the next section for details.
23+
24+
## S3 Configuration
25+
26+
Package Manager can be configured to store data in S3 buckets (see the [Admin Guide](https://docs.rstudio.com/rspm/admin/files-directories/#data-destinations)
27+
for more details). When configured this way, AWS access credentials are required. You must set the `awsAccessKeyId` and `awsSecretAccessKey` chart values
28+
to ensure that RSPM will be able to authenticate with your configured S3 buckets.
29+
30+
Configuring Package Manager to use S3 requires modifying the `.gfcg` configuration file as explained below. A sample chart values configuration might look like the following:
31+
32+
```
33+
awsAccessKeyId: your-access-key-id
34+
awsSecretAccessKey: your-secret-access-key
35+
36+
config:
37+
Storage:
38+
Default: s3
39+
S3Storage:
40+
Bucket: your-s3-bucket
41+
```
42+
1043
## General Principles
1144

1245
- In most places, we opt to pass helm values over configmaps. We translate these into the valid `.gcfg` file format

‎charts/rstudio-workbench/README.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,14 @@ This chart requires the following in order to function:
3333

3434
* A license key, license file, or address of a running license server. See the `license` configuration below.
3535
* A Kubernetes [PersistentVolume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) that contains the home directory for users.
36-
* If `homeStorage.create` is set, a PVC that relies on the default storage class will be used. Most Kubernetes environments do not have a default
37-
storage class that you can use with `ReadWriteMany` access mode out-of-the-box. In this case, we recommend you disable `homeStorage.create` and
38-
create your own `PersistentVolume` and `PersistentVolumeClaim`, then mount them into the container by specifying the `pod.volumes` and `pod.volumeMounts` parameters.
39-
* If you cannot use a `PersistentVolume` to properly mount your users' home directories, you'll need to manually mount your NFS server in the container during startup
40-
with a mechanism similar to what is described below for joining to auth domains.
36+
* If `homeStorage.create` is set, a PVC that relies on the default storage class will be created to generate the PersistentVolume.
37+
Most Kubernetes environments do not have a default storage class that you can use with `ReadWriteMany` access mode out-of-the-box.
38+
In this case, we recommend you disable `homeStorage.create` and create your own `PersistentVolume` and `PersistentVolumeClaim`, then mount them
39+
into the container by specifying the `pod.volumes` and `pod.volumeMounts` parameters.
40+
* If you cannot use a `PersistentVolume` to properly mount your users' home directories, you'll need to mount your data in the container
41+
by using a regular [Kubernetes Volume](https://kubernetes.io/docs/concepts/storage/volumes/#nfs), specified in `pod.volumes` and `pod.volumeMounts`.
42+
* If you cannot use a `Volume` to mount the directories, you'll need to manually mount them during container startup with a mechanism similar to what
43+
is described below for joining to auth domains.
4144
* If not using `homeStorage.create`, you'll need to configure `config.serverDcf.launcher-mounts` to ensure that the correct mounts are used when users create new sessions.
4245
* If using load balancing (by setting `replicas > 1`), you will need similar storage defined for `sharedStorage` to store shared project configuration.
4346
* A method to join the deployed `rstudio-workbench` container to your auth domain. The default `rstudio/rstudio-server-pro` image does not contain a way to join domains.

‎charts/rstudio-workbench/README.md.gotmpl

+8-5
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,14 @@ This chart requires the following in order to function:
1313

1414
* A license key, license file, or address of a running license server. See the `license` configuration below.
1515
* A Kubernetes [PersistentVolume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) that contains the home directory for users.
16-
* If `homeStorage.create` is set, a PVC that relies on the default storage class will be used. Most Kubernetes environments do not have a default
17-
storage class that you can use with `ReadWriteMany` access mode out-of-the-box. In this case, we recommend you disable `homeStorage.create` and
18-
create your own `PersistentVolume` and `PersistentVolumeClaim`, then mount them into the container by specifying the `pod.volumes` and `pod.volumeMounts` parameters.
19-
* If you cannot use a `PersistentVolume` to properly mount your users' home directories, you'll need to manually mount your NFS server in the container during startup
20-
with a mechanism similar to what is described below for joining to auth domains.
16+
* If `homeStorage.create` is set, a PVC that relies on the default storage class will be created to generate the PersistentVolume.
17+
Most Kubernetes environments do not have a default storage class that you can use with `ReadWriteMany` access mode out-of-the-box.
18+
In this case, we recommend you disable `homeStorage.create` and create your own `PersistentVolume` and `PersistentVolumeClaim`, then mount them
19+
into the container by specifying the `pod.volumes` and `pod.volumeMounts` parameters.
20+
* If you cannot use a `PersistentVolume` to properly mount your users' home directories, you'll need to mount your data in the container
21+
by using a regular [Kubernetes Volume](https://kubernetes.io/docs/concepts/storage/volumes/#nfs), specified in `pod.volumes` and `pod.volumeMounts`.
22+
* If you cannot use a `Volume` to mount the directories, you'll need to manually mount them during container startup with a mechanism similar to what
23+
is described below for joining to auth domains.
2124
* If not using `homeStorage.create`, you'll need to configure `config.serverDcf.launcher-mounts` to ensure that the correct mounts are used when users create new sessions.
2225
* If using load balancing (by setting `replicas > 1`), you will need similar storage defined for `sharedStorage` to store shared project configuration.
2326
* A method to join the deployed `rstudio-workbench` container to your auth domain. The default `rstudio/rstudio-server-pro` image does not contain a way to join domains.

0 commit comments

Comments
 (0)