Skip to content

Commit 1309be9

Browse files
added detail for backup and restore readme, done changes in values.yaml of example and of module of backup and restore and done changes in template of backup nad restore
1 parent 5a4a6d1 commit 1309be9

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -116,15 +116,32 @@ module "mysql" {
116116
## IAM Permissions
117117
The required IAM permissions to create resources from this module can be found [here](https://github.com/squareops/terraform-kubernetes-mysql/blob/main/IAM.md)
118118

119-
## Backup
120-
- In order to enable backup, it require database names like "db1, db2" or if it is blank it will backup all database without sys, information schema, performance schema and mysql.
119+
## MySQL Backup and Restore
120+
This module provides functionality to automate the backup and restore process for MySQL databases using AWS S3 buckets. It allows users to easily schedule backups, restore databases from backups stored in S3, and manage access permissions using AWS IAM roles.
121+
Features
122+
### Backup
123+
- Users can schedule full backups.
124+
- upports specifying individual database names for backup or backing up all databases except system databases.
125+
- Backups are stored in specified S3 buckets.
126+
### Restore
127+
- Users can restore MySQL databases from backups stored in S3 buckets.
128+
- Supports specifying the backup file to restore from and the target S3 bucket region.
129+
### IAM Role for Permissions
130+
- Users need to provide an IAM role for the module to access the specified S3 bucket and perform backup and restore operations.
131+
## Module Inputs
132+
### Backup Configuration
121133
- command using to do backup:
122134
```
123135
mysqldump -h$HOST -u$USER -p$PASSWORD --databases db_name > full-backup.sql
124136
```
125-
## Restore
126-
- In order to enable backup, backup should be in .sql or .zip extention.
127-
137+
- mysql_database_name: The name of the MySQL database to backup. Leave blank to backup all databases except system databases.
138+
- bucket_uri: The URI of the S3 bucket where backups will be stored.
139+
- s3_bucket_region: The region of the S3 bucket.
140+
- cron_for_full_backup: The cron expression for scheduling full backups.
141+
### Restore Configuration
142+
- mysqldb_restore_config: Configuration for restoring databases.bucket_uri: The URI of the S3 bucket containing the backup file.
143+
- file_name: The name of the backup file to restore.
144+
- s3_bucket_region: The region of the S3 bucket containing the backup file.
128145
## Important Notes
129146
1. In order to enable the exporter, it is required to deploy Prometheus/Grafana first.
130147
2. The exporter is a tool that extracts metrics data from an application or system and makes it available to be scraped by Prometheus.

0 commit comments

Comments
 (0)