You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 27, 2024. It is now read-only.
kubernetes-s3-mysql-backup is a container image based on Alpine Linux. This container is designed to run in Kubernetes as a cronjob to perform automatic backups of MySQL databases to Amazon S3. It was created to meet my requirements for regular and automatic database backups. Having started with a relatively basic feature set, it is gradually growing to add more and more features.
3
+
kubernetes-cloud-mysql-backup is a container image based on Alpine Linux. This container is designed to run in Kubernetes as a cronjob to perform automatic backups of MySQL databases to Amazon S3 or Google Cloud Storage. It was created to meet my requirements for regular and automatic database backups. Having started with a relatively basic feature set, it is gradually growing to add more and more features.
4
4
5
-
Currently, kubernetes-s3-mysql-backup supports the backing up of MySQL Databases. It can perform backups of multiple MySQL databases from a single database host. When triggered, a full database dump is performed using the `mysqldump` command for each configured database. The backup(s) are then uploaded to an Amazon S3 Bucket. kubernetes-s3-mysql-backup features Slack Integration, and can post messages into a channel detailing if the backup(s) were successful or not.
5
+
Currently, kubernetes-cloud-mysql-backup supports the backing up of MySQL Databases. It can perform backups of multiple MySQL databases from a single database host. When triggered, a full database dump is performed using the `mysqldump` command for each configured database. The backup(s) are then uploaded to an Amazon S3 Bucket or a Google Cloud Storage Bucket. kubernetes-cloud-mysql-backup features Slack Integration, and can post messages into a channel detailing if the backup(s) were successful or not.
6
6
7
-
Over time, kubernetes-s3-mysql-backup will be updated to support more features and functionality. I currently use this container as part of my Kubernetes Architecture which you can read about [here](https://benjamin.maynard.io/this-blog-now-runs-on-kubernetes-heres-the-architecture/).
7
+
Over time, kubernetes-cloud-mysql-backup will be updated to support more features and functionality. I currently use this container as part of my Kubernetes Architecture which you can read about [here](https://benjamin.maynard.io/this-blog-now-runs-on-kubernetes-heres-the-architecture/).
8
8
9
9
All changes are captured in the [changelog](CHANGELOG.md), which adheres to [Semantic Versioning](https://semver.org/spec/vadheres2.0.0.html).
10
10
11
11
12
12
## Environment Variables
13
13
14
-
The below table lists all of the Environment Variables that are configurable for kubernetes-s3-mysql-backup.
| AWS_ACCESS_KEY_ID |**(Required)** AWS IAM Access Key ID. |
19
-
| AWS_SECRET_ACCESS_KEY |**(Required)** AWS IAM Secret Access Key. Should have very limited IAM permissions (see below for example) and should be configured using a Secret in Kubernetes. |
20
-
| AWS_DEFAULT_REGION |**(Required)** Region of the S3 Bucket (e.g. eu-west-2). |
21
-
| AWS_BUCKET_NAME |**(Required)** The name of the S3 bucket. |
22
-
| AWS_BUCKET_BACKUP_PATH |**(Required)** Path the backup file should be saved to in S3. E.g. `/database/myblog/backups`. **Do not put a trailing / or specify the filename.**|
23
-
| TARGET_DATABASE_HOST |**(Required)** Hostname or IP address of the MySQL Host. |
24
-
| TARGET_DATABASE_PORT |**(Optional)** Port MySQL is listening on (Default: 3306). |
25
-
| TARGET_DATABASE_NAMES |**(Required)** Name of the databases to dump. This should be comma seperated (e.g. `database1,database2`). |
26
-
| TARGET_DATABASE_USER |**(Required)** Username to authenticate to the database with. |
27
-
| TARGET_DATABASE_PASSWORD |**(Required)** Password to authenticate to the database with. Should be configured using a Secret in Kubernetes. |
28
-
| BACKUP_TIMESTAMP |**(Optional)** Date string to append to the backup filename ([date](http://man7.org/linux/man-pages/man1/date.1.html) format). Leave unset if using S3 Versioning and date stamp is not required. |
29
-
| SLACK_ENABLED |**(Optional)** (true/false) Enable or disable the Slack Integration (Default False). |
30
-
| SLACK_USERNAME |**(Optional)** (true/false) Username to use for the Slack Integration (Default: kubernetes-s3-mysql-backup). |
31
-
| SLACK_CHANNEL |**(Required if Slack enabled)** Slack Channel the WebHook is configured for. |
32
-
| SLACK_WEBHOOK_URL |**(Required if Slack enabled)** What is the Slack WebHook URL to post to? Should be configured using a Secret in Kubernetes. |
14
+
The below table lists all of the Environment Variables that are configurable for kubernetes-cloud-mysql-backup.
| BACKUP_PROVIDER |**(Optional)** The backend to use for storing the MySQL backups. Supported options are `aws` (default) or `gcp`|
19
+
| AWS_ACCESS_KEY_ID |**(Required for AWS Backend)** AWS IAM Access Key ID. |
20
+
| AWS_SECRET_ACCESS_KEY |**(Required for AWS Backend)** AWS IAM Secret Access Key. Should have very limited IAM permissions (see below for example) and should be configured using a Secret in Kubernetes. |
21
+
| AWS_DEFAULT_REGION |**(Required for AWS Backend)** Region of the S3 Bucket (e.g. eu-west-2). |
22
+
| AWS_BUCKET_NAME |**(Required for AWS Backend)** The name of the S3 bucket. |
23
+
| AWS_BUCKET_BACKUP_PATH |**(Required for AWS Backend)** Path the backup file should be saved to in S3. E.g. `/database/myblog/backups`. **Do not put a trailing / or specify the filename.**|
24
+
| GCP_GCLOUD_AUTH |**(Required for GCP Backend)** Base64 encoded service account key exported as JSON. Example of how to generate: `base64 ~/service-key.json`|
25
+
| GCP_BUCKET_NAME |**(Required for GCP Backend)** The name of GCP GCS bucket. |
26
+
| GCP_BUCKET_BACKUP_PATH |**(Required for GCP Backend)** Path the backup file should be saved to in GCS. E.g. `/database/myblog/backups`. **Do not put a trailing / or specify the filename.**|
27
+
| TARGET_DATABASE_HOST |**(Required)** Hostname or IP address of the MySQL Host. |
28
+
| TARGET_DATABASE_PORT |**(Optional)** Port MySQL is listening on (Default: 3306). |
29
+
| TARGET_DATABASE_NAMES |**(Required)** Name of the databases to dump. This should be comma seperated (e.g. `database1,database2`). |
30
+
| TARGET_DATABASE_USER |**(Required)** Username to authenticate to the database with. |
31
+
| TARGET_DATABASE_PASSWORD |**(Required)** Password to authenticate to the database with. Should be configured using a Secret in Kubernetes. |
32
+
| BACKUP_TIMESTAMP |**(Optional)** Date string to append to the backup filename ([date](http://man7.org/linux/man-pages/man1/date.1.html) format). Leave unset if using S3 Versioning and date stamp is not required. |
33
+
| SLACK_ENABLED |**(Optional)** (true/false) Enable or disable the Slack Integration (Default False). |
34
+
| SLACK_USERNAME |**(Optional)** (true/false) Username to use for the Slack Integration (Default: kubernetes-cloud-mysql-backup). |
35
+
| SLACK_CHANNEL |**(Required if Slack enabled)** Slack Channel the WebHook is configured for. |
36
+
| SLACK_WEBHOOK_URL |**(Required if Slack enabled)** What is the Slack WebHook URL to post to? Should be configured using a Secret in Kubernetes. |
33
37
34
38
35
39
## Slack Integration
36
40
37
-
kubernetes-s3-mysql-backup supports posting into Slack after each backup job completes. The message posted into the Slack Channel varies as detailed below:
41
+
kubernetes-cloud-mysql-backup supports posting into Slack after each backup job completes. The message posted into the Slack Channel varies as detailed below:
38
42
39
43
* If the backup job is **SUCCESSFUL**: A generic message will be posted into the Slack Channel detailing that all database backups successfully completed.
40
44
* If the backup job is **UNSUCCESSFUL**: A message will be posted into the Slack Channel with a detailed error message for each database that failed.
41
45
42
-
In order to configure kubernetes-s3-mysql-backup to post messages into Slack, you need to create an [Incoming WebHook](https://api.slack.com/incoming-webhooks). Once generated, you can configure kubernetes-s3-mysql-backup using the environment variables detailed above.
46
+
In order to configure kubernetes-cloud-mysql-backup to post messages into Slack, you need to create an [Incoming WebHook](https://api.slack.com/incoming-webhooks). Once generated, you can configure kubernetes-cloud-mysql-backup using the environment variables detailed above.
43
47
44
-
## Configuring the S3 Bucket & AWS IAM User
48
+
## S3 Backend Configuration
45
49
46
-
By default, kubernetes-s3-mysql-backup performs a backup to the same path, with the same filename each time it runs. It therefore assumes that you have Versioning enabled on your S3 Bucket. A typical setup would involve S3 Versioning, with a Lifecycle Policy.
50
+
The below subheadings detail how to configure kubernetes-cloud-mysql-backup to backup to an Amazon S3 backend.
51
+
52
+
### S3 - Configuring the S3 Bucket & AWS IAM User
53
+
54
+
By default, kubernetes-cloud-mysql-backup performs a backup to the same path, with the same filename each time it runs. It therefore assumes that you have Versioning enabled on your S3 Bucket. A typical setup would involve S3 Versioning, with a Lifecycle Policy.
47
55
48
56
If a timestamp is required on the backup file name, the BACKUP_TIMESTAMP Environment Variable can be set.
49
57
50
-
An IAM Users should be created, with API Credentials. An example Policy to attach to the IAM User (for a minimal permissions set) is as follows:
58
+
An IAM User should be created, with API Credentials. An example Policy to attach to the IAM User (for a minimal permissions set) is as follows:
51
59
52
60
```
53
61
{
@@ -72,9 +80,9 @@ An IAM Users should be created, with API Credentials. An example Policy to attac
72
80
```
73
81
74
82
75
-
## Example Kubernetes Cronjob
83
+
### S3 - Example Kubernetes Cronjob
76
84
77
-
An example of how to schedule this container in Kubernetes as a cronjob is below. This would configure a database backup to run each day at 01:00am. The AWS Secret Access Key, and Target Database Password are stored in secrets.
85
+
An example of how to schedule this container in Kubernetes as a cronjob is below. This would configure a database backup to run each day at 01:00am. The AWS Secret Access Key, Target Database Password and Slack Webhook URL are stored in secrets.
The below subheadings detail how to configure kubernetes-cloud-mysql-backup to backup to a Google GCS backend.
156
+
157
+
### GCS - Configuring the Service Account
158
+
159
+
By default, kubernetes-cloud-mysql-backup performs a backup to the same path, with the same filename each time it runs. It therefore assumes that you have Object Versioning enabled on your GCS Bucket. A typical setup would involve GCP Object Versioning, with Object Lifecycle Management configured.
160
+
161
+
If a timestamp is required on the backup file name, the BACKUP_TIMESTAMP Environment Variable can be set.
162
+
163
+
In order to backup to a GCS Bucket, you must create a Service Account in Google Cloud Platform that contains the neccesary permissions to write to the destination bucket (for example the `Storage Obect Creator` role).
164
+
165
+
Once created, you must create a key for the Service Account in JSON format. This key should then be base64 encoded and set in the `GCP_GCLOUD_AUTH` environment variable. For example, to encode `service_account.json` you would use the command `base64 ~/service-key.json` in your terminal and set the output as the `GCP_GCLOUD_AUTH` environment variable.
166
+
167
+
168
+
### GCS - Example Kubernetes Cronjob
169
+
170
+
An example of how to schedule this container in Kubernetes as a cronjob is below. This would configure a database backup to run each day at 01:00am. The GCP Service Account Key, Target Database Password and Slack Webhook URL are stored in secrets.
171
+
172
+
```
173
+
apiVersion: v1
174
+
kind: Secret
175
+
metadata:
176
+
name: my-database-backup
177
+
type: Opaque
178
+
data:
179
+
gcp_gcloud_auth: <Base64 encoded Service Account Key>
0 commit comments