Skip to content

Commit b36bca9

Browse files
J. B. Crawforderead
J. B. Crawford
authored andcommitted
Expand on issues with in-cluster Gitaly
1 parent a89dec7 commit b36bca9

File tree

1 file changed

+5
-3
lines changed
  • doc/administration/reference_architectures

1 file changed

+5
-3
lines changed

doc/administration/reference_architectures/index.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,8 @@ In most cases the downtime required for doing an upgrade shouldn't be substantia
101101

102102
### Cloud Native Hybrid (Kubernetes HA)
103103

104-
As an additional layer of HA resilience you can deploy select components in Kubernetes, known as a Cloud Native Hybrid Reference Architecture.
104+
As an additional layer of HA resilience you can deploy select components in Kubernetes, known as a Cloud Native Hybrid Reference Architecture. For stability
105+
reasons, stateful components such as Gitaly [cannot be deployed in Kubernetes](#stateful-components-in-kubernetes).
105106

106107
This is an alternative and more **advanced** setup compared to a standard Reference Architecture. Running services in Kubernetes is well known to be complex. **This setup is only recommended** if you have strong working knowledge and experience in Kubernetes.
107108

@@ -384,8 +385,9 @@ While we endeavour to try and have a good range of support for GitLab environmen
384385

385386
[Running stateful components in Kubernetes, such as Gitaly Cluster, is not supported](https://docs.gitlab.com/charts/installation/#configure-the-helm-chart-to-use-external-stateful-data).
386387

387-
Gitaly Cluster is only supported to be run on VMs as Git itself doesn't match well with the Kubernetes design and attempting to run it can lead to significant and complex issues.
388-
[Refer to epic 6127 for more information](https://gitlab.com/groups/gitlab-org/-/epics/6127).
388+
Gitaly Cluster is only supported on conventional virtual machines. Kubernetes enforces strict memory restrictions but Git memory usage is unpredictable, which
389+
can cause sporadic OOM termination of Gitaly pods, leading to significant disruptions and potential data loss. For this reason and others, Gitaly is not tested
390+
or supported in Kubernetes. For more information, see [epic 6127](https://gitlab.com/groups/gitlab-org/-/epics/6127).
389391

390392
This also applies to other third-party stateful components such as Postgres and Redis, but you can explore other third-party solutions for those components if desired such as supported Cloud Provider services unless called out specifically as unsupported.
391393

0 commit comments

Comments
 (0)