Skip to main content

Adding New Service

When adding a new service that uses a new Docker image the following adjustments have to be done.

Go​

Create the Golang service and put the command line code in /go/cmd. Make sure to name the folder and the main source file starting with the "ar" prefix: our go/justfile depends on it.

Docker​

Create new Dockerfile that will be used to start the service. Our Docker files are located in /docker directory. The Dockerfile should be named with the "ar" prefix the same and should match the name of the folder in /go/cmd. The name of the image is derived from the name of the Dockerfile by removing the extension.

Terraform​

Create a new service in Terraform - to run it in Cloud Run use the google_cloud_run_service resource type and remember about creating the service account using google_service_account.

Take a note of the Cloud Run service name deployed by the Terraform code. It must match the name of the service deployed by GitHub CI/CD in the QA environment.

If you decide to refactor any Terraform code, make sure that you moved all the existing resources. If you don't do this, Terraform will destroy these resources in Prod with possible loss of data.

GitHub​

There are steps needed to be done in our CI/CD pipline to:

  1. Build the binary, if required. See the .github/workflows/build-backend.yml: go-build-* jobs.
  2. Build the service Docker image. See the .github/workflows/build-backend.yml: docker-build-* jobs.
  3. Deploy the service to QA after each merge to main. See the .github/workflows/build-backend.yml: deploy-* jobs.
  4. Promote the service Docker image during production deployment. See the .github/workflows/deploy-backend-prod.yml: deploy-* jobs.
  5. Deploy the service.

Building the Service Docker Image​

In order to build the service Docker image adjust the /.github/build-backend.yml file and include the build steps. Keep in mind that you will need two steps:

  • building the Go code itself
  • building the Docker image

You can use the go-build-generic-event-consumer job as the source on how to build the Go code and docker-build-generic-event-consumer as the source on how to build the Docker image.

Deploy the Service to QA​

To deploy the built Docker image adjust the /.github/build-backend.yml file and include the deploy step. You can use the deploy-generic-event-consumer as the source on how to do that.

Important: The name of the deployed service must be the same as used in Terraform code that deploys the Cloud Run instance!

Promote the Service Docker Image and Deploy to Production​

During the release to production the service Docker images have to be pushed to the production image repository. This is done in the /.github/deploy-backend-prod.yml and you need to adjust that file.

Have a look at the deploy-argeneric-event-consumer job in the mentioned file on the source on how to do that.

Things to keep in mind:

  • in the promote step the service_name is the actuall name of the Docker image file.
  • in the deploy step the service_name needs to match the service name from Terraform
  • in the deploy step the image_name is the actuall name of the image