Development: Add documentation for production setup using Docker

[BBesrour]

Checklist

General

• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Motivation and Context

Updates the 'Multiple Artemis Instances' docs to include instructions for a production setup using docker. This is intended for developers and admins to quickly test the prod env.

Description

Added instructions to start Multiple Artemis Instances for Linux, Windows, and MacOS using docker. Also added instructions on how to run a setup with separated core and buildagent instances.

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked

Review Progress

Performance Review

• I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance
• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Exam Mode Test

• Test 1
• Test 2

Test Coverage

Screenshots

Summary by CodeRabbit

• Documentation

  • Updated setup documentation for running multiple Artemis instances locally using Docker, including detailed instructions for various operating systems.

• New Features

  • Enhanced version control integration with new environment variables for user authentication in node configurations.

• Refactor

  • Modified Spring profiles in node configuration to optimize service roles.
  • Updated version control URL to improve connectivity between nodes.

• Chores

  • Streamlined load balancing by adjusting the upstream server configuration in Nginx.

[coderabbitai]

Walkthrough

The updates focus on enhancing the Artemis setup for distributed environments using Docker. Changes include configuring Artemis instances, modifying environment variables, and adjusting the load balancer setup. The alterations streamline profiles and update version control settings, aiming to optimize the system for different operational roles and improve connectivity between nodes.

Changes

Files	Change Summary
docs/admin/setup/distributed.rst	Documented the setup process for Artemis in a distributed environment using Docker.
docker/artemis/config/node1.env	Removed buildagent from SPRING_PROFILES_ACTIVE.
docker/artemis/config/node2.env	Added version control user and password environment variables.
docker/artemis/config/node3.env	Updated Spring profiles and added version control credentials.
docker/artemis/config/prod-multinode.env	Updated the ARTEMIS_VERSIONCONTROL_URL to point to a new node.
docker/nginx/.../artemis-upstream-multi-node.conf	Removed configuration for artemis-app-node-3:8080 from the upstream server list.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

[github-actions]

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

[coderabbitai]

Actionable comments posted: 2

[laurenzfb]

overall lgtm. just some minor nitpicks

[rstief]

LGTM, just had a few notes on grammar

[laurenzfb]

looks good now :)

[JohannesWt]

Changes and documentation looks good to me

[Hialus]

Looks good to me now. Great work!