Skip to content

Partner Team Quick Deployment Guide for Lower Environments

Jump to bottom
Lisa Chung edited this page Aug 16, 2024 · 8 revisions

This guide outlines steps for VRO's partner teams to independently deploy and verify feature branch changes in dev and qa environments without the assistance of VRO engineers.

Note: this guide does not cover code releases or deployments to higher environments such as sandbox or prod, which require the use of signed Docker images. For more detailed documentation, visit here.

🆕 jump to Deploying with ArgoCD

Deploying with GitHub Actions

1. Mirror the latest changes (ignore if deploying from the develop branch)

  1. Visit abd-vro repo Github action here
  2. Select your feature branch and click "Run workflow".
  3. Make sure your feature branch from the abd-vro-internal repo here has the latest commit hash.
image

2. Publish image

Run SecRel workflow to publish the image

The 'Run SecRel and sign images' checkbox is necessary only for deployments in upper environments, such as sandbox, prod-test, and prod.
image

3. Deploy

  1. Select your feature branch from the dropdown.
  2. Select dev or qa for the 'Target LHDI environment'.
  3. Enter the first 7 characters of the commit hash or use latest.
  4. Keep the rollback and shutdown chart completely checkboxes unchecked
  5. Click "Run workflow".
image

4. View logs

Datadog URL (requires PIV card) image

Deploying via ArgoCD

Step 1: Determine the commit hash

The commit may be on any branch that has been pushed to the public abd-vro repository. Copy the first 7 characters of the unique ID.

For a listing of commits on the develop branch: Commits

Step 2: Create a PR with the desired deployment(s)

Navigate to the configuration file specific for the app and environment(s):

Edit the file(s) so that image.tag is assigned to the value determined in Step 1. If imageTag is also defined, update its value, too. (Some configurations have both image.tag and imageTag; VRO is investigating whether the latter can be eliminated.) Commit the changes to a branch.

This example shows image.tag and imageTag on lines 6 and 3, respectively:

image

Create a pull request (PR) for the branch.

Step 3

Hold for the PR to be approved. Your team and the VRO team will automatically be notified of the pending PR (implemented through CODEOWNERS).

Step 4

Merge the approved PR. ArgoCD will detect the change and execute the deployment as part of its auto-sync behavior. Its default polling interval: 3 minutes.

The deployment action will be visible on the Deployments by Image tag per Week tile of the VRO on LHDI dashboard. Use the "namespace" and "deployment" filters on the top bar to filter the results.

This screenshot shows the deployments for EP Merge on the dev and qa environments: image

VRO is exploring options for pushing deployment status updates to Slack (#3309).

Demonstration

The below gif shows an example of creating a pull request for a deployment of domain-xample. Not shown: subsequent steps in GitHub and Datadog, as they are not unique to the deployment process.

argoCdDeploymentPartnerTeam

Clone this wiki locally