aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Chris Lovering <[email protected]>2023-08-14 15:35:06 +0100
committerGravatar Chris Lovering <[email protected]>2023-08-14 15:35:06 +0100
commit4cd61362fb59350a13a15a2de5acf1b7b0eea48d (patch)
tree1e77565742455280e353c65425e454232d91be99
parentUpdate query docs with recommendations (diff)
Add further infomraiton to READMEs
Co-authored-by: jchristgit <[email protected]>
-rw-r--r--kubernetes/README.md4
-rw-r--r--kubernetes/namespaces/cert-manager/cert-manager/README.md2
2 files changed, 3 insertions, 3 deletions
diff --git a/kubernetes/README.md b/kubernetes/README.md
index 2c96a68..e3dff37 100644
--- a/kubernetes/README.md
+++ b/kubernetes/README.md
@@ -6,10 +6,10 @@ We use [git-crypt](https://www.agwa.name/projects/git-crypt/) ([Github](https://
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.
+To work with our secrets, you must have your GPG key's [validity attested](https://en.wikipedia.org/wiki/Keysigning) **and** added to the repo 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)
+- Get/build a git-crypt binary from [GitHub](https://github.com/AGWA/git-crypt) or your favourite package manager
- Rename the binary to `git-crypt`
- Add binary to your PATH
- Run `git-crypt unlock` from this project's root directory.
diff --git a/kubernetes/namespaces/cert-manager/cert-manager/README.md b/kubernetes/namespaces/cert-manager/cert-manager/README.md
index a7389e6..45c94b5 100644
--- a/kubernetes/namespaces/cert-manager/cert-manager/README.md
+++ b/kubernetes/namespaces/cert-manager/cert-manager/README.md
@@ -4,7 +4,7 @@ X.509 certificate management for Kubernetes.
> cert-manager builds on top of Kubernetes, introducing certificate authorities and certificates as first-class resource types in the Kubernetes API. This makes it possible to provide to developers 'certificates as a service' in your Kubernetes cluster.
-We install cert-mamnanger through [Helm using this guide](https://cert-manager.io/docs/installation/kubernetes/#installing-with-helm).
+We install cert-manager through [Helm using this guide](https://cert-manager.io/docs/installation/kubernetes/#installing-with-helm).
## Directories