microservices-demo/.github/workflows
djmailhot 0d450fb62d
Fix GitHub action workflow for license check
CI workflows are failing the license check.  This change allows empty git commits in the license check.
2020-10-13 12:40:31 -07:00
..
ci.yml Fix GitHub action workflow for license check 2020-10-13 12:40:31 -07:00
README.md Add licenses (#367) 2020-07-15 11:56:37 -07:00

GitHub Actions Workflows

Setup

  • workloads run using GitHub self-hosted runners
  • project admins maintain a private Google Compute Engine VM for running tests
    • VM should be at least n1-standard-4 with 50GB persistent disk
    • instructions for setting up the VM can be found in repo settings under "Actions"
    • ⚠️ WARNING: VM should be set up with no GCP service account
      • external contributors could contribute malicious PRs to run code on our test VM. Ensure no service accounts or other secrets exist on the VM
      • An empty GCP project should be used for extra security
    • to set up dependencies, run the following commands:
      # install kubectl
      sudo apt-get install kubectl
      
      # install go
      curl -O https://storage.googleapis.com/golang/go1.12.9.linux-amd64.tar.gz
      tar -xvf go1.12.9.linux-amd64.tar.gz
      sudo chown -R root:root ./go
      sudo mv go /usr/local
      echo 'export GOPATH=$HOME/go' >> ~/.profile
      echo 'export PATH=$PATH:/usr/local/go/bin:$GOPATH/bin' >> ~/.profile
      source ~/.profile
      
      # install addlicense
      go get -u github.com/google/addlicense
      sudo ln -s $HOME/go/bin/addlicense /bin
      
      # install kind
      curl -Lo ./kind "https://github.com/kubernetes-sigs/kind/releases/download/v0.7.0/kind-$(uname)-amd64" && \
      chmod +x ./kind && \
      sudo mv ./kind /usr/local/bin
      
      # install skaffold
      curl -Lo skaffold https://storage.googleapis.com/skaffold/releases/latest/skaffold-linux-amd64 && \
      chmod +x skaffold && \
      sudo mv skaffold /usr/local/bin
      
      # install docker
      sudo apt install apt-transport-https ca-certificates curl gnupg2 software-properties-common && \
      curl -fsSL https://download.docker.com/linux/debian/gpg | sudo apt-key add - && \
      sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/debian $(lsb_release -cs) stable" && \
      sudo apt update && \
      sudo apt install docker-ce && \
      sudo usermod -aG docker ${USER}
      
      # logout and back on
      exit
      
    • ensure GitHub Actions runs as background service:
      sudo /actions-runner/svc.sh install
      sudo /actions-runner/svc.sh start
      

Workflows

ci.yaml

Triggers

  • commits pushed to master
  • PRs to master
  • PRs to release/ branches

Actions

  • ensures kind cluster is running
  • builds all containers in src/
  • deploys local containers to kind
    • ensures all pods reach ready state
    • ensures HTTP request to frontend returns HTTP status 200
  • deploys manifests from /releases
    • ensures all pods reach ready state
    • ensures HTTP request to frontend returns HTTP status 200