docs(self-managed): refine docker compose page

[aabouzaid]

Description

Task: https://github.com/camunda/distribution/issues/287

We are moving the Docker Compose from camunda/camunda-platform repo to camunda/camunda-self-managed.

When should this change go live?

ASAP

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

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

[jessesimpson36]

I'm good with these changes. I'm going to leave some comments for a few typos I found.

[jessesimpson36]

Actually I think it was just the word "Contains", the rest looks fine.

[akeller]

@aabouzaid this is still in draft with no details or links in the description, but please be sure to add a tech writer for review before merging.

[aabouzaid]

@jessesimpson36 Thanks for the review, all points addressed ✔️
@akeller No worries, I usually leave the merge to the repo maintainers 😁

[conceptualshark]

I've left a few separate notes, but had a few overall questions when testing these steps.

It looks like these instructions come from the deprecated repo, which means several steps are outdated, or otherwise don't apply to the current setup in the new repo/in later versions.

The 8.6 and 8.7 compose files in the new repo require the use of --profile full to run; is this intended? Prior versions don't seem to require the profile.

Can you confirm:

• We should remove the Web Modeler file references/separate instructions after 8.6
• --profile full should be used running the full docker compose file after 8.6
• That the other sections are up-to-date

I can go through and test the differences/update the instructions, but wanted to make sure the above was correct first. Thank you!

[aabouzaid]

@conceptualshark Thanks for your review 🙌

We have some inconsistencies, so it would be great if you could review the documents to ensure that everything works as expected.

However, we will review the whole Docker Compose docs again because it didn't follow the same process as we had for Helm (and that's the idea of the SM repo).

Also, we will move away from that style (cloning) and provide artifacts to be downloaded directly.
But that's not here yet.

---

Answering the questions:

We should remove the Web Modeler file references/separate instructions after 8.6

They are needed for the standalone Web Modeler (they were missing in the new repo, and I've added them).

--profile full should be used running the full docker compose file after 8.6

I will check that and get back to you.

That the other sections are up-to-date

We need to verify that, but in general, that is what we have now anyway, and for sure, we need to review that.

[aabouzaid]

--profile full should be used running the full docker compose file after 8.6
I will check that and get back to you.

That has been reverted in favor of having a separate Docker Compose file for each case (many users were confused because of using --profile).

[conceptualshark]

I've made a few changes to the docker instructions in /next (docs/self-managed/setup/deploy/local/docker-compose.md) and started a preview site so it's a little easier to see changes. I've left a few open questions as individual comments. I also might have stepped on a few in-progress changes, sorry! I wasn't sure which issues had been fixed/pushed.

Once things look good structurally, I can update the older versions as well.

[conceptualshark]

I've formatted/edited these instructions, but the Kibana profile doesn't run for me in the provided 8.6 or alpha/8.7 compose file. Not sure if this is an error in my setup or in the profile. Can you verify Kibana works and that these instructions are correct?

[aabouzaid]

I've tried it with Camunda 8.6 Docker Compose, and it works as expected.
What issue/error do you have?

[aabouzaid]

@conceptualshark I'm done with all comments 🙌

[conceptualshark]

I went ahead and tested again, and backported these changes through 8.5. 8.6 looks the same as what was added, and in 8.5 the note about Web Modeler being included by default/any other descriptions about this have been removed.

This looks good to me at this point, let me know if it needs anything else! 👍

[aabouzaid]

For records, I've also updated the SM CI to test all versions and variations as we have them in the docs.
camunda/camunda-self-managed#50

Also, as mentioned, we will have another refinement cycle for Docker Compose to work on the 8.7 updates.

@conceptualshark Feel free to merge the PR (I can merge it if that's fine).

[github-actions]

🧹 Preview environment for this PR has been torn down.