Document and check for valid backup providers

metal-stack · Jan 16, 2025 · d0e387d · d0e387d
1 parent 66c8f66
commit d0e387d
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 3 deletions.
diff --git a/control-plane/roles/meili-backup-restore/README.md b/control-plane/roles/meili-backup-restore/README.md
@@ -24,7 +24,7 @@ You can look up all the default values of this role [here](defaults/main/main.ya
 | meilisearch_no_analytics                                   |           | Sets the no analytics configuration for meilisearch                                                               |
 | meilisearch_backup_restore_sidecar_image_name              | yes       | Image version of the backup-restore-sidecar                                                                       |
 | meilisearch_backup_restore_sidecar_image_tag               | yes       | Image tag of the backup-restore-sidecar                                                                           |
-| meilisearch_backup_restore_sidecar_provider                |           | The backup provider                                                                                               |
+| meilisearch_backup_restore_sidecar_provider                |           | The backup provider . One of `local`, `gcp` or `s3`                                                                                              |
 | meilisearch_backup_restore_sidecar_backup_cron_schedule    |           | The backup cron schedule                                                                                          |
 | meilisearch_backup_restore_sidecar_log_level               |           | The log level of the sidecar                                                                                      |
 | meilisearch_backup_restore_sidecar_gcp_bucket_name         |           | Bucket name of the GCP bucket                                                                                     |

diff --git a/control-plane/roles/meili-backup-restore/tasks/main.yml b/control-plane/roles/meili-backup-restore/tasks/main.yml
@@ -12,6 +12,7 @@
       - meilisearch_backup_restore_sidecar_image_name is defined
       - meilisearch_backup_restore_sidecar_image_tag is defined
       - meilisearch_backup_restore_sidecar_encryption_key is none or meilisearch_backup_restore_sidecar_encryption_key | length == 32
+      - meilisearch_backup_restore_sidecar_provider in ["local", "gcp", "s3"]
 
 - name: Deploy meilisearch (backup-restore)
   k8s:

diff --git a/control-plane/roles/postgres-backup-restore/README.md b/control-plane/roles/postgres-backup-restore/README.md
@@ -25,7 +25,7 @@ You can look up all the default values of this role [here](defaults/main/main.ya
 | postgres_max_connections                                |           | The amount of max. connections possible, defaults to 100                                                          |
 | postgres_backup_restore_sidecar_image_name              | yes       | Image version of the backup-restore-sidecar                                                                       |
 | postgres_backup_restore_sidecar_image_tag               | yes       | Image tag of the backup-restore-sidecar                                                                           |
-| postgres_backup_restore_sidecar_provider                |           | The backup provider                                                                                               |
+| postgres_backup_restore_sidecar_provider                |           | The backup provider. One of `local`, `gcp` or `s3`                                                                                               |
 | postgres_backup_restore_sidecar_backup_cron_schedule    |           | The backup cron schedule                                                                                          |
 | postgres_backup_restore_sidecar_log_level               |           | The log level of the sidecar                                                                                      |
 | postgres_backup_restore_sidecar_gcp_bucket_name         |           | Bucket name of the GCP bucket                                                                                     |

diff --git a/control-plane/roles/postgres-backup-restore/tasks/main.yml b/control-plane/roles/postgres-backup-restore/tasks/main.yml
@@ -12,6 +12,7 @@
       - postgres_backup_restore_sidecar_image_name is defined
       - postgres_backup_restore_sidecar_image_tag is defined
       - postgres_backup_restore_sidecar_encryption_key is none or postgres_backup_restore_sidecar_encryption_key | length == 32
+      - postgres_backup_restore_sidecar_provider in ["local", "gcp", "s3"]
 
 - name: Deploy postgres (backup-restore)
   k8s:

diff --git a/control-plane/roles/rethinkdb-backup-restore/README.md b/control-plane/roles/rethinkdb-backup-restore/README.md
@@ -22,7 +22,7 @@ You can look up all the default values of this role [here](defaults/main/main.ya
 | rethinkdb_password                                       |           | The password of the rethinkdb                                                                                     |
 | rethinkdb_backup_restore_sidecar_image_name              | yes       | Image version of the backup-restore-sidecar                                                                       |
 | rethinkdb_backup_restore_sidecar_image_tag               | yes       | Image tag of the backup-restore-sidecar                                                                           |
-| rethinkdb_backup_restore_sidecar_provider                |           | The backup provider                                                                                               |
+| rethinkdb_backup_restore_sidecar_provider                |           | The backup provider. One of `local`, `gcp` or `s3`                                                                                              |
 | rethinkdb_backup_restore_sidecar_backup_cron_schedule    |           | The backup cron schedule                                                                                          |
 | rethinkdb_backup_restore_sidecar_log_level               |           | The log level of the sidecar                                                                                      |
 | rethinkdb_backup_restore_sidecar_gcp_bucket_name         |           | Bucket name of the GCP bucket                                                                                     |

diff --git a/control-plane/roles/rethinkdb-backup-restore/tasks/main.yml b/control-plane/roles/rethinkdb-backup-restore/tasks/main.yml
@@ -12,6 +12,7 @@
       - rethinkdb_backup_restore_sidecar_image_name is defined
       - rethinkdb_backup_restore_sidecar_image_tag is defined
       - rethinkdb_backup_restore_sidecar_encryption_key is none or rethinkdb_backup_restore_sidecar_encryption_key | length == 32
+      - rethinkdb_backup_restore_sidecar_provider in ["local", "gcp", "s3"]
 
 - name: Check mandatory variables for this role are set
   assert: