Skip to content

Draft:Run migration to self-migrate gitlab owned projects to not use pipeline variables

Production Change

Change Summary

In 18.4 Disable pipeline variables in projects that don’t use them group feature was introduced and this needs to be enabled in all GitLab owned groups (similar to https://gitlab.com/gitlab-com/gl-infra/production/-/issues/19774+).

  1. charts
  2. gitlab-community
  3. gitlab-cookbooks
  4. gitlab-data
  5. gitlab-dependency-committees
  6. gitlab-examples
  7. gitlab-private
  8. gitlab-renovate-forks
  9. gitlab-sirt
  10. security-products
  11. gitlab-org
  12. gitlab-com
  13. pages
  14. components
  15. gitlab-support-readiness

Enabling this feature essentially runs a migration which sets Minimum role to use pipeline variables to No one allowed in CI/CD project setting (-/settings/ci_cd#js-cicd-variables-settings). This will happen only in projects if they have not historically used pipeline variables as mentioned in the documentation

This option sets the Minimum role to use pipeline variables setting to no_one_allowed for projects that have never used pipeline variables.

Currently Default role to use pipeline variables is set to Developer in already existing projects in GitLab groups. This is a security risk because users with developer access will be then able to create pipelines by passing pipeline variables with any arbitrary values.

Change Details

  1. Services Impacted - ServiceGitlab
  2. Change Technician - DRI for the execution of this change
  3. Change Reviewer - @fabiopitino
  4. Scheduled Date and Time (UTC in format YYYY-MM-DD HH:MM) - Start date and time planned to execute change steps YYYY-MM-DD HH:MM
  5. Time tracking - 10 minutes
  6. Downtime Component - None

Important

If your change involves scheduled maintenance, add a step to set and unset maintenance mode per our runbooks. This will make sure SLA calculations adjust for the maintenance period.

Preparation

Note

The following checklists must be done in advance, before setting the label changescheduled

Change Reviewer checklist

C4 C3 C2 C1:

  • Check if the following applies:
    • The scheduled day and time of execution of the change is appropriate.
    • The change plan is technically accurate.
    • The change plan includes estimated timing values based on previous testing.
    • The change plan includes a viable rollback plan.
    • The specified metrics/monitoring dashboards provide sufficient visibility for the change.

C2 C1:

  • Check if the following applies:
    • The complexity of the plan is appropriate for the corresponding risk of the change. (i.e. the plan contains clear details).
    • The change plan includes success measures for all steps/milestones during the execution.
    • The change adequately minimizes risk within the environment/service.
    • The performance implications of executing the change are well-understood and documented.
    • The specified metrics/monitoring dashboards provide sufficient visibility for the change.
      • If not, is it possible (or necessary) to make changes to observability platforms for added visibility?
    • The change has a primary and secondary SRE with knowledge of the details available during the change window.
    • The change window has been agreed with Release Managers in advance of the change. If the change is planned for APAC hours, this issue has an agreed pre-change approval.
    • The labels blocks deployments and/or blocks feature-flags are applied as necessary.

Change Technician checklist

  • The Change Criticality has been set appropriately and requirements have been reviewed.
  • The change plan is technically accurate.
  • The rollback plan is technically accurate and detailed enough to be executed by anyone with access.
  • This Change Issue is linked to the appropriate Issue and/or Epic
  • Change has been tested in staging and results noted in a comment on this issue.
  • A dry-run has been conducted and results noted in a comment on this issue.
  • The change execution window respects the Production Change Lock periods.
  • Once all boxes above are checked, mark the change request as scheduled: /label ~"change::scheduled"
  • For C1 and C2 change issues, the change event is added to the GitLab Production calendar by the change-scheduler bot. It is schedule to run every 2 hours.
  • For C1 change issues, a Senior Infrastructure Manager has provided approval with the manager_approved label on the issue.
  • For C2 change issues, an Infrastructure Manager provided approval with the manager_approved label on the issue.
  • Mention @gitlab-org/saas-platforms/inframanagers in this issue to request approval and provide visibility to all infrastructure managers.
  • For C1, C2, or blocks deployments change issues, confirm with Release managers that the change does not overlap or hinder any release process (In #production channel, mention @release-managers and this issue and await their acknowledgment.)

Detailed steps for the change

Pre-execution steps

Note

The following steps should be done right at the scheduled time of the change request. The preparation steps are listed below.

  • Make sure all tasks in Change Technician checklist are done
  • For C1 and C2 change issues, the SRE on-call has been informed prior to change being rolled out. (Search the PagerDuty schedule for "SRE 8-hour" to find who will be on-call at the scheduled day and time. SREs on-call must be informed of plannable C1 changes at least 2 weeks in advance.)
    • The SRE on-call provided approval with the eoc_approved label on the issue.
  • For C1, C2, or blocks deployments change issues, Release managers have been informed prior to change being rolled out. (In #production channel, mention @release-managers and this issue and await their acknowledgment.)
  • There are currently no active incidents that are severity1 or severity2
  • If the change involves doing maintenance on a database host, an appropriate silence targeting the host(s) should be added for the duration of the change.

Change steps - steps to take to execute the change

Estimated Time to Complete (mins) - Estimated Time to Complete in Minutes

Rollback

Rollback steps - steps to be taken in the event of a need to rollback this change

There is no option in UI to undo the migrations. This change will sets Minimum role to use pipeline variables to No one allowed in CI/CD project setting (-/settings/ci_cd#js-cicd-variables-settings) where it is not already set. So to undo the effect in a project, Minimum role to use pipeline variables setting can be set to already existing value (developer in most of the cases).

Estimated Time to Complete (mins) - Estimated Time to Complete in Minutes

  • Got to the CI/CD project setting and set Minimum role to use pipeline variables to Developers
  • Set label changeaborted /label ~change::aborted

Monitoring

Key metrics to observe

  • Metric: Metric Name
    • Location: Dashboard URL
    • What changes to this metric should prompt a rollback: Describe Changes
Edited by Nikhil George