Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add initial RDBMS documentation #4877

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add initial RDBMS documentation #4877

wants to merge 2 commits into from

Conversation

stoerti
Copy link

@stoerti stoerti commented Jan 20, 2025

Description

Preparation for RDBMS release. Will maybe not happen before Camunda 8.8

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@stoerti stoerti self-assigned this Jan 20, 2025
Copy link
Contributor

👋 🤖 🤔 Hello, @stoerti! 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.6/.

  • docs/guides/migrating-from-camunda-7/conceptual-differences.md
  • docs/self-managed/concepts/databases/elasticsearch/elasticsearch-privileges.md
  • docs/self-managed/concepts/databases/elasticsearch/opensearch-privileges.md
  • docs/self-managed/concepts/databases/overview.md
  • docs/self-managed/concepts/databases/relational-db/configuration.md
  • docs/self-managed/operational-guides/backup-restore/backup-and-restore.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.

@akeller
Copy link
Member

akeller commented Jan 21, 2025

Let me know if you need any help @stoerti 🙂

@akeller akeller added the target:8.8 Issues included in the 8.8 release label Jan 22, 2025
@akeller
Copy link
Member

akeller commented Jan 22, 2025

@stoerti thanks for your comment about delivery in the PR description. Since we are actively triaging changes for 8.7 and 8.8, I went ahead and added a target:8.8 label to this PR. We can always change this, but AFAIK, it will not ship with 8.7.

@akeller akeller added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Jan 24, 2025
github-merge-queue bot pushed a commit to camunda/camunda that referenced this pull request Feb 3, 2025
## Description

Aligns all columns like *_id, *_name to 400 characters. Also updated
limitations in camunda-docs ([rdbms
branch](camunda/camunda-docs#4877))

relates to #24002
@p-wunderlich p-wunderlich changed the title Add RDBMS backup documentation Add initial RDBMS documentation Feb 6, 2025

TODO: Add more text about behavior and limitations?

Document based databases like ElasticSearch and OpenSearch
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[all.glossary] This term is spelled, uppercased, lowercased, hyphenated, or used incorrectly. Review the WCoE glossary.

@@ -24,6 +24,8 @@ Zeebe stores its backup to an external storage and must be configured before the

### Backup process

#### Backups using ElasticSearch
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[all.glossary] This term is spelled, uppercased, lowercased, hyphenated, or used incorrectly. Review the WCoE glossary.

### Restore

To restore a Camunda 8 cluster from a backup, all components must be restored from their backup corresponding to the same backup id:
#### Restoring using ElasticSearch
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[all.glossary] This term is spelled, uppercased, lowercased, hyphenated, or used incorrectly. Review the WCoE glossary.

To restore a Camunda 8 cluster from a backup, all components must be restored from their backup corresponding to the same backup id:
#### Restoring using ElasticSearch

To restore an ElasticSearch based Camunda 8 cluster from a backup, all components must be restored from their backup corresponding to the same backup id:
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[all.glossary] This term is spelled, uppercased, lowercased, hyphenated, or used incorrectly. Review the WCoE glossary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed target:8.8 Issues included in the 8.8 release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants