Skip to content

RDBMS backup & restore guide#8087

Open
panagiotisgts wants to merge 6 commits intomainfrom
pg/backups-docs-update
Open

RDBMS backup & restore guide#8087
panagiotisgts wants to merge 6 commits intomainfrom
pg/backups-docs-update

Conversation

@panagiotisgts
Copy link
Contributor

@panagiotisgts panagiotisgts commented Feb 27, 2026

Description

  • Separate RDBMS and ES/OS backup & restore guides
    • Update docs/next/self-managed/operational-guides/backup-restore/backup-and-restore/ to reflect the split guides
    • ES guide moved to docs/next/self-managed/operational-guides/backup-restore/elasticsearch/es-backup/
    • RDBMS guide docs/next/self-managed/operational-guides/backup-restore/rdbms/rdbms-backup/
  • RDBMS backup & restore guide

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the Documentation team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and are in the /docs directory (version 8.9).
  • My changes are for an already released minor and are in a /versioned_docs directory.

Initial rdbms documentation
@panagiotisgts panagiotisgts added the deploy Stand up a temporary docs site with this PR label Feb 27, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 27, 2026

👋 🤖 🤔 Hello, @christinaausley! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.8/.

  • docs/self-managed/deployment/containers/cloud-providers/amazon/aws-ecs.md
  • docs/self-managed/deployment/helm/configure/operator-based-infrastructure.md
  • docs/self-managed/operational-guides/backup-restore/backup-and-restore.md
  • docs/self-managed/operational-guides/backup-restore/elasticsearch/backup.md
  • docs/self-managed/operational-guides/backup-restore/elasticsearch/restore.md
  • docs/self-managed/operational-guides/backup-restore/rdbms/backup.md
  • docs/self-managed/operational-guides/backup-restore/rdbms/restore.md
  • docs/self-managed/operational-guides/backup-restore/react-components/_card-data.js
  • docs/self-managed/quickstart/developer-quickstart/c8run.md
  • docs/self-managed/upgrade/manual/index.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@github-actions github-actions bot temporarily deployed to camunda-docs February 27, 2026 09:55 Destroyed
@panagiotisgts panagiotisgts changed the title docs: split rdbms/es backups structure RDBMS backup & restore guide Mar 4, 2026
@panagiotisgts panagiotisgts marked this pull request as ready for review March 4, 2026 07:12
@github-actions github-actions bot temporarily deployed to camunda-docs March 4, 2026 07:20 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs March 5, 2026 09:54 Destroyed
lenaschoenburg
lenaschoenburg previously approved these changes Mar 5, 2026
With Zeebe being set up against an RDBMS secondary storage, you have the option to enable Zeebe's internal backup scheduler. Enabling the scheduler will result in primary storage backups being
created at the predefined interval. Learn more about configuring the backup scheduler [here](../../../../components/orchestration-cluster/core-settings/configuration/properties/#camundadataprimary-storagebackup).

In addition to the scheduler, continuous primary storage backups must be enabled, by setting `camunda.data.primary-storage.backup.continous` to true. With continuous backups enabled,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔧 This is a prerequisite, let's mention it up there

@lenaschoenburg
Copy link
Member

@christinaausley let me know if you agree on the general direction of splitting the backup/restore guides for RDBMS and ES/OS, then I'll start adding more content to the RDBMS guide.

@github-actions github-actions bot temporarily deployed to camunda-docs March 5, 2026 14:32 Destroyed
@christinaausley
Copy link
Contributor

@lenaschoenburg -- apologies for the delay. I will have a look at this today 👍

@christinaausley
Copy link
Contributor

Mild grammar tweaks in latest commit.

Thanks for this update -- I agree with the general direction of splitting ES/OS and RDBMS backup/restore guides. It improves navigation and reduces mixed guidance.

From a #7117 perspective (semi-related), this PR is a good step forward 👍 I like the clear separation of Elasticsearch/OpenSearch vs RDBMS procedures, discoverability from the backup/restore overview, and clearer end-to-end flow for each storage path.

Remaining gaps (can be handled here or I can handle in a follow-up PR)

  1. Post-restore verification guidance -- Add a concrete verification section with:

    • API/script checks
    • visual checks in Operate/Tasklist
    • explicit confirmation of both:
      • historical process/decision instances
      • process/decision definitions in Zeebe
  2. Critical-step emphasis and consistency -- Ensure high-risk order-of-operations warnings are explicit and consistent across overlapping pages.

For the items below, I’m fine with either brief references in this PR or a separate follow-up to keep scope tight:

  1. Identity dependency clarification -- Clarify expected behavior/dependencies for Identity in backup/restore workflows.

  2. CSP-specific caveats -- Add minimum cloud-provider notes (AWS/Azure/GCP), even as short caveats/links.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 5, 2026

The preview environment relating to the commit 4f3ee41 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-8087/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deploy Stand up a temporary docs site with this PR

Projects

Status: 👀 In Review

Development

Successfully merging this pull request may close these issues.

3 participants