Skip to content

Draft: Link Helm chart documentation to reference architectures

Christiaan Conover requested to merge doc-helm-ref-arch into master

Why is this change being made?

Closes gitlab-org/gitlab#351145 (moved)

Our reference architectures for cloud native deployment recommend against deploying all GitLab components with Kubernetes, but the Helm chart documentation does not make any such assertion nor link to the reference architectures for guidance. This is causing confusion for customers, and a sub-optimal experience for production deployments.

This merge request adds clarity in the Helm chart documentation that reference architectures should be consulted for production instances, and that customers should follow that guidance over the technical capabilities listed in the Helm chart documentation.

Author Checklist

  • Provided a concise title for the MR
  • Added a description to this MR explaining the reasons for the proposed change, per say-why-not-just-what
    • Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added.
  • Assign reviewers for this change to the correct DRI(s)
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the "Maintained by" section in on the page being edited.
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies.
  • If the changes affect team members, or warrant an announcement in another way, please consider posting an update in #whats-happening-at-gitlab linking to this MR.
    • If this is a change that directly impacts the majority of global team members, it should be a candidate for #company-fyi. Please work with internal communications and check the handbook for examples.

Edited by Christiaan Conover

Merge request reports