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, @conceptualshark! 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/

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

I think we should leave it as-is for right now, knowing that the Setup section is going to undergo some changes, and given that Andrey also advised it standing on its own as a new "Reference architecture" section.

Broadly, I agree - I think it should be categorized as some sort of instructional section, including some of the existing deployment docs, but I think we can handle moving content and renaming this separate to what's happening in this PR.

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-17T13:04:09Z

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


-<!-- TODO: add calculator specific for this setup -->
+To get an estimate, you can refer to this [example calculation](https://calculator.aws/#/estimate?id=8ce855e2d02d182c4910ec8b4ea2dbf42ea5fd1d), which can be further optimized to suit your specific use cases.


@conceptualshark added an example cost calculator for the setup, let me know when it makes sense to add this.

conceptualshark

@Langleu I've gone ahead and made some changes and committed them here - the deploy/preview should be running in case you'd like to use that to double-check. Otherwise, this is looking good on my end!

Langleu · 2024-12-19T08:57:10Z

@conceptualshark thank you 🙇. Looks good from my side as well, thanks for the additional changes!
I'm good with merging this as well.

github-actions · 2024-12-19T21:29:02Z

🧹 Preview environment for this PR has been torn down.

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

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

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 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

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

Langleu and others added 11 commits December 17, 2024 10:18

docs(ref): minor adjustments to remove more todos

5a93aef

Another pass on a manaual page

85495eb

docs(graphics): update placeholders

21b197e

docs(aws): address review feedback

7ad7e09

docs(aws): restructure and resolve PR requests

248f56b

docs(aws): rephrase before you start disclaimer

49bc797

tw review overview page

ad0dffc

tw review manual setup

936915c

indentation

bc96618

fix link reference

5c70609

docs(ref/manual): address review feedback

9ca3549

Langleu force-pushed the infraex-250 branch from 7537908 to 9ca3549 Compare December 17, 2024 09:18

github-actions bot temporarily deployed to camunda-docs December 17, 2024 09:27 Destroyed

docs(aws): add example ec2 calculator

89eeefb

Langleu reviewed Dec 17, 2024

View reviewed changes

github-actions bot temporarily deployed to camunda-docs December 17, 2024 13:11 Destroyed

conceptualshark added 2 commits December 17, 2024 15:07

Merge branch 'main' into infraex-250

28cadd5

Merge branch 'main' into infraex-250

1ec4d2f

github-actions bot temporarily deployed to camunda-docs December 17, 2024 21:06 Destroyed

conceptualshark added 4 commits December 18, 2024 13:40

combine architecture and recommendations

6cc1087

Edit overview

65c6233

update manual deployment

3fb477e

update ec2 guide

4bfd7ab

github-actions bot temporarily deployed to camunda-docs December 18, 2024 20:01 Destroyed

conceptualshark commented Dec 18, 2024

View reviewed changes

Langleu approved these changes Dec 19, 2024

View reviewed changes

conceptualshark merged commit 5df996f into main Dec 19, 2024
8 checks passed

conceptualshark deleted the infraex-250 branch December 19, 2024 21:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ec2 architecture and guide #4585

ec2 architecture and guide #4585

conceptualshark commented Nov 8, 2024 •

edited by Langleu

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

leiicamundi left a comment

leiicamundi Dec 10, 2024

Langleu Dec 12, 2024

Langleu Dec 12, 2024

leiicamundi Dec 12, 2024

Langleu Dec 12, 2024

conceptualshark Dec 17, 2024

Langleu Dec 17, 2024

conceptualshark left a comment

Langleu commented Dec 19, 2024

github-actions bot commented Dec 19, 2024


		<!-- TODO: add calculator specific for this setup -->
		To get an estimate, you can refer to this [example calculation](https://calculator.aws/#/estimate?id=8ce855e2d02d182c4910ec8b4ea2dbf42ea5fd1d), which can be further optimized to suit your specific use cases.

ec2 architecture and guide #4585

ec2 architecture and guide #4585

Conversation

conceptualshark commented Nov 8, 2024 • edited by Langleu 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

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

conceptualshark Dec 17, 2024

Choose a reason for hiding this comment

Langleu Dec 17, 2024

Choose a reason for hiding this comment

conceptualshark left a comment

Choose a reason for hiding this comment

Langleu commented Dec 19, 2024

github-actions bot commented Dec 19, 2024

conceptualshark commented Nov 8, 2024 •

edited by Langleu

Loading

github-actions bot commented Nov 8, 2024 •

edited

Loading

Langleu commented Nov 22, 2024 •

edited

Loading