From d2800d76af1d6ae46b883d19527792d98f73f001 Mon Sep 17 00:00:00 2001 From: Boemeltrein <130394941+Boemeltrein@users.noreply.github.com> Date: Tue, 3 Dec 2024 19:34:40 +0100 Subject: [PATCH] Website Docs: Update cnpg-backup-restore.md (#29811) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit As there is still some discussion on discord, try to make it more clear **Description** ⚒️ Fixes # **⚙️ Type of change** - [x ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** **📃 Notes:** **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [x ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning - [ ] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):` or `chore(chart-name):` **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ Signed-off-by: Boemeltrein <130394941+Boemeltrein@users.noreply.github.com> --- .../docs/guides/cnpg-backup-restore.md | 24 ++++++++++++++----- 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/website/src/content/docs/guides/cnpg-backup-restore.md b/website/src/content/docs/guides/cnpg-backup-restore.md index 5dc8e10cd5b..f7147427a9e 100644 --- a/website/src/content/docs/guides/cnpg-backup-restore.md +++ b/website/src/content/docs/guides/cnpg-backup-restore.md @@ -26,8 +26,21 @@ For each chart: 2. Add the name you gave to the S3 credentials earlier, under the `credentials` section -3. Confirm the data is being sent to your S3 host after ~5 minutes +It will look like something like this: +```yaml +cnpg: + main: + backups: + enabled: true + credentials: s3 + recovery: + credentials: s3 + +``` + +3. Confirm the data is being sent to your S3 host after ~5 minutes. At 00:00 UTC a complete backup will be made. + 4. We advise you to set the "mode" to `recovery`, this should prevent the app starting with an empty database upon recovery. It will look something like this: @@ -40,7 +53,6 @@ cnpg: enabled: true credentials: s3 recovery: - method: object_store credentials: s3 ``` @@ -53,9 +65,9 @@ Before CNPG will correctly restore the database, the following modifications nee 2. Ensure the "mode" is set to `recovery` -3. Set "revision" on your restore to match the previous **revision** setting on your backup settings +3. Set "revision" on your recovery to match the previous **revision** setting on your backup settings. -4. Increase the **revision** on your backup setting by 1 (or set to 1 if previously empty) +4. Increase the **revision** on your backup setting by 1 (or set to 1 if previously empty). Revision needs to set as string ("") It will look something like this: @@ -65,10 +77,10 @@ cnpg: mode: recovery backups: enabled: true - revision: 1 + revision: "1" credentials: s3 recovery: - method: object_store + # revision: "x" ## Can be added when you are would like to recover when the revision is > 0 (Step 3) credentials: s3 ```