.gitlab-ci.yml

@@ -45,8 +45,8 @@ variables:
   CANONICAL_PROJECT_PATH: 'gitlab-org/charts/gitlab'
   SECURITY_PROJECT_PATH: 'gitlab-org/security/charts/gitlab'
   DEV_PROJECT_PATH: 'gitlab/charts/gitlab'
-  QA_FULL_SUITE_OPTIONS: '--tag ~smoke --tag ~reliable --tag ~skip_live_env --tag ~orchestrated --tag ~transient'
-  QA_SANITY_SUITE_OPTIONS: '--tag smoke --tag reliable --tag ~skip_live_env --tag ~orchestrated'
+  QA_FULL_SUITE_OPTIONS: '--tag ~smoke --tag ~blocking --tag ~skip_live_env --tag ~orchestrated --tag ~transient'
+  QA_SANITY_SUITE_OPTIONS: '--tag smoke --tag blocking --tag ~skip_live_env --tag ~orchestrated'
   DEBIAN_VERSION: bullseye
   RUBY_VERSION: "3.0"
   CI_TOOLS_VERSION: "4.22.0"
@@ -235,8 +235,9 @@ approve_cluster_tests:
   rules:
     - if: '$PIPELINE_TYPE =~ /MR_PIPELINE$/'
       when: manual
-    - if: '$PIPELINE_TYPE =~ /FEATURE_BRANCH_PIPELINE$/'
+    - if: '$PIPELINE_TYPE =~ /FEATURE_BRANCH_PIPELINE$/ && $PIPELINE_TYPE != "CANONICAL_FEATURE_BRANCH_PIPELINE"'
       when: manual
+    - if: '$PIPELINE_TYPE == "CANONICAL_FEATURE_BRANCH_PIPELINE"'
   needs:
     - job: danger-review
       optional: true
@@ -799,7 +800,7 @@ release_package:
     - if: '$PIPELINE_TYPE =~ /FEATURE_BRANCH_PIPELINE$/'
     - if: '$PIPELINE_TYPE == "QA_KNAPSACK_UPDATE_PIPELINE"'
 
-# QA jobs for Smoke and Reliable E2E suites
+# QA jobs for Smoke and Blocking E2E suites
 
 qa_gke127:
   extends: .qa_branch

charts/gitlab/charts/gitaly/templates/_statefulset_spec.yaml

@@ -131,6 +131,14 @@ spec:
               value: '/etc/gitaly/config.toml'
             - name: SSL_CERT_DIR
               value: '/etc/ssl/certs'
+            {{- $gomemlimitIsDuplicate := include "checkDuplicateKeyFromEnv" (dict "keyToFind" "GOMEMLIMIT" "extraEnv" .Values.extraEnv "extraEnvFrom" .Values.extraEnvFrom ) }}
+            {{- if and (.Values.gomemlimit.enabled) (((.Values.resources).limits).memory) (eq $gomemlimitIsDuplicate "false") }}
+            - name: GOMEMLIMIT
+              valueFrom:
+                resourceFieldRef:
+                  containerName: {{ .Chart.Name }}
+                  resource: limits.memory
+            {{- end }}
             {{- include "gitlab.tracing.env" . | nindent 12 }}
             {{- include "gitlab.extraEnv" . | nindent 12 }}
             {{- include "gitlab.extraEnvFrom" (dict "root" $ "local" .) | nindent 12 }}

charts/gitlab/charts/gitaly/values.yaml

@@ -187,3 +187,7 @@ gpgSigning: {}
 
 backup: {}
   # goCloudUrl:
+
+# default enable gomemlimit to avoid gc related OOM errors
+gomemlimit:
+  enabled: true

doc/charts/gitlab/gitaly/index.md

@@ -118,6 +118,7 @@ the `helm install` command using the `--set` flags.
 | `metrics.serviceMonitor.additionalLabels`        | `{}`                                              | Additional labels to add to the ServiceMonitor                                                                                                                                 |
 | `metrics.serviceMonitor.endpointConfig`          | `{}`                                              | Additional endpoint configuration for the ServiceMonitor                                                                                                                       |
 | `metrics.metricsPort`                            |                                                   | **DEPRECATED** Use `metrics.port`                                                                                                                                              |
+| `gomemlimit.enabled`                            | `true`                                             | This will automatically set the `GOMEMLIMIT` environment variable for the Gitaly container to `resources.limits.memory`, if that limit is also set. Users can override this value by setting this value false and setting `GOMEMLIMIT` in `extraEnv`. This must meet [documented format criteria](https://pkg.go.dev/runtime#hdr-Environment_Variables). |
 
 ## Chart configuration examples
 

doc/development/gitlab-qa/index.md

@@ -96,14 +96,14 @@ when end-to-end tests are grouped by various [RSpec metadata](https://docs.gitla
 - _Smoke suite_: small [subset of fast end-to-end functional tests](https://docs.gitlab.com/ee/development/testing_guide/smoke.html)
 to quickly ensure that basic functionality is working
   - Enable this suite via `export QA_OPTIONS="--tag smoke"`
-- _Smoke and Reliable suite_: subset of smoke and reliable tests to verify that the
+- _Smoke and Blocking suite_: subset of smoke and blocking tests to verify that the
 major functionality is working
-  - Enable this suite via `export QA_OPTIONS="--tag smoke --tag reliable --tag ~skip_live_env --tag ~orchestrated  --tag ~github"`
+  - Enable this suite via `export QA_OPTIONS="--tag smoke --tag blocking --tag ~skip_live_env --tag ~orchestrated  --tag ~github"`
 - _Full suite_: running all tests against the environment. Test run will take more than an hour.
   - Enable this suite via `--tag ~skip_live_env --tag ~orchestrated --tag ~requires_praefect --tag ~github --tag ~requires_git_protocol_v2 --tag ~transient`
 
 Selecting a test suite depends on the use case. In the majority of cases, running
-Smoke and Reliable suite should give quick and consistent test results
+Smoke and Blocking suite should give quick and consistent test results
 as well as a good test coverage. This suite is being used as a sanity
 check in [GitLab.com deployments](https://handbook.gitlab.com/handbook/engineering/deployments-and-releases/deployments/#gitlabcom-deployments-process).
 

spec/configuration/gitaly_spec.rb

@@ -481,4 +481,46 @@ describe 'Gitaly configuration' do
       )
     end
   end
+
+  context 'gomemlimit' do
+    let(:values) do
+      YAML.safe_load(%(
+        gitlab:
+          gitaly:
+            resources:
+              limits:
+                memory: #{resources_limits_memory}
+            gomemlimit:
+              enabled: #{gomemlimit_enabled}
+      )).merge(default_values)
+    end
+
+    let(:gitaly_stateful_set) { 'StatefulSet/test-gitaly' }
+
+    context 'when enabled' do
+      let(:gomemlimit_enabled) { 'true' }
+      let(:resources_limits_memory) { '100Mi' }
+
+      it 'sets the env var GOMEMLIMIT' do
+        t = HelmTemplate.new(values)
+        gitaly_set = t.resources_by_kind('StatefulSet').select { |key| key == gitaly_stateful_set }
+        gitaly_container_env = gitaly_set[gitaly_stateful_set]['spec']['template']['spec']['containers'][0]['env']
+        expect(gitaly_container_env).to include(
+          'name' => 'GOMEMLIMIT',
+          'valueFrom' => { 'resourceFieldRef' => { 'containerName' => 'gitaly', 'resource' => 'limits.memory' } })
+      end
+    end
+
+    context 'when not enabled' do
+      let(:gomemlimit_enabled) { 'false' }
+      let(:resources_limits_memory) { '' }
+
+      it 'does not set the env var GOMEMLIMIT' do
+        t = HelmTemplate.new(values)
+        gitaly_set = t.resources_by_kind('StatefulSet').select { |key| key == gitaly_stateful_set }
+        gitaly_container_env = gitaly_set[gitaly_stateful_set]['spec']['template']['spec']['containers'][0]['env']
+        expect(gitaly_container_env.map { |env| env['name'] }).not_to include('GOMEMLIMIT')
+      end
+    end
+  end
 end

templates/_helpers.tpl

@@ -571,3 +571,19 @@ result in different hash values due to fields like `Release.IsUpgrade`,
 {{-     printf "%s-%s-%s" .Chart.Version .Chart.AppVersion ( $values | toYaml | b64enc ) | sha256sum | trunc 7 -}}
 {{-   end -}}
 {{- end -}}
+
+{{/*
+Return a boolean value that indicates whether a given key exists in the provided environment
+variables.
+
+Usage: {{- include checkDuplicateKeyFromEnv (dict "keyToFind" "MY_KEY", "extraEnv" .Values.extraEnv, "extraEnvFrom"
+.Values.extraEnvFrom) -}}
+*/}}
+{{- define "checkDuplicateKeyFromEnv" -}}
+  {{- $keyToFind := .keyToFind -}}
+  {{- $extraEnv := .extraEnv -}}
+  {{- $extraEnvFrom := .extraEnvFrom -}}
+  {{- $combinedKeys := merge $extraEnv $extraEnvFrom -}}
+  
+  {{ hasKey $combinedKeys $keyToFind }}
+{{- end -}}
\ No newline at end of file