Auto-Backup Service of ETCD snapshot data according to Kubernetes cluster update
Helm Chart
·
Code Repo
- ETCD is a data store for managing cluster state information.
- ETCD plays an important role in maintaining the stability and reliability of the cluster.
- If ETCD data is stored in a cloud environment to prevent accidents, the risk of data loss can be reduced.
- ETCD-AutoBackup Service uses etcd's Watch API to detect data changes and schedule jobs that create and save snapshots.
| File | Description |
|---|---|
watch-events.py |
Deploy job by detecting cluster changes through the watch api |
etcd-deployment.yaml |
Run watch-events.py code in singleton pattern |
etcd-backup-configmap.yaml |
Save script data that runs etcdctl commands and saves snapshots to cloud storage. |
etcd-backup-job.yaml |
Execute stored shell script via configmap |
☁️ Save snapshot data at Cloud
- Save the snapshot data in a cloud provider of your choice.
- Provided vendor : AWS, OCI, NCP
🧸 User-friendly
- Provides ease of use through Helm packaging.
- Just fill in the
values.yamlaccording to the user.
🕹️ Versioning
- Seperation of hot data(60 days, archiving) and cold data(180 days, deletion) using lifecycle policy.
- Currently only available in AWS.
🎈 Singleton Pattern
- One application must be running at a time so that jobs are not duplicated (snapshots are not duplicated).
- Adopt Singleton Pattern to activate only one application instance at the same time
The following table lists the configurable parameters for vaules.yaml of the etcd-autobackup chart and their default values.
| Parameter | Description | Default |
|---|---|---|
etcd.cert_path (required) |
Value of the directory path containing ca.crt, server.crt, server.key. |
/etc/kubernetes/pki/etcd/ |
etcd.endpoint (required) |
Value of endpoint of etcd. This must contain port number and must be a private IP. | none |
cloudProvider (required) |
The cloud provider where you want to save the snapshot. You can choose from aws, oci or ncp. |
oci |
oci.user_ocid |
If you choose oci, value of user ocid. ocid1.user.oci1..xxxxxxx |
none |
oci.tenancy_ocid |
If you choose oci, value of tenancy ocid. ocid1.tenancy.oc1..xxxxxxx |
none |
oci.api_key_path |
If you choose oci, value of the path of oci api key. This must exist on the master node. Write the path from the master node. | none |
oci.bucket_region |
If you choose oci, value of bucket region. | none |
oci.namespace |
If you choose oci, value of namsapce. | none |
aws.access_key_id |
If you choose aws, value of access key id | none |
aws.secret_access_key |
If you choose aws, value of secret access key | none |
aws.region |
If you choose aws, value of default region for aws cli | none |
ncp.access_key_id |
If you choose ncp, value of access key id | none |
ncp.secret_access_key |
If you choose ncp, value secret access key | none |
ncp.region |
If you choose ncp, value of default region | none |
Helm must be installed to use the charts. Please refer to Helm's documentation to get started.
- Once Helm is set up properly, add the repo as follows:
helm repo add etcd-autobackup https://jujy-oidc.github.io/etcd-autobackup-helm-repo/You can then run helm search repo etcd-autobackup to see the charts.
- Download
values.yamland write it according to your convenience.
wget https://github.com/JUJY-OIDC/etcd-autobackup-helm-repo/blob/main/helm-chart/values.yaml- Specify
values.yamlusing--valuesoption and install helm chart.
Make sure the values.yaml path is clear.
helm install etcd-autobackup etcd-autobackup/etcd-autobackup --values=values.yamlAll objects created by helm are managed in the etcd-autobackup namespace.
When the installation is complete, you can see that the CronJob and ConfigMap are created.
(목표) apache or MIT
 김주영 |
 성나영 |
 정지우 |
 현유경 |