incorporate helm production + configuration + JDBC driver for RDBMS #7813
Conversation
|
👋 🤖 🤔 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/.
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. |
christinaausley
requested review from
RomanJRW,
hisImminence,
jessesimpson36,
sergiizakharov,
stoerti and
volodymyr-melnykc
|
@volodymyr-melnykc Note that I have also added you for review from a design/developer journey perspective, as I have adjusted the sidebar a bit. To all reviewers, interested in what we think of the new helm-with-rdbms placement, or if we would prefer to see this merged elsewhere/with existing content. I was also worried rdbms.md was becoming too long, so maintained the same content but split the content into several pages. Also note that I am gradually producing docs this week, but don't really require review until next week following kickoff. |
RomanJRW
left a comment
RomanJRW
left a comment
There was a problem hiding this comment.
Some initial feedback from my side
docs/self-managed/deployment/helm/configure/database/rdbms-jdbc-drivers.md
Outdated
Show resolved
Hide resolved
| | ---------- | ------- | ----------------------------------------------------------------- | | ||
| | PostgreSQL | Yes | Patches, extensions, or compatibility with older server versions. | | ||
| | MariaDB | Yes | Custom JDBC features or compliance requirements. | | ||
| | H2 | Yes | Development only; not supported for production. | |
There was a problem hiding this comment.
❓ @aleksander-dytko: Is this our official position? I am actually a bit split on this after some conversations over the last few days
docs/self-managed/deployment/helm/configure/database/rdbms-jdbc-drivers.md
Outdated
Show resolved
Hide resolved
docs/self-managed/deployment/helm/configure/database/rdbms-jdbc-drivers.md
Outdated
Show resolved
Hide resolved
docs/self-managed/deployment/helm/configure/database/rdbms-jdbc-drivers.md
Outdated
Show resolved
Hide resolved
| id: rdbms-troubleshooting | ||
| sidebar_label: Troubleshooting | ||
| title: RDBMS troubleshooting and operations | ||
| description: "Troubleshoot common RDBMS connectivity issues, TLS configuration, and post-deployment operations." |
There was a problem hiding this comment.
I like this page, but I wonder if we do/should have something similar for ES/OS, or maybe a secondary storage one. We already have this - https://docs.camunda.io/docs/next/self-managed/concepts/secondary-storage/managing-secondary-storage/ - but they are not really equivalent pages
There was a problem hiding this comment.
I could create a backlog ticket for the following, if I am understanding correctly?
Secondary storage documentation parity: Consider creating equivalent troubleshooting guides for Elasticsearch/OpenSearch or consolidating secondary storage guidance into a unified "Secondary Storage Operations" page. Currently, RDBMS has dedicated troubleshooting coverage, but ES/OS guidance is primarily in the generic managing-secondary-storage page.
|
The preview environment relating to the commit a11ec1d has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-7813/ |
Closes #7333 and #7332. I was also worried rdbms.md was becoming too long, so split the content into several pages.
New documentation pages
helm-with-rdbms.md: End-to-end production Helm installation guide for RDBMS deployments (8-step workflow, scenarios, troubleshooting)rdbms-jdbc-drivers.md: Comprehensive JDBC driver management guide (bundled vs. custom, provisioning strategies, verification)rdbms-schema-management.md: Schema creation and lifecycle guide (autoDDL, permissions, manual management, upgrades)rdbms-troubleshooting.md: Troubleshooting, TLS configuration, and post-deployment operationsSimplified core reference
rdbms.md: Refactored from 540 lines to 198 lines as focused configuration reference with links to specialized guidesNavigation & cross-linking
install/index.md: Added decision matrix (table) to help users choose between quick-install, RDBMS, and production pathssidebars.js:helm-with-rdbmsto Install sectionUpdated References
install/index.md: Added comparison table and decision criteria for choosing installation pathvalidate-rdbms.md: Added cross-links to modular guidesaccess-sql-liquibase-scripts.md: Added cross-links to schema and driver pagesWhen should this change go live?
bugorsupportlabel)available & undocumentedlabel)holdlabel)low priolabel)PR Checklist
{type}(scope): {description}commit message(s)/docsdirectory (version 8.9)./versioned_docsdirectory.@camunda/tech-writersunless working with an embedded writer.