docs(dual-region): add operational procedure #3473

Langleu · 2024-03-13T15:34:22Z

Description

Introduced the guide around the operational procedure for recovering your dual-region setup temporarily and permanently in case of a lost region.

When should this change go live?

This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
There is no urgency with this change.
This change or page is part of a marketing blog, conference talk, or something else on a schedule.
This functionality is already available but undocumented.
This is a bug fix or security concern.

PR Checklist

I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

github-actions · 2024-03-13T15:34:50Z

👋 🤖 🤔 Hello! 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.4/.

docs/self-managed/concepts/multi-region/dual-region.md
docs/self-managed/operational-guides/multi-region/components/stateContainer.css
docs/self-managed/operational-guides/multi-region/components/stateContainer.jsx
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
docs/self-managed/operational-guides/multi-region/img/10.svg
docs/self-managed/operational-guides/multi-region/img/11.svg
docs/self-managed/operational-guides/multi-region/img/12.svg
docs/self-managed/operational-guides/multi-region/img/13.svg
docs/self-managed/operational-guides/multi-region/img/14.svg
docs/self-managed/operational-guides/multi-region/img/15.svg
docs/self-managed/operational-guides/multi-region/img/3.svg
docs/self-managed/operational-guides/multi-region/img/4.svg
docs/self-managed/operational-guides/multi-region/img/5.svg
docs/self-managed/operational-guides/multi-region/img/6.svg
docs/self-managed/operational-guides/multi-region/img/7.svg
docs/self-managed/operational-guides/multi-region/img/9.svg
docs/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/dual-region.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.

docs/self-managed/operational-guides/multi-region/swipItem.jsx

maxdanilov

No deep review yet, but I really like the approach and structure, especially the before-after comparison and steps explanation.

Some small suggestions:

for the pictures, add the namespace and cluster visualization (i.e. that in region 1 there's cluster 1 inside which there's camunda_1 and camunda_1_failover namespace etc)
switch from 1/2 numbering to 0/1 as in the EKS guide

Would also be good to add a legend to the terms used in the illustrations (e.g. ES = Elasticsearch), what's the difference between gray and black lines for Exporter 1/2 connections.

docs/self-managed/operational-guides/multi-region/dual-region-ops.md

docs/self-managed/operational-guides/multi-region/img/14.svg

docs/self-managed/operational-guides/multi-region/components/stateContainer.jsx

christinaausley · 2024-04-01T13:52:49Z

@Langleu Will this go out with release next week?

Langleu · 2024-04-02T07:54:47Z

@christinaausley , that's the plan at least. This and everything that was already reviewed and merged into infex-89.
Plan would be to have the operational guide fully done tomorrow for you to review and then we can rereview infex-89 whether we notice any discrepancies.

maxdanilov

Looks good overall, great job 👏

Aside from the wording / capitalization, 3 things from my side:

terminology/naming
- I suggest we consistently use terms surviving region, lost region, recreated region (or similar) in the doc (and avoid REGION0/1 if possible, at least in the texts)
I've seen Camunda Platform used multiple times across the doc, but I think we've phased it out in favor of just Camunda 8 (marketing) and also it's not always clear when it means "Zeebe + WebApps" and when just "WebApps"
I think introducing new env vars for the value of the surviving / lost / recreated regions (instead of basing the commands on REGION 0 and telling the customer to adjust when needed) will make the approach simpler and more robust for the users

sidebars.js

optimize_sidebars.js

docs/self-managed/operational-guides/multi-region/dual-region-ops.md

Langleu · 2024-04-03T09:36:52Z

@maxdanilov , thanks for the review!

About 1) agree, i tried checking the region mentionings and adjusted to the 3 chosen identifiers.
About 2) You are right, Camunda Platform was replaced with 8. Generally mean the whole platform but adjusted where applicable to just mention webapps.
About 3) Implemented suggested environment variables

including changes in wording and capitalization

maxdanilov

LGTM, thank you for addressing the comments. Leaving minor improvement suggestions, but nothing requiring a re-review from me later.

I'll later go through the whole procedure E2E so may be some feedback from that, but that'd probably be more on the technical details (e.g. if some commands have issues etc.)

docs/self-managed/operational-guides/multi-region/dual-region-ops.md

deepthidevaki

Very nice. I like the pictures to explain the current state and desired state in each step.

docs/self-managed/operational-guides/multi-region/dual-region-ops.md

Langleu · 2024-04-03T12:20:47Z

@christinaausley We are ready for a final technical writer review 🚀

christinaausley · 2024-04-03T19:52:27Z

@Langleu We can merge this in as I'll have one final look over infex-89.

* docs(dual-region): add operational procedure * docs(dual-region): first rework of the operational procedure * docs(multi-region): describe all steps for operational guide * docs(dual-region): adjust viewbox and add more verification steps * docs(dual-region): apply prettier suggestion * docs(dual-region): move helm chart release and version to env var * docs(dual-region): adjust missing links by resolving todos * docs(dual-region): add remaining verifcation steps * docs(dual-region): add info admonition on elasticsearch backup source * docs(dual-region): address review feedback first batch including changes in wording and capitalization * docs(dual-region): change use of environment variables * docs(dual-region): align disclaimer with concept page * docs(dual-region): add termonology and tabs for env preqs

* docs(aws): dual-region setup in AWS (#3430) * docs(aws): add dual-region setup * docs(aws): additions to the dual-region setup * docs(aws): switch to tabs and collapsables for dual-region * docs(aws): further adjustments to the dual-region * style(formatting): initial technical review * docs(aws): pull request adjustments pre-cloning setup * docs(aws): dual-region switch to git clone * docs(aws): pull request adjustments * docs(aws): remove tabs and simplify with more scripts * docs(aws): use new folder path * docs(aws): implement pr suggestions * small tweak --------- Co-authored-by: Christina Ausley <[email protected]> * chore(aws): add multi-region concept page (#3519) * docs(dual-region): add concept page * chore(aws): add concept page * chore(aws): dual-region, add region loss info * docs(dual-region): implement PR suggestions for concept page * docs(dual-region): add look at region loss for concept page * docs(dual-region): small restructure * docs(dual-region): add missing info on sizing and lost data * docs(dual-region): more concept page adjustments * style(formatting): technical review --------- Co-authored-by: Christina Ausley <[email protected]> * docs(dual-region): add disaster recovery RPO and RTO * docs(dual-regeion): address review feedback of concept page * docs(dual-region): add operational procedure (#3473) * docs(dual-region): add operational procedure * docs(dual-region): first rework of the operational procedure * docs(multi-region): describe all steps for operational guide * docs(dual-region): adjust viewbox and add more verification steps * docs(dual-region): apply prettier suggestion * docs(dual-region): move helm chart release and version to env var * docs(dual-region): adjust missing links by resolving todos * docs(dual-region): add remaining verifcation steps * docs(dual-region): add info admonition on elasticsearch backup source * docs(dual-region): address review feedback first batch including changes in wording and capitalization * docs(dual-region): change use of environment variables * docs(dual-region): align disclaimer with concept page * docs(dual-region): add termonology and tabs for env preqs * docs(dual-region): added simplifcations and more verifications * docs(dual-region): fix typo in verification * docs(dual-region): fix todo linkage * style(formatting): technical review * docs(dual-region): minor kubectl refinements added of image source --------- Co-authored-by: Christina Ausley <[email protected]>

Langleu added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Mar 13, 2024

Langleu requested a review from maxdanilov March 13, 2024 15:34

Langleu self-assigned this Mar 13, 2024

Langleu added component:infex Issues related with InfEx project target:8.5 labels Mar 13, 2024

github-actions bot reviewed Mar 13, 2024

View reviewed changes

maxdanilov reviewed Mar 13, 2024

View reviewed changes

docs/self-managed/operational-guides/multi-region/img/14.svg Outdated Show resolved Hide resolved

Langleu force-pushed the infex-100 branch from 4fe0fe5 to ab7ecc9 Compare March 27, 2024 09:36

github-actions bot reviewed Mar 27, 2024

View reviewed changes

docs/self-managed/operational-guides/multi-region/components/stateContainer.jsx Outdated Show resolved Hide resolved

docs/self-managed/operational-guides/multi-region/components/stateContainer.jsx Outdated Show resolved Hide resolved

Langleu requested a review from maxdanilov March 28, 2024 14:59

Langleu force-pushed the infex-100 branch from de753b9 to 05e9591 Compare March 28, 2024 15:10

Langleu force-pushed the infex-100 branch from c80ff4f to a92f73f Compare April 2, 2024 08:19

Langleu mentioned this pull request Apr 2, 2024

docs(dual-region): add all related dual-region topics #3562

Merged

9 tasks

maxdanilov requested changes Apr 2, 2024

View reviewed changes

Langleu force-pushed the infex-100 branch from 3ecbe83 to bc31a5e Compare April 3, 2024 09:34

Langleu requested a review from maxdanilov April 3, 2024 09:36

Langleu added 9 commits April 3, 2024 11:54

docs(dual-region): add operational procedure

9b5f501

docs(dual-region): first rework of the operational procedure

c96f3ad

docs(multi-region): describe all steps for operational guide

555552a

docs(dual-region): adjust viewbox and add more verification steps

48308bc

docs(dual-region): apply prettier suggestion

78219d0

docs(dual-region): move helm chart release and version to env var

865655e

docs(dual-region): adjust missing links by resolving todos

bcf5630

docs(dual-region): add remaining verifcation steps

2579c9a

docs(dual-region): add info admonition on elasticsearch backup source

762b716

Langleu added 3 commits April 3, 2024 11:55

docs(dual-region): address review feedback first batch

dbbed6e

including changes in wording and capitalization

docs(dual-region): change use of environment variables

315b5cc

docs(dual-region): align disclaimer with concept page

fafed33

Langleu force-pushed the infex-100 branch from aa2b451 to fafed33 Compare April 3, 2024 09:55

maxdanilov approved these changes Apr 3, 2024

View reviewed changes

docs/self-managed/operational-guides/multi-region/dual-region-ops.md Show resolved Hide resolved

docs/self-managed/operational-guides/multi-region/dual-region-ops.md Show resolved Hide resolved

deepthidevaki reviewed Apr 3, 2024

View reviewed changes

docs/self-managed/operational-guides/multi-region/dual-region-ops.md Outdated Show resolved Hide resolved

docs/self-managed/operational-guides/multi-region/dual-region-ops.md Outdated Show resolved Hide resolved

docs(dual-region): add termonology and tabs for env preqs

3625533

Langleu changed the title ~~[DRAFT] docs(dual-region): add operational procedure~~ docs(dual-region): add operational procedure Apr 3, 2024

Langleu marked this pull request as ready for review April 3, 2024 12:19

Langleu requested a review from christinaausley April 3, 2024 12:19

maxdanilov approved these changes Apr 3, 2024

View reviewed changes

Langleu merged commit 4775480 into infex-89 Apr 4, 2024
11 checks passed

Langleu deleted the infex-100 branch April 4, 2024 06:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(dual-region): add operational procedure #3473

docs(dual-region): add operational procedure #3473

Langleu commented Mar 13, 2024 •

edited

Loading

github-actions bot commented Mar 13, 2024 •

edited

Loading

maxdanilov left a comment •

edited

Loading

christinaausley commented Apr 1, 2024

Langleu commented Apr 2, 2024

maxdanilov left a comment

Langleu commented Apr 3, 2024

maxdanilov left a comment

deepthidevaki left a comment

Langleu commented Apr 3, 2024

christinaausley commented Apr 3, 2024

docs(dual-region): add operational procedure #3473

docs(dual-region): add operational procedure #3473

Conversation

Langleu commented Mar 13, 2024 • edited Loading

Description

When should this change go live?

PR Checklist

github-actions bot commented Mar 13, 2024 • edited Loading

maxdanilov left a comment • edited Loading

Choose a reason for hiding this comment

christinaausley commented Apr 1, 2024

Langleu commented Apr 2, 2024

maxdanilov left a comment

Choose a reason for hiding this comment

Langleu commented Apr 3, 2024

maxdanilov left a comment

Choose a reason for hiding this comment

deepthidevaki left a comment

Choose a reason for hiding this comment

Langleu commented Apr 3, 2024

christinaausley commented Apr 3, 2024

Langleu commented Mar 13, 2024 •

edited

Loading

github-actions bot commented Mar 13, 2024 •

edited

Loading

maxdanilov left a comment •

edited

Loading