While DuploCloud uses cURL commands to support Continuous Integration and Deployment (CI/CD) in , GitHub predefined actions are implemented to perform CI/CD tasks.

Introduction

The goal of this section is to show how you can upload to an S3 bucket from Github Actions.

This process is done in two basic steps:

• Logs in to AWS ECR using Just-In-Time (JIT) AWS credentials from DuploCloud

• Upload your website content to S3

Example workflows

To use any of the below examples you will need to change:

• The local path to upload from, if it is not build

• duplo_host env var

• TENANT_NAME env var

• BUCKET_NAME env var

Upload a single directory

The following example uploads a single directory to S3.

It does not show more advanced things like the following items:

• Setting cache control directives

• Making the uploaded content public

• Making AWS delete older content

Uploading directories with cache settings

This example uploads multiple directories to S3.

It assumes that the following is true:

• There is a subfolder named static, whose contents can be cached for one year.

• The rest of the contents can change at any time, so the cache uses must-revalidate.

Build and Push to ECR

This section aims to show you how to build a Docker image and push it to ECR.

It does three things:

• Logs in to AWS ECR (using just-in-time AWS credentials from DuploCloud)

• Builds and tags your Docker image, with the tags based on the Git commit SHA and ref.

• Pushes your Docker image

Example Workflow

Here is an example of a GitHub workflow that builds and pushes a Docker image to ECR.

To use it, ensure the following are configured correctly:

• DUPLO_HOST environment variable

• DUPLO_TOKEN environment variable

name: Publish Image
on:
  # Triggers the workflow on push to matching branches
  push:
    branches:
    - main
  # (Optional) Allows users to trigger the workflow manually from the GitHub UI
  workflow_dispatch: {}
  # (Optional) Allow other workflows to use this workflow and its outputs
  workflow_call: 
    outputs:
      image:
        description: The URI of the image
        value: ${{ jobs.build_image.outputs.image }}
    secrets:
      DUPLO_TOKEN:
        description: The token to use for DuploCloud API calls
        required: true

env:
  DUPLO_HOST: ${{ vars.DUPLO_HOST }}
  DUPLO_TOKEN: ${{ secrets.DUPLO_TOKEN }}
  # Images are usually stored in a dedicated tenant, so the name doesn't change
  DUPLO_TENANT: devops

jobs:
  build_image:
    name: Build and Push Image
    runs-on: ubuntu-latest
    outputs:
      image: ${{ steps.build_image.outputs.uri }}
    steps:

    - name: Checkout code
      uses: actions/checkout@v4

    # Configures DuploCloud and the host cloud, for example, AWS
    - name: Cloud CI Setup
      uses: v0.0.5
    
    # logs into the registry, configures Docker, builds the image, and lastly pushes
    - name: Build and Push Docker Image
      id: build_image
      uses: v0.0.5
      with:
        platforms: linux/amd64,linux/arm64
        push: true # false for dry runs
        build-args: >
          foo=bar
          ice_cream=chocolate
          name=${{ github.repository }}

References

• DuploCloud Build Image Action for GitHub

• NPM Pipeline Example

• GitHub on publishing Docker images

• Docker introduction to GitHub Actions

Update the docker image for a service

The goal of this section is to show how you can update the docker image for a Kubernetes service, after you have built that image. This task can be achieved using the action.

Example Workflow

This example makes some assumptions:

• Your workflow already has a build job - we created one in the previous section

• Your build job declares an output named image - also done in the previous section

To use it you will need to ensure your GHA Environment has the following:

• DUPLO_HOST env var

• DUPLO_TENANT env var

• DUPLO_TOKEN env var

You need to change the service name below from my-service to the name of your actual service.

Update the docker image for a service

The goal of this section is to show how you can update the docker image for an ECS service, after you have built that image. This task can be achieved using the action.

Example Workflow

This example makes some assumptions:

• Your workflow already has a build job - we created one in the previous section

• Your build job declares an output named image - also done in the previous section

To use it you will need to ensure your GHA Environment has the following:

• DUPLO_HOST env var

• DUPLO_TENANT env var

• DUPLO_TOKEN env var

You need to change the service name below from my-service to the name of your actual service.

Prerequisites

Follow these steps to interact with your Duplocloud Portal from GitHub Actions.

1. Create a Service Account

First you need a service account in your portal with the permissions.

Adding Tenant access for users

Setup Duplocloud in a Workflow

Here is the most basic setup for any pipeline to get started.

Configuring Environments for GitHub Actions

The most common use case with Duplocloud is to match up one Tenant to one Environment. Imagine we have a tenant named dev01, then you make a new environment in every repo, which will deploy to it named dev01. Often, you may not even need to add any secrets or variables because we have already added the DUPLO_HOST and DUPLO_TOKEN at the repo level earlier, and you only need the name of the environment as the value for the DUPLO_TENANT.

This shows how to configure a job to use an environment using an input and match it up to the tenant.

The input type is environment which only works on workflow_dispatch because it provides a UI with a drop-down selector for choosing from the list of configured Github Environments. On any other event type, the environment input would be a type string, and you pass in a name.

Retrieving a DuploCloud ID from a GitHub Actions script

Retrieve the Duplo Tenant ID from the duplocloud_tenant in the Terraform data source using the syntax: `duplocloud_tenant.tenant1.id`.

References:

Instead of deploying your Lambda code in the same pipeline as your infrastructure, you can use CI/CD and GitHub Actions pipelines. With DuploCloud's GitHub Actions integration, you can build and deploy in your AWS account by deploying a Lambda image or by a package uploaded to an S3 bucket.

Update a Function Using an Image

Use the following code as a template to update a Lambda container image with GitHub Actions. In this example, the Lambda container image in the dev01 The tenant is updated and redeployed.

You must ensure the following are configured in your environment and your specific situation.

• The name of lambda is set on the action to your actual lambda

• Duplocloud context configured correctly

Update Lambda based on a package in Amazon S3

Use the following code as a template to deploy your Lambda functions to an S3 bucket with GitHub Actions. In this example, the Lambda in the dev01 The tenant is updated using an S3 bucket that contains mylambda-v1.zip

You must ensure the following are configured in your environment and your specific situation.

• Duplocloud context configured correctly

• S3KEY

• S3BUCKET

• LAMBDA_NAME

References

• Dockerhub Lambda Base Images

Introduction

The goal of this section is to show how you can upload to an S3 bucket and update a CloudFront distribution from Github Actions.

This process is done in four basic steps:

• Logs in to AWS ECR using Just-In-Time (JIT) AWS credentials from DuploCloud

• Build your website content

• Upload your website content to S3

• Inform AWS CloudFront that the website content has changed

Example workflow

To use it you will need to change the following:

• The steps used to build your website content

• duplo_host env var

• CLOUDFRONT_ID env var

• TENANT_NAME env var

• BUCKET_NAME env var

You also likely will need to change the paths and AWS CLI arguments used to upload your website content.