257 lines
10 KiB
YAML
257 lines
10 KiB
YAML
name: CD
|
|
|
|
# Ensures that only one workflow task will run at a time. Previous deployments, if
|
|
# already in process, won't get cancelled. Instead, we let the first to complete
|
|
# then queue the latest pending workflow, cancelling any workflows in between
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
cancel-in-progress: false
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
inputs:
|
|
network:
|
|
default: 'Mainnet'
|
|
description: 'Network to deploy: Mainnet or Testnet'
|
|
required: true
|
|
checkpoint_sync:
|
|
default: 'true'
|
|
description: 'Use as many checkpoints as possible when syncing'
|
|
required: true
|
|
push:
|
|
branches:
|
|
- main
|
|
release:
|
|
types:
|
|
- published
|
|
|
|
jobs:
|
|
# If a release was made we want to extract the first part of the semver from the
|
|
# tag_name
|
|
#
|
|
# Generate the following output to pass to subsequent jobs
|
|
# - If our semver is `v1.3.0` the resulting output from this job would be `v1`
|
|
#
|
|
# Note: We just use the first part of the version to replace old instances, and change
|
|
# it when a major version is released, to keep a segregation between new and old
|
|
# versions.
|
|
versioning:
|
|
name: Versioning
|
|
runs-on: ubuntu-latest
|
|
outputs:
|
|
major_version: ${{ steps.set.outputs.major_version }}
|
|
if: ${{ github.event_name == 'release' }}
|
|
steps:
|
|
- name: Getting Zebrad Version
|
|
id: get
|
|
uses: actions/github-script@v6.4.1
|
|
with:
|
|
result-encoding: string
|
|
script: |
|
|
return context.payload.release.tag_name.substring(0,2)
|
|
- name: Setting API Version
|
|
id: set
|
|
run: echo "major_version=${{ steps.get.outputs.result }}" >> "$GITHUB_OUTPUT"
|
|
|
|
# Each time this workflow is executed, a build will be triggered to create a new image
|
|
# with the corresponding tags using information from Git
|
|
#
|
|
# The image will be commonly named `zebrad:<short-hash | github-ref | semver>`
|
|
build:
|
|
name: Build CD Docker
|
|
uses: ./.github/workflows/build-docker-image.yml
|
|
with:
|
|
dockerfile_path: ./docker/Dockerfile
|
|
dockerfile_target: runtime
|
|
image_name: zebrad
|
|
# We need to hard-code Mainnet here, because env is not allowed in this context
|
|
network: ${{ inputs.network || 'Mainnet' }}
|
|
checkpoint_sync: true
|
|
rust_backtrace: '1'
|
|
zebra_skip_ipv6_tests: '1'
|
|
rust_log: info
|
|
|
|
# Test that Zebra works using the default config with the latest Zebra version
|
|
test-configuration-file:
|
|
name: Test Zebra default Docker config file
|
|
timeout-minutes: 5
|
|
runs-on: ubuntu-latest
|
|
needs: build
|
|
steps:
|
|
- uses: r7kamura/rust-problem-matchers@v1.3.0
|
|
|
|
- name: Inject slug/short variables
|
|
uses: rlespinasse/github-slug-action@v4
|
|
with:
|
|
short-length: 7
|
|
|
|
- name: Run tests using the default config
|
|
run: |
|
|
set -ex
|
|
docker pull ${{ vars.GAR_BASE }}/zebrad@${{ needs.build.outputs.image_digest }}
|
|
docker run --detach --name default-conf-tests -t ${{ vars.GAR_BASE }}/zebrad@${{ needs.build.outputs.image_digest }}
|
|
EXIT_STATUS=$(docker logs --tail all --follow default-conf-tests 2>&1 | grep -q --extended-regexp --max-count=1 -e 'estimated progress to chain tip.*BeforeOverwinter'; echo $?; )
|
|
docker stop default-conf-tests
|
|
docker logs default-conf-tests
|
|
exit "$EXIT_STATUS"
|
|
|
|
# This jobs handles the deployment of a Managed Instance Group (MiG) with 2 nodes in
|
|
# the us-central1 region. Two different groups of MiGs are deployed one for pushes to
|
|
# the main branch and another for version releases of Zebra
|
|
#
|
|
# Once this workflow is triggered the previous MiG is replaced, on pushes to main its
|
|
# always replaced, and with releases its only replaced if the same major version is
|
|
# being deployed, otherwise a new major version is deployed
|
|
#
|
|
# Runs:
|
|
# - on every push/merge to the `main` branch
|
|
# - on every release, when it's published
|
|
deploy-nodes:
|
|
name: Deploy ${{ inputs.network || 'Mainnet' }} nodes
|
|
needs: [ build, test-configuration-file, versioning ]
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
permissions:
|
|
contents: 'read'
|
|
id-token: 'write'
|
|
if: ${{ !cancelled() && !failure() && ((github.event_name == 'push' && github.ref_name == 'main') || github.event_name == 'release') }}
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3.5.2
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- name: Inject slug/short variables
|
|
uses: rlespinasse/github-slug-action@v4
|
|
with:
|
|
short-length: 7
|
|
|
|
# Makes the Zcash network name lowercase.
|
|
#
|
|
# Labels in GCP are required to be in lowercase, but the blockchain network
|
|
# uses sentence case, so we need to downcase ${{ inputs.network || 'Mainnet' }}.
|
|
#
|
|
# Passes the lowercase network to subsequent steps using $NETWORK env variable.
|
|
- name: Downcase network name for labels
|
|
run: |
|
|
NETWORK_CAPS="${{ inputs.network || 'Mainnet' }}"
|
|
echo "NETWORK=${NETWORK_CAPS,,}" >> "$GITHUB_ENV"
|
|
|
|
# Setup gcloud CLI
|
|
- name: Authenticate to Google Cloud
|
|
id: auth
|
|
uses: google-github-actions/auth@v1.1.1
|
|
with:
|
|
retries: '3'
|
|
workload_identity_provider: '${{ vars.GCP_WIF }}'
|
|
service_account: '${{ vars.GCP_DEPLOYMENTS_SA }}'
|
|
|
|
- name: Set up Cloud SDK
|
|
uses: google-github-actions/setup-gcloud@v1.1.1
|
|
|
|
# TODO we should implement the fixes from https://github.com/ZcashFoundation/zebra/pull/5670 here
|
|
# but the implementation is failing as it's requiring the disk names, contrary to what is stated in the official documentation
|
|
- name: Create instance template
|
|
run: |
|
|
gcloud compute instance-templates create-with-container zebrad-${{ needs.versioning.outputs.major_version || env.GITHUB_REF_SLUG_URL }}-${{ env.GITHUB_SHA_SHORT }} \
|
|
--boot-disk-type=pd-ssd \
|
|
--image-project=cos-cloud \
|
|
--image-family=cos-stable \
|
|
--container-image ${{ vars.GAR_BASE }}/zebrad@${{ needs.build.outputs.image_digest }} \
|
|
--create-disk=name=zebrad-cache-${{ env.GITHUB_SHA_SHORT }},auto-delete=yes,size=300GB,type=pd-ssd \
|
|
--container-mount-disk=mount-path="/zebrad-cache",name=zebrad-cache-${{ env.GITHUB_SHA_SHORT }} \
|
|
--machine-type ${{ vars.GCP_SMALL_MACHINE }} \
|
|
--network-interface=subnet=${{ vars.GCP_SUBNETWORK }} \
|
|
--service-account ${{ vars.GCP_DEPLOYMENTS_SA }} \
|
|
--scopes cloud-platform \
|
|
--labels=app=zebrad,environment=prod,network=${NETWORK},github_ref=${{ env.GITHUB_REF_SLUG_URL }} \
|
|
--tags zebrad
|
|
|
|
# Check if our destination instance group exists already
|
|
- name: Check if instance group exists
|
|
id: does-group-exist
|
|
continue-on-error: true
|
|
run: |
|
|
gcloud compute instance-groups list | grep "zebrad-${{ needs.versioning.outputs.major_version || env.GITHUB_REF_SLUG_URL }}" | grep "${{ vars.GCP_REGION }}"
|
|
|
|
# Deploy new managed instance group using the new instance template
|
|
- name: Create managed instance group
|
|
if: steps.does-group-exist.outcome == 'failure'
|
|
run: |
|
|
gcloud compute instance-groups managed create \
|
|
"zebrad-${{ needs.versioning.outputs.major_version || env.GITHUB_REF_SLUG_URL }}" \
|
|
--template "zebrad-${{ needs.versioning.outputs.major_version || env.GITHUB_REF_SLUG_URL }}-${{ env.GITHUB_SHA_SHORT }}" \
|
|
--health-check zebrad-tracing-filter \
|
|
--initial-delay 30 \
|
|
--region "${{ vars.GCP_REGION }}" \
|
|
--size 1
|
|
|
|
# Rolls out update to existing group using the new instance template
|
|
- name: Update managed instance group
|
|
if: steps.does-group-exist.outcome == 'success'
|
|
run: |
|
|
gcloud compute instance-groups managed rolling-action start-update \
|
|
"zebrad-${{ needs.versioning.outputs.major_version || env.GITHUB_REF_SLUG_URL }}" \
|
|
--version template="zebrad-${{ needs.versioning.outputs.major_version || env.GITHUB_REF_SLUG_URL }}-${{ env.GITHUB_SHA_SHORT }}" \
|
|
--region "${{ vars.GCP_REGION }}"
|
|
|
|
# This jobs handles the deployment of a single node (1) in the us-central1-a zone
|
|
# when an instance is required to test a specific commit
|
|
#
|
|
# Runs:
|
|
# - on request, using workflow_dispatch with regenerate-disks
|
|
#
|
|
# Note: this instances are not automatically replaced or deleted
|
|
deploy-instance:
|
|
name: Deploy single instance
|
|
needs: [ build, test-configuration-file ]
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
permissions:
|
|
contents: 'read'
|
|
id-token: 'write'
|
|
if: github.event_name == 'workflow_dispatch'
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3.5.2
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- name: Inject slug/short variables
|
|
uses: rlespinasse/github-slug-action@v4
|
|
with:
|
|
short-length: 7
|
|
|
|
# Setup gcloud CLI
|
|
- name: Authenticate to Google Cloud
|
|
id: auth
|
|
uses: google-github-actions/auth@v1.1.1
|
|
with:
|
|
retries: '3'
|
|
workload_identity_provider: '${{ vars.GCP_WIF }}'
|
|
service_account: '${{ vars.GCP_DEPLOYMENTS_SA }}'
|
|
|
|
- name: Set up Cloud SDK
|
|
uses: google-github-actions/setup-gcloud@v1.1.1
|
|
|
|
# Create instance template from container image
|
|
- name: Manual deploy of a single instance running zebrad
|
|
run: |
|
|
gcloud compute instances create-with-container "zebrad-${{ env.GITHUB_REF_SLUG_URL }}-${{ env.GITHUB_SHA_SHORT }}" \
|
|
--boot-disk-size 300GB \
|
|
--boot-disk-type=pd-ssd \
|
|
--image-project=cos-cloud \
|
|
--image-family=cos-stable \
|
|
--container-stdin \
|
|
--container-tty \
|
|
--container-image ${{ vars.GAR_BASE }}/zebrad@${{ needs.build.outputs.image_digest }} \
|
|
--create-disk=auto-delete=yes,size=300GB,type=pd-ssd \
|
|
--create-disk=name=zebrad-cache-${{ env.GITHUB_SHA_SHORT }},auto-delete=yes,size=300GB,type=pd-ssd \
|
|
--container-mount-disk=mount-path='/zebrad-cache',name=zebrad-cache-${{ env.GITHUB_SHA_SHORT }} \
|
|
--machine-type ${{ vars.GCP_SMALL_MACHINE }} \
|
|
--network-interface=subnet=${{ vars.GCP_SUBNETWORK }} \
|
|
--service-account ${{ vars.GCP_DEPLOYMENTS_SA }} \
|
|
--labels=app=zebrad,environment=qa,network=${NETWORK},github_ref=${{ env.GITHUB_REF_SLUG_URL }} \
|
|
--tags zebrad \
|
|
--zone ${{ vars.GCP_ZONE }}
|