Skip to content

Latest commit

 

History

History
132 lines (97 loc) · 3.62 KB

README.md

File metadata and controls

132 lines (97 loc) · 3.62 KB

AWS CodeBuild plugin for Backstage

This is the AWS CodeBuild plugin for backstage.io.

AWS CodeBuild plugin tab

It provides:

  1. Entity card that displays the build history of AWS CodeBuild projects related to that specific entity

The plugin consists of the following packages:

  • frontend: The frontend plugin package installed in Backstage
  • backend: The backend plugin package installed in Backstage
  • common: Types and utilities shared between the packages

Installing

This guide assumes that you are familiar with the general Getting Started documentation and have assumes you have an existing Backstage application.

Permissions

The IAM role(s) used by Backstage will require the following permissions:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "codebuild:BatchGetProjects",
        "codebuild:ListBuildsForProject",
        "codebuild:BatchGetBuilds"
      ],
      "Resource": "*"
    }
  ]
}

Note: This policy does not reflect least privilege and you should further limit the policy to the appropriate AWS resources.

Backend package

Install the backend package in your Backstage app:

yarn workspace backend add @aws/aws-codebuild-plugin-for-backstage-backend

Add the plugin to the packages/backend/src/index.ts:

const backend = createBackend();
// ...
backend.add(import('@aws/aws-codebuild-plugin-for-backstage-backend'));
// ...
backend.start();

Verify that the backend plugin is running in your Backstage app. You should receive {"status":"ok"} when accessing this URL:

https://<your backstage app>/api/aws-codebuild/health.

Frontend package

Install the frontend package in your Backstage app:

yarn workspace app add @aws/aws-codebuild-plugin-for-backstage

Edit packages/app/src/components/catalog/EntityPage.tsx to add the AWS CodeBuild card to the entity page:

import { EntityAwsCodeBuildCard } from '@aws/aws-codebuild-plugin-for-backstage';

// For example in the overview section
const overviewContent = (
  <Grid container spacing={3} alignItems="stretch">
  // ...
    <Grid item md={6}>
      <EntityAwsCodeBuildCard />
    </Grid>

Entity annotations

There are two annotations that can be used to reference CodeBuild projects for an entity.

The first will retrieve all CodeBuild projects with the matching tags, this is done with the aws.amazon.com/aws-codebuild-project-tags annotation:

# Example
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  # ...
  annotations:
    aws.amazon.com/aws-codebuild-project-tags: component=myapp
spec:
  type: service
  # ...

Please review the Locating resources documentation to understand any additional configuration required for tag-based lookup.

The alternative is to reference a specific ECS service by ARN, this is done with the aws.amazon.com/aws-codebuild-project-arn annotation:

# Example
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  # ...
  annotations:
    aws.amazon.com/aws-codebuild-project-arn: arn:aws:codebuild:us-west-2:1234567890:project/myapp-build
spec:
  type: service
  # ...

IAM Identity Center shortcut links

As a user of IAM Identity Center, you can make use of shortcut links by adding your AWS access portal subdomain to your app-config.yaml:

aws:
  sso:
    subdomain: d-xxxxxxxxxx