@cloudsnorkel/cdk-github-runners 0.8.4 → 0.9.0

package/lib/providers/image-builders/common.d.ts

@@ -1,7 +1,9 @@
-import * as cdk from 'aws-cdk-lib';
-import { aws_ec2 as ec2, aws_iam as iam, aws_imagebuilder as imagebuilder, aws_logs as logs, aws_s3_assets as s3_assets, Duration, RemovalPolicy } from 'aws-cdk-lib';
+import { aws_ec2 as ec2, aws_iam as iam, aws_logs as logs, Duration, RemovalPolicy } from 'aws-cdk-lib';
 import { Construct } from 'constructs';
-import { Architecture, Os, RunnerVersion } from '../common';
+import { AwsImageBuilderRunnerImageBuilderProps } from './aws-image-builder';
+import { CodeBuildRunnerImageBuilderProps } from './codebuild';
+import { RunnerImageComponent } from './components';
+import { Architecture, Os, RunnerAmi, RunnerImage, RunnerVersion } from '../common';
 /**
  * @internal
  */
@@ -9,100 +11,106 @@ export declare function uniqueImageBuilderName(scope: Construct): string;
 /**
  * @internal
  */
-export declare abstract class ImageBuilderObjectBase extends cdk.Resource {
-    protected constructor(scope: Construct, id: string);
-    protected version(type: 'Component' | 'ImageRecipe' | 'ContainerRecipe', name: string, data: any): string;
-    private versionFunction;
-}
-/**
- * An asset including file or directory to place inside the built image.
- */
-export interface ImageBuilderAsset {
+export interface ImageBuilderBaseProps {
     /**
-     * Path to place asset in the image.
+     * Image architecture.
+     *
+     * @default Architecture.X86_64
      */
-    readonly path: string;
+    readonly architecture?: Architecture;
     /**
-     * Asset to place in the image.
+     * List of supported architectures to be checked against {@link architecture}.
      */
-    readonly asset: s3_assets.Asset;
-}
-/**
- * Properties for ImageBuilderComponent construct.
- */
-export interface ImageBuilderComponentProperties {
+    readonly supportedArchitectures: Architecture[];
     /**
-     * Component platform. Must match the builder platform.
+     * Image OS.
+     *
+     * @default OS.LINUX
      */
-    readonly platform: 'Linux' | 'Windows';
+    readonly os?: Os;
     /**
-     * Component display name.
+     * List of supported OS to be checked against {@link os}.
      */
-    readonly displayName: string;
+    readonly supportedOs: Os[];
     /**
-     * Component description.
+     * Version of GitHub Runners to install.
+     *
+     * @default latest version available
      */
-    readonly description: string;
+    readonly runnerVersion?: RunnerVersion;
     /**
-     * Shell commands to run when adding this component to the image.
+     * Schedule the AMI to be rebuilt every given interval. Useful for keeping the AMI up-do-date with the latest GitHub runner version and latest OS updates.
+     *
+     * Set to zero to disable.
      *
-     * On Linux, these are bash commands. On Windows, there are PowerShell commands.
+     * @default Duration.days(7)
      */
-    readonly commands: string[];
+    readonly rebuildInterval?: Duration;
     /**
-     * Optional assets to add to the built image.
+     * VPC where builder instances will be launched.
+     *
+     * @default default account VPC
      */
-    readonly assets?: ImageBuilderAsset[];
-}
-/**
- * Components are a set of commands to run and optional files to add to an image. Components are the building blocks of images built by Image Builder.
- *
- * Example:
- *
- * ```
- * new ImageBuilderComponent(this, 'AWS CLI', {
- *   platform: 'Windows',
- *   displayName: 'AWS CLI',
- *   description: 'Install latest version of AWS CLI',
- *   commands: [
- *     '$ErrorActionPreference = \'Stop\'',
- *     'Start-Process msiexec.exe -Wait -ArgumentList \'/i https://awscli.amazonaws.com/AWSCLIV2.msi /qn\'',
- *   ],
- * }
- * ```
- */
-export declare class ImageBuilderComponent extends ImageBuilderObjectBase {
+    readonly vpc?: ec2.IVpc;
     /**
-     * Component ARN.
+     * Security groups to assign to launched builder instances.
+     *
+     * @default new security group
      */
-    readonly arn: string;
+    readonly securityGroups?: ec2.ISecurityGroup[];
     /**
-     * Supported platform for the component.
+     * Where to place the network interfaces within the VPC.
+     *
+     * @default default VPC subnet
      */
-    readonly platform: 'Windows' | 'Linux';
-    private readonly assets;
-    constructor(scope: Construct, id: string, props: ImageBuilderComponentProperties);
+    readonly subnetSelection?: ec2.SubnetSelection;
     /**
-     * Grants read permissions to the principal on the assets buckets.
+     * The instance type used to build the image.
      *
-     * @param grantee
+     * @default m5.large
+     */
+    readonly instanceType?: ec2.InstanceType;
+    /**
+     * The number of days log events are kept in CloudWatch Logs. When updating
+     * this property, unsetting it doesn't remove the log retention policy. To
+     * remove the retention policy, set the value to `INFINITE`.
+     *
+     * @default logs.RetentionDays.ONE_MONTH
+     */
+    readonly logRetention?: logs.RetentionDays;
+    /**
+     * Removal policy for logs of image builds. If deployment fails on the custom resource, try setting this to `RemovalPolicy.RETAIN`. This way the logs can still be viewed, and you can see why the build failed.
+     *
+     * We try to not leave anything behind when removed. But sometimes a log staying behind is useful.
+     *
+     * @default RemovalPolicy.DESTROY
+     */
+    readonly logRemovalPolicy?: RemovalPolicy;
+    /**
+     * Pipeline and infrastructure description.
      */
-    grantAssetsRead(grantee: iam.IGrantable): void;
+    readonly imageTypeName: string;
 }
 /**
- * @internal
+ * Asset to copy into a built image.
  */
-export interface ImageBuilderBaseProps {
+export interface RunnerImageAsset {
+    /**
+     * Path on local system to copy into the image. Can be a file or a directory.
+     */
+    readonly source: string;
+    /**
+     * Target path in the built image.
+     */
+    readonly target: string;
+}
+export interface RunnerImageBuilderProps {
     /**
      * Image architecture.
      *
      * @default Architecture.X86_64
      */
     readonly architecture?: Architecture;
-    /**
-     * List of supported architectures to be checked against {@link architecture}.
-     */
-    readonly supportedArchitectures: Architecture[];
     /**
      * Image OS.
      *
@@ -110,9 +118,17 @@ export interface ImageBuilderBaseProps {
      */
     readonly os?: Os;
     /**
-     * List of supported OS to be checked against {@link os}.
+     * Base image from which Docker runner images will be built.
+     *
+     * @default public.ecr.aws/lts/ubuntu:22.04 for Os.LINUX_UBUNTU, public.ecr.aws/amazonlinux/amazonlinux:2 for Os.LINUX_AMAZON_2, mcr.microsoft.com/windows/servercore:ltsc2019-amd64 for Os.WINDOWS
      */
-    readonly supportedOs: Os[];
+    readonly baseDockerImage?: string;
+    /**
+     * Base AMI from which runner AMIs will be built.
+     *
+     * @default latest Ubuntu 20.04 AMI for Os.LINUX_UBUNTU, latest Amazon Linux 2 AMI for Os.LINUX_AMAZON_2, latest Windows Server 2022 AMI for Os.WINDOWS
+     */
+    readonly baseAmi?: string;
     /**
      * Version of GitHub Runners to install.
      *
@@ -120,7 +136,13 @@ export interface ImageBuilderBaseProps {
      */
     readonly runnerVersion?: RunnerVersion;
     /**
-     * Schedule the AMI to be rebuilt every given interval. Useful for keeping the AMI up-do-date with the latest GitHub runner version and latest OS updates.
+     * Components to install on the image.
+     *
+     * @default none
+     */
+    readonly components?: RunnerImageComponent[];
+    /**
+     * Schedule the image to be rebuilt every given interval. Useful for keeping the image up-do-date with the latest GitHub runner version and latest OS updates.
      *
      * Set to zero to disable.
      *
@@ -128,29 +150,21 @@ export interface ImageBuilderBaseProps {
      */
     readonly rebuildInterval?: Duration;
     /**
-     * VPC where builder instances will be launched.
+     * VPC to build the image in.
      *
-     * @default default account VPC
+     * @default no VPC
      */
     readonly vpc?: ec2.IVpc;
     /**
-     * Security groups to assign to launched builder instances.
-     *
-     * @default new security group
+     * Security Groups to assign to this instance.
      */
     readonly securityGroups?: ec2.ISecurityGroup[];
     /**
      * Where to place the network interfaces within the VPC.
      *
-     * @default default VPC subnet
+     * @default no subnet
      */
     readonly subnetSelection?: ec2.SubnetSelection;
-    /**
-     * The instance type used to build the image.
-     *
-     * @default m5.large
-     */
-    readonly instanceType?: ec2.InstanceType;
     /**
      * The number of days log events are kept in CloudWatch Logs. When updating
      * this property, unsetting it doesn't remove the log retention policy. To
@@ -160,7 +174,7 @@ export interface ImageBuilderBaseProps {
      */
     readonly logRetention?: logs.RetentionDays;
     /**
-     * Removal policy for logs of image builds. If deployment fails on the custom resource, try setting this to `RemovalPolicy.RETAIN`. This way the logs can still be viewed, and you can see why the build failed.
+     * Removal policy for logs of image builds. If deployment fails on the custom resource, try setting this to `RemovalPolicy.RETAIN`. This way the CodeBuild logs can still be viewed, and you can see why the build failed.
      *
      * We try to not leave anything behind when removed. But sometimes a log staying behind is useful.
      *
@@ -168,34 +182,77 @@ export interface ImageBuilderBaseProps {
      */
     readonly logRemovalPolicy?: RemovalPolicy;
     /**
-     * Pipeline and infrastructure description.
+     * @default CodeBuild for Linux Docker image, AWS Image Builder for Windows Docker image and any AMI
      */
-    readonly imageTypeName: string;
+    readonly builderType?: RunnerImageBuilderType;
+    /**
+     * Options specific to CodeBuild image builder. Only used when builderType is RunnerImageBuilderType.CODE_BUILD.
+     */
+    readonly codeBuildOptions?: CodeBuildRunnerImageBuilderProps;
+    /**
+     * Options specific to AWS Image Builder. Only used when builderType is RunnerImageBuilderType.AWS_IMAGE_BUILDER.
+     */
+    readonly awsImageBuilderOptions?: AwsImageBuilderRunnerImageBuilderProps;
+}
+export declare enum RunnerImageBuilderType {
+    /**
+     * Build runner images using AWS CodeBuild.
+     *
+     * Faster than AWS Image Builder, but can only be used to build Linux Docker images.
+     */
+    CODE_BUILD = "CodeBuild",
+    /**
+     * Build runner images using AWS Image Builder.
+     *
+     * Slower than CodeBuild, but can be used to build any type of image including AMIs and Windows images.
+     */
+    AWS_IMAGE_BUILDER = "AwsImageBuilder"
+}
+/**
+ * Interface for constructs that build an image that can be used in {@link IRunnerProvider}.
+ *
+ * An image can be a Docker image or AMI.
+ */
+export interface IRunnerImageBuilder {
+    /**
+     * Build and return a Docker image with GitHub Runner installed in it.
+     *
+     * Anything that ends up with an ECR repository containing a Docker image that runs GitHub self-hosted runners can be used. A simple implementation could even point to an existing image and nothing else.
+     *
+     * It's important that the specified image tag be available at the time the repository is available. Providers usually assume the image is ready and will fail if it's not.
+     *
+     * The image can be further updated over time manually or using a schedule as long as it is always written to the same tag.
+     */
+    bindDockerImage(): RunnerImage;
+    /**
+     * Build and return an AMI with GitHub Runner installed in it.
+     *
+     * Anything that ends up with a launch template pointing to an AMI that runs GitHub self-hosted runners can be used. A simple implementation could even point to an existing AMI and nothing else.
+     *
+     * The AMI can be further updated over time manually or using a schedule as long as it is always written to the same launch template.
+     */
+    bindAmi(): RunnerAmi;
 }
 /**
  * @internal
  */
-export declare abstract class ImageBuilderBase extends Construct implements ec2.IConnectable {
-    protected readonly architecture: Architecture;
-    protected readonly os: Os;
-    protected readonly platform: 'Windows' | 'Linux';
-    protected readonly description: string;
-    protected readonly runnerVersion: RunnerVersion;
-    protected components: ImageBuilderComponent[];
-    private readonly vpc;
-    private readonly subnetId;
-    private readonly securityGroups;
-    private readonly instanceType;
-    private readonly rebuildInterval;
-    private readonly logRetention;
-    private readonly logRemovalPolicy;
-    protected constructor(scope: Construct, id: string, props: ImageBuilderBaseProps);
-    protected createLog(recipeName: string): logs.LogGroup;
-    protected createInfrastructure(managedPolicies: iam.IManagedPolicy[]): imagebuilder.CfnInfrastructureConfiguration;
-    protected createImage(infra: imagebuilder.CfnInfrastructureConfiguration, dist: imagebuilder.CfnDistributionConfiguration, log: logs.LogGroup, imageRecipeArn?: string, containerRecipeArn?: string): imagebuilder.CfnImage;
-    protected createPipeline(infra: imagebuilder.CfnInfrastructureConfiguration, dist: imagebuilder.CfnDistributionConfiguration, log: logs.LogGroup, imageRecipeArn?: string, containerRecipeArn?: string): imagebuilder.CfnImagePipeline;
-    /**
-     * The network connections associated with this resource.
-     */
-    get connections(): ec2.Connections;
+export declare abstract class RunnerImageBuilderBase extends Construct implements ec2.IConnectable, iam.IGrantable, IRunnerImageBuilder {
+    protected components: RunnerImageComponent[];
+    protected constructor(scope: Construct, id: string, props?: RunnerImageBuilderProps);
+    abstract bindDockerImage(): RunnerImage;
+    abstract bindAmi(): RunnerAmi;
+    abstract get connections(): ec2.Connections;
+    abstract get grantPrincipal(): iam.IPrincipal;
+    /**
+     * Add a component to the image builder. The component will be added to the end of the list of components.
+     *
+     * @param component component to add
+     */
+    addComponent(component: RunnerImageComponent): void;
+    /**
+     * Remove a component from the image builder. Removal is done by component name. Multiple components with the same name will all be removed.
+     *
+     * @param component component to remove
+     */
+    removeComponent(component: RunnerImageComponent): void;
 }