Skip to content

Introduce k8s first approach to adding services

Marin Jankovski requested to merge docs/mj/architecture-overview into master

What does this MR do?

This MR addresses a need to change our development practices to consider building new services with Kubernetes in mind.

This MR does not declare that we need to develop features API first, or that we need to move to microservice architecture.

However, it does specify that shared state (such as shared files between services) or shared configuration should be carefully considered and that a shared space on the filesystem should no longer be an assumption.

Related issues

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Mike Jang

Merge request reports

Loading