Skip to content

Commit 9539896

Browse files
added backup and restore details on readme
1 parent 4e87781 commit 9539896

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,27 @@ module "mongodb" {
9898

9999
## IAM Permissions
100100
The required IAM permissions to create resources from this module can be found [here](https://github.com/squareops/terraform-kubernetes-mongodb/blob/main/IAM.md)
101-
101+
## Mongo Backup and Restore
102+
This module provides functionality to automate the backup and restore process for mongo 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.
103+
Features
104+
### Backup
105+
- Users can schedule full backups.
106+
- Backups are stored in specified S3 buckets.
107+
### Restore
108+
- Users can restore Mongo databases from backups stored in S3 buckets.
109+
- Supports specifying the backup file to restore from and the target S3 bucket region.
110+
### IAM Role for Permissions
111+
- Users need to provide an IAM role for the module to access the specified S3 bucket and perform backup and restore operations.
112+
## Module Inputs
113+
### Backup Configuration
114+
- bucket_uri: The URI of the S3 bucket where backups will be stored.
115+
- s3_bucket_region: The region of the S3 bucket.
116+
- cron_for_full_backup: The cron expression for scheduling full backups.
117+
### Restore Configuration
118+
- mongodb_restore_config: Configuration for restoring databases.
119+
- bucket_uri: The URI of the S3 bucket containing the backup file.
120+
- file_name: The name of the backup file to restore.
121+
- s3_bucket_region: The region of the S3 bucket containing the backup file.
102122
## Important Notes
103123
1. In order to enable the exporter, it is required to deploy Prometheus/Grafana first.
104124
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)