[draft] ec2 architecture and guide #4585

conceptualshark · 2024-11-08T17:50:32Z

Description

Draft/WIP PR to explore changes and content movement in the preview.

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/).

My changes require an Engineering review, and I've assigned the Engineering DRI or delegate.
My changes require a technical writer review, and I've assigned @camunda/tech-writers as a reviewer.

github-actions · 2024-11-08T17:50:59Z

👋 🤖 🤔 Hello, @Langleu! 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/self-managed/reference-architecture/img/management-cluster.jpg
docs/self-managed/reference-architecture/img/orchestration-cluster.jpg
docs/self-managed/reference-architecture/manual/img/manual-ha.jpg
docs/self-managed/reference-architecture/manual/img/manual-single.jpg
docs/self-managed/reference-architecture/manual/manual.md
docs/self-managed/reference-architecture/reference-architecture.md
docs/self-managed/setup/deploy/amazon/assets/aws-ec2-arch.jpg
docs/self-managed/setup/deploy/amazon/assets/aws-ec2-arch.pdf
docs/self-managed/setup/deploy/amazon/aws-ec2.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/concepts/single-jar.md

Langleu · 2024-11-22T15:16:24Z

@theburi and @conceptualshark maybe you could have a look over this next week and give some general feedback on maybe what you're missing and still expecting to see.

I was going in the direction of GitLab's approach on the topic just that we don't have any benchmarks to guide (which I don't see happening anytime soon).

Essentially, on a high level talking about the idea of Reference Architectures, actual architecture, and guiding customers along to choose their path based on Kubernetes || manual (single jar) and from there have dedicated pages that cover the specific architecture to that component, talk about general requirements, etc. etc. and lastly guide from there to existing reference implementations based on the examples that we have.

Reference Architecture
- Kubernetes
  - AWS EKS
  - Dual Region
  - any other ...
- Manual
  - AWS EC2
  - any other ...

Current pages:

https://preview.docs.camunda.cloud/pr-4585/docs/next/self-managed/reference-architecture/
- https://preview.docs.camunda.cloud/pr-4585/docs/next/self-managed/reference-architecture/manual/manual-overview/
  - https://preview.docs.camunda.cloud/pr-4585/docs/next/self-managed/reference-architecture/manual/aws-ec2/

I'm on a team event next week + RSG, so take your time!

theburi

This is a good start. Lets discuss few topics as I was reading this guide:

Adding Architecture tech spec, overview page that just lists facts
Can we include full production configuration in a single page, including TLS, Auth and connectivity? Or shall we make it a multi-step guide: install foundation, then add security, then add connectivity.
I feel like we need to add a bit more description to each step to describe what is going on.

docs/self-managed/setup/deploy/amazon/aws-ec2.md

Langleu · 2024-12-04T10:28:27Z

Since the previous links were moved:

https://preview.docs.camunda.cloud/pr-4585/docs/next/self-managed/reference-architecture/
- https://preview.docs.camunda.cloud/pr-4585/docs/next/self-managed/reference-architecture/manual/manual-overview/
  - https://preview.docs.camunda.cloud/pr-4585/docs/next/self-managed/reference-architecture/manual/aws-ec2/

github-actions · 2024-12-04T18:00:30Z

docs/self-managed/reference-architecture/reference-architecture.md

+
+## Support Considerations
+
+We recognize that deviations from the reference architecture are unavoidable. However, such changes will introduce additional complexity, making troubleshooting more difficult. When modifications are required, ensure they are well-documented to facilitate future maintenance and support more quickly. Camunda publishes [supported environments](/docs/reference/supported-environments/) information to help you navigate supported configurations.


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'supported environments'. Please specify the file extension.

docs/self-managed/reference-architecture/reference-architecture.md

leiicamundi

Rock solid documentation! Wp

I left some comments

docs/self-managed/reference-architecture/reference-architecture.md

docs/self-managed/setup/deploy/local/manual.md

leiicamundi · 2024-12-10T10:15:17Z

sidebars.js

@@ -1567,5 +1567,16 @@ module.exports = {
        },
      ],
    },
+    {
+      "Reference Architecture": [


We could have the RA part of the Setup section, for existing docs such as gitlab, it's part of the Install chapter

I had it previously but talked with Andrey about it, the idea is to have it more prominently as guidance in the future.
Not sure how long setup will continue existing as is.

I'd keep the Reference Arch structure wise as is for now, we can still move it till 8.7 depending on feedback.

The only issue I see with that is the fact that this category is not self-describing.
Setup / Installation are simple words

Reference Arch needs its own definition

I don't have strong opinion on that, maybe @conceptualshark you have one regarding the developer experience of those words

@theburi maybe also of interest to you

optimize_sidebars.js

docs/self-managed/reference-architecture/img/placeholder.png

docs/self-managed/reference-architecture/manual/manual-overview.md

docs/self-managed/reference-architecture/reference-architecture.md

Langleu · 2024-12-12T10:27:20Z

@conceptualshark I can't request you as reviewer but would be good to have it reviewed from your side.

leiicamundi

LGTM! Only the sidebar structure that is a remaining point.
Very well done :)

github-actions · 2024-12-12T11:04:22Z

The preview environment relating to the commit f6d461e has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4585/index.html

conceptualshark self-assigned this Nov 8, 2024

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

conceptualshark added target:8.7 Issues included in the 8.7 release deploy Stand up a temporary docs site with this PR labels Nov 8, 2024

conceptualshark changed the title ~~[draft] cg2 architecture and guide~~ [draft] ec2 architecture and guide Nov 8, 2024

github-actions bot temporarily deployed to camunda-docs November 8, 2024 18:09 Destroyed

github-actions bot temporarily deployed to camunda-docs November 18, 2024 13:51 Destroyed

github-actions bot temporarily deployed to camunda-docs November 19, 2024 15:30 Destroyed

github-actions bot reviewed Nov 20, 2024

View reviewed changes

docs/self-managed/concepts/single-jar.md Outdated Show resolved Hide resolved

docs/self-managed/concepts/single-jar.md Outdated Show resolved Hide resolved

github-actions bot temporarily deployed to camunda-docs November 20, 2024 15:25 Destroyed

github-actions bot temporarily deployed to camunda-docs November 21, 2024 14:38 Destroyed

github-actions bot temporarily deployed to camunda-docs November 22, 2024 15:07 Destroyed

theburi reviewed Nov 28, 2024

View reviewed changes

github-actions bot temporarily deployed to camunda-docs December 3, 2024 10:06 Destroyed

github-actions bot temporarily deployed to camunda-docs December 4, 2024 10:22 Destroyed

github-actions bot temporarily deployed to camunda-docs December 4, 2024 14:35 Destroyed

github-actions bot reviewed Dec 4, 2024

View reviewed changes

github-actions bot temporarily deployed to camunda-docs December 4, 2024 18:12 Destroyed

Langleu reviewed Dec 5, 2024

View reviewed changes

docs/self-managed/reference-architecture/reference-architecture.md Outdated Show resolved Hide resolved

Langleu requested a review from leiicamundi December 5, 2024 15:31

Langleu marked this pull request as ready for review December 10, 2024 11:00

leiicamundi requested changes Dec 10, 2024

View reviewed changes

Langleu and others added 5 commits December 11, 2024 15:21

chore(docs/aws): add ec2 arch and guide

7adf114

add side nav, move content

c1c3617

chore(self-managed): add generalized reference architecture concept page

5164cd0

chore: persisting changes / ideas on the ref arch and single jar

ca35da9

chore: continue adding content to ref arch and single jar

78d4f30

Langleu and others added 12 commits December 11, 2024 15:21

chore: overwrite old manual with new single jar manual

c3dda89

chore: further adjustment to new docs

78a5165

chore: add placeholder images for now

6fd8424

docs(aws/ec2): add additions based on review feedback

990c060

docs(sm): restore previous manual page

94656d0

docs(ref-arch): restructure navigation level and fix links

424a7c5

docs(aws/ec2): add remaining discussed topics

b0fc0be

Made one edittorial pass and added/changes few sections

e9abae2

docs(ref): minor adjustments to remove more todos

81ce3b4

Another pass on a manaual page

a18f444

docs(graphics): update placeholders

f63f653

docs(aws): address review feedback

490926d

Langleu force-pushed the infraex-250 branch from c30e59e to 490926d Compare December 11, 2024 14:22

github-actions bot temporarily deployed to camunda-docs December 11, 2024 14:34 Destroyed

Langleu force-pushed the infraex-250 branch from dda5a51 to 5527a15 Compare December 12, 2024 09:19

Langleu requested a review from leiicamundi December 12, 2024 09:21

docs(aws): restructure and resolve PR requests

92644c3

Langleu force-pushed the infraex-250 branch from 5527a15 to 92644c3 Compare December 12, 2024 09:23

github-actions bot temporarily deployed to camunda-docs December 12, 2024 09:36 Destroyed

docs(aws): rephrase before you start disclaimer

0872962

leiicamundi approved these changes Dec 12, 2024

View reviewed changes

github-actions bot temporarily deployed to camunda-docs December 12, 2024 10:59 Destroyed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[draft] ec2 architecture and guide #4585

[draft] ec2 architecture and guide #4585

conceptualshark commented Nov 8, 2024 •

edited

Loading

github-actions bot commented Nov 8, 2024 •

edited

Loading

Langleu commented Nov 22, 2024 •

edited

Loading

theburi left a comment

Langleu commented Dec 4, 2024

github-actions bot Dec 4, 2024

leiicamundi left a comment

leiicamundi Dec 10, 2024

Langleu Dec 12, 2024

Langleu Dec 12, 2024

leiicamundi Dec 12, 2024

Langleu Dec 12, 2024

Langleu commented Dec 12, 2024

leiicamundi left a comment

github-actions bot commented Dec 12, 2024


		## Support Considerations

		We recognize that deviations from the reference architecture are unavoidable. However, such changes will introduce additional complexity, making troubleshooting more difficult. When modifications are required, ensure they are well-documented to facilitate future maintenance and support more quickly. Camunda publishes [supported environments](/docs/reference/supported-environments/) information to help you navigate supported configurations.

[draft] ec2 architecture and guide #4585

Are you sure you want to change the base?

[draft] ec2 architecture and guide #4585

Conversation

conceptualshark commented Nov 8, 2024 • edited Loading

Description

When should this change go live?

PR Checklist

github-actions bot commented Nov 8, 2024 • edited Loading

Langleu commented Nov 22, 2024 • edited Loading

theburi left a comment

Choose a reason for hiding this comment

Langleu commented Dec 4, 2024

github-actions bot Dec 4, 2024

Choose a reason for hiding this comment

leiicamundi left a comment

Choose a reason for hiding this comment

leiicamundi Dec 10, 2024

Choose a reason for hiding this comment

Langleu Dec 12, 2024

Choose a reason for hiding this comment

Langleu Dec 12, 2024

Choose a reason for hiding this comment

leiicamundi Dec 12, 2024

Choose a reason for hiding this comment

Langleu Dec 12, 2024

Choose a reason for hiding this comment

Langleu commented Dec 12, 2024

leiicamundi left a comment

Choose a reason for hiding this comment

github-actions bot commented Dec 12, 2024

conceptualshark commented Nov 8, 2024 •

edited

Loading

github-actions bot commented Nov 8, 2024 •

edited

Loading

Langleu commented Nov 22, 2024 •

edited

Loading