Improve documentation and ergonomics for using `rstudioPMKey`
@atheriel is already working on this.
Since Mar 16, 2022.
- Dominant language
- Markdown
- Stars
- 46
- Forks
- 40
- Avg merge
- 4h 3m
- Merged PRs (30d)
- 6
Description
To run RSPM in high availability mode you may need to set the rstudioPMKey value correctly. From the upstream docs:
When using S3 for shared storage, each server's Server.EncryptionKeyPath must point to a file that contains the same encryption key.
I think this might actually be incomplete; from my reading (and looking at some internal references) you also need to set this if you make use of any encrypted configuration fields.
Unfortunately, there isn't much guidance to help users actually generate these files, and the upstream docs seem to expect you have the RSPM CLI accessible locally, which might not be the case.
I think a small tutorial in the README would be a good addition, and it would be ideal if we could actually generate these key files in Helm directly during installation.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.