Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
LuluGO authored Aug 15, 2023
1 parent d0c5ea9 commit 6f9dedb
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# k8s-secrets-backup

### :thinking: What is it?
### 🤔: What is it?
A generic tool to backup kubernetes secrets, encrypt the backup and upload it to a S3 bucket.

It was designed to run as a cronjob inside our Kubernetes clusters to backup sealed secrets controller's keys, but it can be used to backup any secret, or secrets depending if the env variable SECRET_NAME is set, or LABEL_KEY and LABEL_VALUE is. If a label key and value to filter a set of secrets is set, then the output is a k8s SecretList.

Important note: It assumes a configmap with the k8s cluster name is previously created on the kube-system namespace. More info on Kubernetes manifests examples section.

Another less important note: Age encryption is done to an ASCII-only "armored" encoding, decryption is transparent for age command.
Another less important note: Age encryption is done to an ASCII-only "armored" encoding, decryption is transparent for the age command.

#### :ballot_box_with_check: Environment variables (required, except if explicity says optional)
| Name | Example | Help |
Expand All @@ -24,7 +24,7 @@ AWS_SECRET_ACCESS_KEY | "asdASFadfasdfñiouo3Q334" | AWS access se
AGE_PUBLIC_KEY | "age435fgañdfgjñdsflgjgadf" | Age public key matching your private key for decrypt


#### :genie: Kubernetes manifests (examples)
#### 🧞: Kubernetes manifests (examples)

Backup sealed secrets controller's keys once per month
```
Expand All @@ -42,7 +42,7 @@ spec:
serviceAccountName: sealed-secrets-keys-sentinel
containers:
- name: sealed-secrets-keys-sentinel
image: k8s-secrets-backup
image: rocketchat/k8s-secrets-backup
imagePullPolicy: Always
env:
- name: NAMESPACE
Expand Down

0 comments on commit 6f9dedb

Please sign in to comment.