diff options
Diffstat (limited to 'kubernetes/README.md')
| -rw-r--r-- | kubernetes/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/kubernetes/README.md b/kubernetes/README.md new file mode 100644 index 0000000..2c96a68 --- /dev/null +++ b/kubernetes/README.md @@ -0,0 +1,16 @@ +# Kubernetes +Configuration and documentation for Python Discord's Kubernetes setup! + +## Secrets +We use [git-crypt](https://www.agwa.name/projects/git-crypt/) ([Github](https://github.com/AGWA/git-crypt))to secure secrets. Using this means we can commit secrets to change control, without the secrets being leaked. + +The [.gitattributes](.gitattributes) is used to determine which files to encrypt. See [git-crypt](https://www.agwa.name/projects/git-crypt/) documentation for more information. + +To work with our secrets, you must have your GPG key added by a member of the devops team. Once that is done, you can use git-crypt as documented. + +### git-crypt tl;dr +- Get/build a git-crypt binary from [Github](https://github.com/AGWA/git-crypt) +- Rename the binary to `git-crypt` +- Add binary to your PATH +- Run `git-crypt unlock` from this project's root directory. +See [git-crypt](https://www.agwa.name/projects/git-crypt/) documentation for more information. |