ashrafulislamcs/k8s-db-backup

K8s db backup

Containerized backup agent for MySQL with AWS and OCI S3 bucket support. This container can be used to automatically create a logical backup of databases and store them on S3 object storage compatible provider. Supported providers are: aws and oci

Requirements

The only requirements is to have enough free space on your kubernetes worker/docker swarm node/docker node to store the logical backup before it is transferred to the object storage.

Supported environment variables

Var	Required	Desc
S3_PROVIDER	always	S3 compatible provider. Supported providers: aws, oci
AWS_SECRET_KEY	aws	aws secret key
AWS_ACCESS_KEY	aws	aws access key
AWS_REGION	aws	aws region
AWS_BUCKET_NAME	aws	aws bucket name
OCI_SECRET_KEY	oci	oci secret key
OCI_ACCESS_KEY	oci	oci access key
OCI_REGION	oci	oci region
OCI_BUCKET_NAME	oci	oci bucket name
OCI_NAMESPACE	oci	oci namespace. Follow Understanding Object Storage Namespaces on OCI provider setup
BACKUP_PATH_PREFIX	no	Local and remote prefix where the backups will be stored. Default: k8s-db-backup
BACKUP_STRATEGY	no	Define the backup strategy: single dump or split backup by tables. Default: SINGLE_FILE_DUMP. Supported strategies are SINGLE_FILE_DUMP and SPLIT_BY_TABLE

Note on required column:

• always variable always required
• aws or oci specific provider variable
• no optional/not required variable

AWS provider setup

To get the AWS secret and access key follow the links below:

• Accessing AWS using your AWS credentials
• Managing access keys for IAM users

OCI provider setup

To get the ICI secret and access key follow the links below:

• Managing User Credentials
• Understanding Object Storage Namespaces