Skip to content

README-cicd-setup.md

Latest commit

 

History

History
73 lines (59 loc) · 2.45 KB

README-cicd-setup.md

File metadata and controls

73 lines (59 loc) · 2.45 KB
Raw

Example configuration for CI/CD

This example shows how to configure the github workflow CI/CD pipeline authentication for the project.

Example

Permissions for the github workflow job:

# These permissions are needed to interact with GitHub's OIDC Token endpoint.
permissions:
  id-token: write
  contents: read

Authentication steps:

Using infrastructure repository provided composite action:

jobs:
  ...snip...
  steps:
    ...snip...
    - name: Configure AWS credentials
      uses: Virtual-Finland-Development/infrastructure/.github/actions/configure-aws-credentials@main
      with:
        environment: ${{ inputs.environment }}
        aws-region: ${{ secrets.AWS_REGION }}
        pulumi-access-token: ${{ secrets.PULUMI_ACCESS_TOKEN }}
    ...snip...

Or using the action directly:

jobs:
  ...snip...
  steps:
      ...snip...
      - name: Get IAM role from Pulumi
        uses: Virtual-Finland-Development/pulumi-outputs-action@v1
        id: infra-iam-role
        with:
          organization: virtualfinland
          project: infrastructure
          stack: dev
          resource: DeployerIAMRole
          access-token: ${{ secrets.PULUMI_ACCESS_TOKEN }}
      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v2
        with:
          aws-region: eu-north-1
          role-to-assume: ${{ steps.infra-iam-role.outputs.resource-output }}
          role-session-name: infrastructure-test
      ...snip...

Explanation of the steps:

  • Get IAM role from Pulumi: This step will get the IAM role ARN from the Pulumi stack output
  • Configure AWS credentials: This step will configure the AWS credentials using the aws-actions/configure-aws-credentials action
    • role-to-assume: This is the IAM role ARN from the previous step
    • role-session-name: This is used to identify the session in logs

Full example: ./.github/workflows/test.yml

Related references