DOCKER-441 improve solr backup documentation and update solr backup

xenit-eu · Nov 3, 2023 · d771899 · d771899
1 parent 728a892
commit d771899
Show file tree

Hide file tree

Showing 5 changed files with 302 additions and 15 deletions.
diff --git a/Backup.md b/Backup.md
@@ -8,18 +8,15 @@ Restore is done via an init script in solr image, which checks the need of resto
 
 ![alt Architectural diagram](./SolrBackup.svg)
 
-
-
-| Variable                                                   | Default                              | Comments                                                                                                    |
-|------------------------------------------------------------|--------------------------------------|-------------------------------------------------------------------------------------------------------------|
-| RESTORE_FROM_BACKUP                                        | none                                 | Whether to attempt a restore from backup at startup                                                         |
-| RESTORE_BACKUP_NAME                                        | none                                 | If provided, restores from that specific snapshot. If not provided, it's the last snapshot from the bucket. |
-| JAVA_OPTS_S3_ENDPOINT=-DS3_ENDPOINT=<endpoint_s3_protocol> | http://s3.eu-central-1.amazonaws.com | S3 endpoint                                                                                                 |
-| JAVA_OPTS_S3_BUCKET_NAME=-DS3_BUCKET_NAME=<bucket_name>    | test-bucket                          | S3 bucket                                                                                                   |
-| JAVA_OPTS_S3_REGION=-DS3_REGION=<bucket_s3_region>         | eu-central-1                         | S3 bucket region                                                                                            |
-| JAVA_OPTS_AWS_ACCESS_KEY=-Daws.accessKeyId=<access_key>    | none                                 | S3 access key                                                                                               |
-| JAVA_OPTS_AWS_SECRET_KEY=-Daws.secretKey=<secret_key>      | none                                 | S3 secret key                                                                                               |
-
+| Variable            | Default                              | Comments                                                                                                    |
+|---------------------|--------------------------------------|-------------------------------------------------------------------------------------------------------------|
+| RESTORE_FROM_BACKUP | none                                 | Whether to attempt a restore from backup at startup                                                         |
+| RESTORE_BACKUP_NAME | none                                 | If provided, restores from that specific snapshot. If not provided, it's the last snapshot from the bucket. |
+| S3_ENDPOINT         | http://s3.eu-central-1.amazonaws.com | S3 endpoint                                                                                                 |
+| S3_BUCKET_NAME      | test-bucket                          | S3 bucket                                                                                                   |
+| S3_REGION           | eu-central-1                         | S3 bucket region                                                                                            |
+| S3_ACCESS_KEY       | none                                 | S3 access key                                                                                               |
+| S3_SECRET_KEY       | none                                 | S3 secret key                                                                                               |
 
 ### Communication via SSL
 In case communication to Solr requires mtls, certificates needed should be included in the backup container and in solr image. A set of default certificates is provided.