Update instance-wide OAuth Application on GitLab.com for GitLab VS Code Extension

Production Change

Change Summary

In #6826 (closed) we've added a site-wide OAuth 2.0 application to allow authentication of the GitLab VS Code Extension.

In gitlab-org/gitlab-vscode-extension#633 (comment 1152850570) we've discussed adding an extra line to Redirect URI to support the same authentication flow from VSCodium, an open-source privacy friendly fork of VSCode (VSCode minus telemetry).

cc @phikai

Change Details

  1. Services Impacted - Production gitlab.com
  2. Change Technician - @marin
  3. Change Reviewer - @marin
  4. Time tracking - 2 min
  5. Downtime Component - No

Detailed steps for the change

Change Steps - steps to take to execute the change

Estimated Time to Complete (mins) - 2 min

  • On the top bar, select Menu > Admin.
  • On the left sidebar, select Applications.
  • Find "GitLab Workflow VS Code Extension" application
  • Make the following changes
    • Modify Redirect URI text area from: 
      vscode://gitlab.gitlab-workflow/authentication
vscode-insiders://gitlab.gitlab-workflow/authentication
      To: 
      vscode://gitlab.gitlab-workflow/authentication
vscode-insiders://gitlab.gitlab-workflow/authentication
vscodium://gitlab.gitlab-workflow/authentication

Rollback

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

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

  • On the top bar, select Menu > Admin.
  • On the left sidebar, select Applications.
  • Find "GitLab Workflow VS Code Extension" application
  • Make the following changes
    • Modify Redirect URI text area from: 
      vscode://gitlab.gitlab-workflow/authentication
vscode-insiders://gitlab.gitlab-workflow/authentication
vscodium://gitlab.gitlab-workflow/authentication
      To: 
      vscode://gitlab.gitlab-workflow/authentication
vscode-insiders://gitlab.gitlab-workflow/authentication

Monitoring

Key metrics to observe

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

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 labels blocks deployments and/or blocks feature-flags are applied as necessary

Change Technician checklist

  • Check if all items below are complete:
    • The change plan is technically accurate.
    • 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.
    • For C1 and C2 change issues, the change event is added to the GitLab Production calendar.
    • For C1 and C2 change issues, the SRE on-call has been informed prior to change being rolled out. (In #production channel, mention @sre-oncall and this issue and await their acknowledgement.)
    • For C1 and C2 change issues, the SRE on-call provided approval with the eoc_approved label on the issue.
    • For C1 and C2 change issues, the Infrastructure Manager provided approval with the manager_approved label on the issue.
    • Release managers have been informed (If needed! Cases include DB change) 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.
Edited by Marin Jankovski