# API Reference ## Constructs ### Cache A GitLab Runner cache consisting of an Amazon S3 bucket. The bucket is encrypted with a KMS managed master key, it has public access blocked and will be cleared and deleted on CFN stack deletion. #### Initializers ```typescript import { Cache } from '@pepperize/cdk-autoscaling-gitlab-runner' new Cache(scope: Construct, id: string, props?: CacheProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | CacheProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Optional - *Type:* CacheProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { Cache } from '@pepperize/cdk-autoscaling-gitlab-runner' Cache.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | bucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `bucket`Required ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ### GitlabRunnerAutoscaling The Gitlab Runner autoscaling on EC2 by Docker Machine. *Example* ```typescript Provisioning a basic Runner const app = new cdk.App(); const stack = new cdk.Stack(app, "RunnerStack", { env: { account: "000000000000", region: "us-east-1", } }); const token = new StringParameter(stack, "imported-token", { parameterName: "/gitlab-runner/token1", stringValue: gitlabToken, type: ParameterType.SECURE_STRING, tier: ParameterTier.STANDARD, }); new GitlabRunnerAutoscaling(stack, "GitlabRunner", { runners: [{ token: "xxxxxxxxxxxxxxxxxxxx" }], }); ``` #### Initializers ```typescript import { GitlabRunnerAutoscaling } from '@pepperize/cdk-autoscaling-gitlab-runner' new GitlabRunnerAutoscaling(scope: Stack, id: string, props: GitlabRunnerAutoscalingProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | aws-cdk-lib.Stack | *No description.* | | id | string | *No description.* | | props | GitlabRunnerAutoscalingProps | *No description.* | --- ##### `scope`Required - *Type:* aws-cdk-lib.Stack --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* GitlabRunnerAutoscalingProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { GitlabRunnerAutoscaling } from '@pepperize/cdk-autoscaling-gitlab-runner' GitlabRunnerAutoscaling.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | | manager | GitlabRunnerAutoscalingManager | *No description.* | | network | Network | *No description.* | | runners | GitlabRunnerAutoscalingJobRunner[] | *No description.* | | checkInterval | number | *No description.* | | concurrent | number | *No description.* | | logFormat | string | *No description.* | | logLevel | string | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `cacheBucket`Required ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ##### `manager`Required ```typescript public readonly manager: GitlabRunnerAutoscalingManager; ``` - *Type:* GitlabRunnerAutoscalingManager --- ##### `network`Required ```typescript public readonly network: Network; ``` - *Type:* Network --- ##### `runners`Required ```typescript public readonly runners: GitlabRunnerAutoscalingJobRunner[]; ``` - *Type:* GitlabRunnerAutoscalingJobRunner[] --- ##### `checkInterval`Optional ```typescript public readonly checkInterval: number; ``` - *Type:* number --- ##### `concurrent`Optional ```typescript public readonly concurrent: number; ``` - *Type:* number --- ##### `logFormat`Optional ```typescript public readonly logFormat: string; ``` - *Type:* string --- ##### `logLevel`Optional ```typescript public readonly logLevel: string; ``` - *Type:* string --- ### GitlabRunnerAutoscalingJobRunner #### Initializers ```typescript import { GitlabRunnerAutoscalingJobRunner } from '@pepperize/cdk-autoscaling-gitlab-runner' new GitlabRunnerAutoscalingJobRunner(scope: Construct, id: string, props: GitlabRunnerAutoscalingJobRunnerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | GitlabRunnerAutoscalingJobRunnerProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* GitlabRunnerAutoscalingJobRunnerProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { GitlabRunnerAutoscalingJobRunner } from '@pepperize/cdk-autoscaling-gitlab-runner' GitlabRunnerAutoscalingJobRunner.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | configuration | RunnerConfiguration | *No description.* | | instanceProfile | aws-cdk-lib.aws_iam.CfnInstanceProfile | *No description.* | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | *No description.* | | machineImage | aws-cdk-lib.aws_ec2.IMachineImage | *No description.* | | role | aws-cdk-lib.aws_iam.IRole | *No description.* | | keyPair | aws-cdk-lib.aws_secretsmanager.ISecret | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `configuration`Required ```typescript public readonly configuration: RunnerConfiguration; ``` - *Type:* RunnerConfiguration --- ##### `instanceProfile`Required ```typescript public readonly instanceProfile: CfnInstanceProfile; ``` - *Type:* aws-cdk-lib.aws_iam.CfnInstanceProfile --- ##### `instanceType`Required ```typescript public readonly instanceType: InstanceType; ``` - *Type:* aws-cdk-lib.aws_ec2.InstanceType --- ##### `machineImage`Required ```typescript public readonly machineImage: IMachineImage; ``` - *Type:* aws-cdk-lib.aws_ec2.IMachineImage --- ##### `role`Required ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole --- ##### `keyPair`Optional ```typescript public readonly keyPair: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- ### GitlabRunnerAutoscalingManager Settings for the manager (coordinator). Manager coordinates the placement of runner (job executor) instances #### Initializers ```typescript import { GitlabRunnerAutoscalingManager } from '@pepperize/cdk-autoscaling-gitlab-runner' new GitlabRunnerAutoscalingManager(scope: Construct, id: string, props: GitlabRunnerAutoscalingManagerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | GitlabRunnerAutoscalingManagerProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* GitlabRunnerAutoscalingManagerProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { GitlabRunnerAutoscalingManager } from '@pepperize/cdk-autoscaling-gitlab-runner' GitlabRunnerAutoscalingManager.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | | globalConfiguration | GlobalConfiguration | *No description.* | | initConfig | aws-cdk-lib.aws_ec2.CloudFormationInit | *No description.* | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | *No description.* | | machineImage | aws-cdk-lib.aws_ec2.IMachineImage | *No description.* | | network | Network | *No description.* | | role | aws-cdk-lib.aws_iam.IRole | *No description.* | | runners | GitlabRunnerAutoscalingJobRunner[] | *No description.* | | runnersSecurityGroupName | string | *No description.* | | userData | aws-cdk-lib.aws_ec2.UserData | *No description.* | | keyPairName | string | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `cacheBucket`Required ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ##### `globalConfiguration`Required ```typescript public readonly globalConfiguration: GlobalConfiguration; ``` - *Type:* GlobalConfiguration --- ##### `initConfig`Required ```typescript public readonly initConfig: CloudFormationInit; ``` - *Type:* aws-cdk-lib.aws_ec2.CloudFormationInit --- ##### `instanceType`Required ```typescript public readonly instanceType: InstanceType; ``` - *Type:* aws-cdk-lib.aws_ec2.InstanceType --- ##### `machineImage`Required ```typescript public readonly machineImage: IMachineImage; ``` - *Type:* aws-cdk-lib.aws_ec2.IMachineImage --- ##### `network`Required ```typescript public readonly network: Network; ``` - *Type:* Network --- ##### `role`Required ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole --- ##### `runners`Required ```typescript public readonly runners: GitlabRunnerAutoscalingJobRunner[]; ``` - *Type:* GitlabRunnerAutoscalingJobRunner[] --- ##### `runnersSecurityGroupName`Required ```typescript public readonly runnersSecurityGroupName: string; ``` - *Type:* string --- ##### `userData`Required ```typescript public readonly userData: UserData; ``` - *Type:* aws-cdk-lib.aws_ec2.UserData --- ##### `keyPairName`Optional ```typescript public readonly keyPairName: string; ``` - *Type:* string --- ### Network Network settings for the manager and runners. All EC2 instances should belong to the same subnet, availability zone and vpc. #### Initializers ```typescript import { Network } from '@pepperize/cdk-autoscaling-gitlab-runner' new Network(scope: Construct, id: string, props?: NetworkProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NetworkProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Optional - *Type:* NetworkProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | hasPrivateSubnets | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `hasPrivateSubnets` ```typescript public hasPrivateSubnets(): boolean ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { Network } from '@pepperize/cdk-autoscaling-gitlab-runner' Network.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | availabilityZone | string | *No description.* | | subnet | aws-cdk-lib.aws_ec2.ISubnet | *No description.* | | vpc | aws-cdk-lib.aws_ec2.IVpc | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `availabilityZone`Required ```typescript public readonly availabilityZone: string; ``` - *Type:* string --- ##### `subnet`Required ```typescript public readonly subnet: ISubnet; ``` - *Type:* aws-cdk-lib.aws_ec2.ISubnet --- ##### `vpc`Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc --- ## Structs ### AutoscalingConfiguration > [https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersmachineautoscaling-sections](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersmachineautoscaling-sections) #### Initializer ```typescript import { AutoscalingConfiguration } from '@pepperize/cdk-autoscaling-gitlab-runner' const autoscalingConfiguration: AutoscalingConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | idleCount | number | *No description.* | | idleTime | number | *No description.* | | periods | string[] | The Periods setting contains an array of string patterns of time periods represented in a cron-style format. https://github.com/gorhill/cronexpr#implementation. | | timezone | string | *No description.* | --- ##### `idleCount`Optional ```typescript public readonly idleCount: number; ``` - *Type:* number --- ##### `idleTime`Optional ```typescript public readonly idleTime: number; ``` - *Type:* number --- ##### `periods`Optional ```typescript public readonly periods: string[]; ``` - *Type:* string[] The Periods setting contains an array of string patterns of time periods represented in a cron-style format. https://github.com/gorhill/cronexpr#implementation. [second] [minute] [hour] [day of month] [month] [day of week] [year] --- *Example* ```typescript // "* * 7-22 * * mon-fri *" ``` ##### `timezone`Optional ```typescript public readonly timezone: string; ``` - *Type:* string --- ### CacheConfiguration #### Initializer ```typescript import { CacheConfiguration } from '@pepperize/cdk-autoscaling-gitlab-runner' const cacheConfiguration: CacheConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | s3 | CacheS3Configuration | *No description.* | | shared | boolean | *No description.* | | type | string | *No description.* | --- ##### `s3`Optional ```typescript public readonly s3: CacheS3Configuration; ``` - *Type:* CacheS3Configuration --- ##### `shared`Optional ```typescript public readonly shared: boolean; ``` - *Type:* boolean --- ##### `type`Optional ```typescript public readonly type: string; ``` - *Type:* string --- ### CacheProps #### Initializer ```typescript import { CacheProps } from '@pepperize/cdk-autoscaling-gitlab-runner' const cacheProps: CacheProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bucketName | string | The infix of the physical cache bucket name. | | expiration | aws-cdk-lib.Duration | The number of days after which the created cache objects are deleted from S3. | --- ##### `bucketName`Optional ```typescript public readonly bucketName: string; ``` - *Type:* string - *Default:* "runner-cache" The infix of the physical cache bucket name. --- ##### `expiration`Optional ```typescript public readonly expiration: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* 30 days The number of days after which the created cache objects are deleted from S3. --- ### CacheS3Configuration Define cache configuration for S3 storage. > [https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnerscaches3-section](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnerscaches3-section) #### Initializer ```typescript import { CacheS3Configuration } from '@pepperize/cdk-autoscaling-gitlab-runner' const cacheS3Configuration: CacheS3Configuration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | accessKey | string | *No description.* | | authenticationType | string | In GitLab 15.0 and later, explicitly set AuthenticationType to iam or access-key. | | bucketLocation | string | The name of the S3 region. | | bucketName | string | The name of the storage bucket where cache is stored. | | insecure | boolean | Set to true if the S3 service is available by HTTP. | | secretKey | string | *No description.* | | serverAddress | string | The AWS S3 host. | --- ##### `accessKey`Optional ```typescript public readonly accessKey: string; ``` - *Type:* string --- ##### `authenticationType`Optional ```typescript public readonly authenticationType: string; ``` - *Type:* string - *Default:* "iam" In GitLab 15.0 and later, explicitly set AuthenticationType to iam or access-key. > [https://gitlab.com/gitlab-org/gitlab-runner/-/issues/28171](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/28171) --- ##### `bucketLocation`Optional ```typescript public readonly bucketLocation: string; ``` - *Type:* string The name of the S3 region. --- ##### `bucketName`Optional ```typescript public readonly bucketName: string; ``` - *Type:* string - *Default:* "runners-cache" The name of the storage bucket where cache is stored. --- ##### `insecure`Optional ```typescript public readonly insecure: boolean; ``` - *Type:* boolean - *Default:* false Set to true if the S3 service is available by HTTP. --- ##### `secretKey`Optional ```typescript public readonly secretKey: string; ``` - *Type:* string --- ##### `serverAddress`Optional ```typescript public readonly serverAddress: string; ``` - *Type:* string - *Default:* "s3.amazonaws.com" The AWS S3 host. --- ### ConfigurationMapperProps #### Initializer ```typescript import { ConfigurationMapperProps } from '@pepperize/cdk-autoscaling-gitlab-runner' const configurationMapperProps: ConfigurationMapperProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | globalConfiguration | GlobalConfiguration | *No description.* | | runnersConfiguration | RunnerConfiguration[] | *No description.* | --- ##### `globalConfiguration`Required ```typescript public readonly globalConfiguration: GlobalConfiguration; ``` - *Type:* GlobalConfiguration --- ##### `runnersConfiguration`Required ```typescript public readonly runnersConfiguration: RunnerConfiguration[]; ``` - *Type:* RunnerConfiguration[] --- ### DockerConfiguration Configure docker on the runners. > [https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersdocker-section](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersdocker-section) #### Initializer ```typescript import { DockerConfiguration } from '@pepperize/cdk-autoscaling-gitlab-runner' const dockerConfiguration: DockerConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | allowedImages | string[] | Wildcard list of images that can be specified in the .gitlab-ci.yml file. If not present, all images are allowed (equivalent to ["*\/*:*"]). See Restrict Docker images and services. | | allowedServices | string[] | Wildcard list of services that can be specified in the .gitlab-ci.yml file. If not present, all images are allowed (equivalent to [*\/*:*]). See Restrict Docker images and services. | | cacheDir | string | Directory where Docker caches should be stored. | | capAdd | string[] | Add additional Linux capabilities to the container. | | capDrop | string[] | Drop additional Linux capabilities from the container. | | cpus | string | Number of CPUs (available in Docker 1.13 or later. A string. | | cpusetCpus | string | The control group’s CpusetCpus. | | cpuShares | number | Number of CPU shares used to set relative CPU usage. | | devices | string[] | Share additional host devices with the container. | | disableCache | boolean | The Docker executor has two levels of caching: a global one (like any other executor) and a local cache based on Docker volumes. | | disableEntrypointOverwrite | boolean | Disable the image entrypoint overwriting. | | dns | string[] | A list of DNS servers for the container to use. | | dnsSearch | string[] | A list of DNS search domains. | | extraHosts | string[] | Hosts that should be defined in container environment. | | gpus | string[] | GPU devices for Docker container. | | helperImage | string | (Advanced) The default helper image used to clone repositories and upload artifacts. | | helperImageFlavor | string | Sets the helper image flavor (alpine, alpine3.12, alpine3.13, alpine3.14 or ubuntu). Defaults to alpine. The alpine flavor uses the same version as alpine3.12. | | host | string | Custom Docker endpoint. | | hostname | string | Custom hostname for the Docker container. | | image | string | The image to run jobs with. | | links | string[] | Containers that should be linked with container that runs the job. | | memory | string | The memory limit. | | memoryReservation | string | The memory soft limit. | | memorySwap | string | The total memory limit. | | networkMode | string | Add container to a custom network. | | oomKillDisable | boolean | If an out-of-memory (OOM) error occurs, do not kill processes in a container. | | oomScoreAdjust | string | OOM score adjustment. | | privileged | boolean | Make the container run in privileged mode. | | pullPolicy | string | The image pull policy: never, if-not-present or always (default). | | runtime | string | The runtime for the Docker container. | | securityOpt | string | Security options (–security-opt in docker run). | | shmSize | number | Shared memory size for images (in bytes). | | sysctls | string | The sysctl options. | | tlsCertPath | string | A directory where ca.pem, cert.pem or key.pem are stored and used to make a secure TLS connection to Docker. Useful in boot2docker. | | tlsVerify | boolean | Enable or disable TLS verification of connections to Docker daemon. | | usernsMode | string | The user namespace mode for the container and Docker services when user namespace remapping option is enabled. | | volumeDriver | string | The volume driver to use for the container. | | volumes | string[] | Additional volumes that should be mounted. | | volumesFrom | string[] | A list of volumes to inherit from another container in the form [:]. | | waitForServicesTimeout | number | How long to wait for Docker services. | --- ##### `allowedImages`Optional ```typescript public readonly allowedImages: string[]; ``` - *Type:* string[] Wildcard list of images that can be specified in the .gitlab-ci.yml file. If not present, all images are allowed (equivalent to ["*\/*:*"]). See Restrict Docker images and services. --- ##### `allowedServices`Optional ```typescript public readonly allowedServices: string[]; ``` - *Type:* string[] Wildcard list of services that can be specified in the .gitlab-ci.yml file. If not present, all images are allowed (equivalent to [*\/*:*]). See Restrict Docker images and services. --- ##### `cacheDir`Optional ```typescript public readonly cacheDir: string; ``` - *Type:* string Directory where Docker caches should be stored. This path can be absolute or relative to current working directory. See disable_cache for more information. --- ##### `capAdd`Optional ```typescript public readonly capAdd: string[]; ``` - *Type:* string[] - *Default:* ["CAP_SYS_ADMIN"] Add additional Linux capabilities to the container. --- ##### `capDrop`Optional ```typescript public readonly capDrop: string[]; ``` - *Type:* string[] Drop additional Linux capabilities from the container. --- ##### `cpus`Optional ```typescript public readonly cpus: string; ``` - *Type:* string Number of CPUs (available in Docker 1.13 or later. A string. --- ##### `cpusetCpus`Optional ```typescript public readonly cpusetCpus: string; ``` - *Type:* string The control group’s CpusetCpus. A string. --- ##### `cpuShares`Optional ```typescript public readonly cpuShares: number; ``` - *Type:* number Number of CPU shares used to set relative CPU usage. Default is 1024. --- ##### `devices`Optional ```typescript public readonly devices: string[]; ``` - *Type:* string[] Share additional host devices with the container. --- ##### `disableCache`Optional ```typescript public readonly disableCache: boolean; ``` - *Type:* boolean - *Default:* false The Docker executor has two levels of caching: a global one (like any other executor) and a local cache based on Docker volumes. This configuration flag acts only on the local one which disables the use of automatically created (not mapped to a host directory) cache volumes. In other words, it only prevents creating a container that holds temporary files of builds, it does not disable the cache if the runner is configured in distributed cache mode. --- ##### `disableEntrypointOverwrite`Optional ```typescript public readonly disableEntrypointOverwrite: boolean; ``` - *Type:* boolean Disable the image entrypoint overwriting. --- ##### `dns`Optional ```typescript public readonly dns: string[]; ``` - *Type:* string[] A list of DNS servers for the container to use. --- ##### `dnsSearch`Optional ```typescript public readonly dnsSearch: string[]; ``` - *Type:* string[] A list of DNS search domains. --- ##### `extraHosts`Optional ```typescript public readonly extraHosts: string[]; ``` - *Type:* string[] Hosts that should be defined in container environment. --- ##### `gpus`Optional ```typescript public readonly gpus: string[]; ``` - *Type:* string[] GPU devices for Docker container. Uses the same format as the docker cli. View details in the Docker documentation. --- ##### `helperImage`Optional ```typescript public readonly helperImage: string; ``` - *Type:* string (Advanced) The default helper image used to clone repositories and upload artifacts. --- ##### `helperImageFlavor`Optional ```typescript public readonly helperImageFlavor: string; ``` - *Type:* string Sets the helper image flavor (alpine, alpine3.12, alpine3.13, alpine3.14 or ubuntu). Defaults to alpine. The alpine flavor uses the same version as alpine3.12. --- ##### `host`Optional ```typescript public readonly host: string; ``` - *Type:* string Custom Docker endpoint. Default is DOCKER_HOST environment or unix:///var/run/docker.sock. --- ##### `hostname`Optional ```typescript public readonly hostname: string; ``` - *Type:* string Custom hostname for the Docker container. --- ##### `image`Optional ```typescript public readonly image: string; ``` - *Type:* string The image to run jobs with. --- ##### `links`Optional ```typescript public readonly links: string[]; ``` - *Type:* string[] Containers that should be linked with container that runs the job. --- ##### `memory`Optional ```typescript public readonly memory: string; ``` - *Type:* string The memory limit. A string. --- ##### `memoryReservation`Optional ```typescript public readonly memoryReservation: string; ``` - *Type:* string The memory soft limit. A string. --- ##### `memorySwap`Optional ```typescript public readonly memorySwap: string; ``` - *Type:* string The total memory limit. A string. --- ##### `networkMode`Optional ```typescript public readonly networkMode: string; ``` - *Type:* string Add container to a custom network. --- ##### `oomKillDisable`Optional ```typescript public readonly oomKillDisable: boolean; ``` - *Type:* boolean If an out-of-memory (OOM) error occurs, do not kill processes in a container. --- ##### `oomScoreAdjust`Optional ```typescript public readonly oomScoreAdjust: string; ``` - *Type:* string OOM score adjustment. Positive means kill earlier. --- ##### `privileged`Optional ```typescript public readonly privileged: boolean; ``` - *Type:* boolean - *Default:* true Make the container run in privileged mode. Insecure. --- ##### `pullPolicy`Optional ```typescript public readonly pullPolicy: string; ``` - *Type:* string The image pull policy: never, if-not-present or always (default). View details in the pull policies documentation. You can also add multiple pull policies. --- ##### `runtime`Optional ```typescript public readonly runtime: string; ``` - *Type:* string The runtime for the Docker container. --- ##### `securityOpt`Optional ```typescript public readonly securityOpt: string; ``` - *Type:* string Security options (–security-opt in docker run). Takes a list of : separated key/values. --- ##### `shmSize`Optional ```typescript public readonly shmSize: number; ``` - *Type:* number - *Default:* 0 Shared memory size for images (in bytes). --- ##### `sysctls`Optional ```typescript public readonly sysctls: string; ``` - *Type:* string The sysctl options. --- ##### `tlsCertPath`Optional ```typescript public readonly tlsCertPath: string; ``` - *Type:* string A directory where ca.pem, cert.pem or key.pem are stored and used to make a secure TLS connection to Docker. Useful in boot2docker. --- ##### `tlsVerify`Optional ```typescript public readonly tlsVerify: boolean; ``` - *Type:* boolean - *Default:* false Enable or disable TLS verification of connections to Docker daemon. Disabled by default. --- ##### `usernsMode`Optional ```typescript public readonly usernsMode: string; ``` - *Type:* string The user namespace mode for the container and Docker services when user namespace remapping option is enabled. Available in Docker 1.10 or later. --- ##### `volumeDriver`Optional ```typescript public readonly volumeDriver: string; ``` - *Type:* string The volume driver to use for the container. --- ##### `volumes`Optional ```typescript public readonly volumes: string[]; ``` - *Type:* string[] Additional volumes that should be mounted. Same syntax as the Docker -v flag. --- ##### `volumesFrom`Optional ```typescript public readonly volumesFrom: string[]; ``` - *Type:* string[] A list of volumes to inherit from another container in the form [:]. Access level defaults to read-write, but can be manually set to ro (read-only) or rw (read-write). --- ##### `waitForServicesTimeout`Optional ```typescript public readonly waitForServicesTimeout: number; ``` - *Type:* number - *Default:* 300 How long to wait for Docker services. Set to 0 to disable. Default is 30. --- ### GitlabRunnerAutoscalingCacheProps The distributed GitLab runner S3 cache. Either pass an existing bucket or override default options. > [https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnerscaches3-section](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnerscaches3-section) #### Initializer ```typescript import { GitlabRunnerAutoscalingCacheProps } from '@pepperize/cdk-autoscaling-gitlab-runner' const gitlabRunnerAutoscalingCacheProps: GitlabRunnerAutoscalingCacheProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bucket | aws-cdk-lib.aws_s3.IBucket | An existing S3 bucket used as runner's cache. | | options | CacheProps | If no existing S3 bucket is provided, a S3 bucket will be created. | --- ##### `bucket`Optional ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket An existing S3 bucket used as runner's cache. --- ##### `options`Optional ```typescript public readonly options: CacheProps; ``` - *Type:* CacheProps If no existing S3 bucket is provided, a S3 bucket will be created. --- ### GitlabRunnerAutoscalingJobRunnerProps The runner EC2 instances configuration. If not set, the defaults will be used. #### Initializer ```typescript import { GitlabRunnerAutoscalingJobRunnerProps } from '@pepperize/cdk-autoscaling-gitlab-runner' const gitlabRunnerAutoscalingJobRunnerProps: GitlabRunnerAutoscalingJobRunnerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configuration | RunnerConfiguration | The runner EC2 instances configuration. | | token | aws-cdk-lib.aws_ssm.IStringParameter | The runner’s authentication token, which is obtained during runner registration. | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | Instance type for runner EC2 instances. | | keyPair | aws-cdk-lib.aws_secretsmanager.ISecret | Optionally pass a custom EC2 KeyPair, that will be used by the manager to connect to the job runner instances. | | machineImage | aws-cdk-lib.aws_ec2.IMachineImage | An Amazon Machine Image ID for the Runners EC2 instances. | | role | aws-cdk-lib.aws_iam.IRole | Optionally pass an IAM role, that get's assigned to the EC2 runner instances via Instance Profile. | --- ##### `configuration`Required ```typescript public readonly configuration: RunnerConfiguration; ``` - *Type:* RunnerConfiguration The runner EC2 instances configuration. If not set, the defaults will be used. > [RunnerConfiguration](RunnerConfiguration) --- ##### `token`Required ```typescript public readonly token: IStringParameter; ``` - *Type:* aws-cdk-lib.aws_ssm.IStringParameter The runner’s authentication token, which is obtained during runner registration. Not the same as the registration token. > [https://docs.gitlab.com/ee/api/runners.html#register-a-new-runner](https://docs.gitlab.com/ee/api/runners.html#register-a-new-runner) --- ##### `instanceType`Optional ```typescript public readonly instanceType: InstanceType; ``` - *Type:* aws-cdk-lib.aws_ec2.InstanceType - *Default:* InstanceType.of(InstanceClass.T3, InstanceSize.MICRO) Instance type for runner EC2 instances. It's a combination of a class and size. --- ##### `keyPair`Optional ```typescript public readonly keyPair: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret Optionally pass a custom EC2 KeyPair, that will be used by the manager to connect to the job runner instances.
  1. Example: aws secretsmanager create-secret --name AnyKeyPairSecret --secret-string "{\"theKeyPairName\":\"\",\"theKeyPairName.pub\":\"\"}"
  2. Additionally configure an unique key pair configuration.machine.machineOptions.keypairName
--- ##### `machineImage`Optional ```typescript public readonly machineImage: IMachineImage; ``` - *Type:* aws-cdk-lib.aws_ec2.IMachineImage An Amazon Machine Image ID for the Runners EC2 instances. If empty the latest Ubuntu 20.04 focal will be looked up. Any operating system supported by Docker Machine's provisioner. > [https://gitlab.com/gitlab-org/ci-cd/docker-machine/-/tree/main/libmachine/provision](https://gitlab.com/gitlab-org/ci-cd/docker-machine/-/tree/main/libmachine/provision) --- ##### `role`Optional ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole Optionally pass an IAM role, that get's assigned to the EC2 runner instances via Instance Profile. --- ### GitlabRunnerAutoscalingManagerBaseProps #### Initializer ```typescript import { GitlabRunnerAutoscalingManagerBaseProps } from '@pepperize/cdk-autoscaling-gitlab-runner' const gitlabRunnerAutoscalingManagerBaseProps: GitlabRunnerAutoscalingManagerBaseProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dockerMachineVersion | DockerMachineVersion | *No description.* | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | Instance type for manager EC2 instance. | | keyPairName | string | A set of security credentials that you use to prove your identity when connecting to an Amazon EC2 instance. | | machineImage | aws-cdk-lib.aws_ec2.IMachineImage | An Amazon Machine Image ID for the Manager EC2 instance. | --- ##### `dockerMachineVersion`Optional ```typescript public readonly dockerMachineVersion: DockerMachineVersion; ``` - *Type:* DockerMachineVersion --- ##### `instanceType`Optional ```typescript public readonly instanceType: InstanceType; ``` - *Type:* aws-cdk-lib.aws_ec2.InstanceType - *Default:* InstanceType.of(InstanceClass.T3, InstanceSize.NANO) Instance type for manager EC2 instance. It's a combination of a class and size. --- ##### `keyPairName`Optional ```typescript public readonly keyPairName: string; ``` - *Type:* string A set of security credentials that you use to prove your identity when connecting to an Amazon EC2 instance. You won't be able to ssh into an instance without the Key Pair. --- ##### `machineImage`Optional ```typescript public readonly machineImage: IMachineImage; ``` - *Type:* aws-cdk-lib.aws_ec2.IMachineImage An Amazon Machine Image ID for the Manager EC2 instance. If empty the latest Amazon 2 Image will be looked up. Should be RHEL flavor like Amazon Linux 2 with yum available for instance initialization. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-init.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-init.html) --- ### GitlabRunnerAutoscalingManagerProps #### Initializer ```typescript import { GitlabRunnerAutoscalingManagerProps } from '@pepperize/cdk-autoscaling-gitlab-runner' const gitlabRunnerAutoscalingManagerProps: GitlabRunnerAutoscalingManagerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dockerMachineVersion | DockerMachineVersion | *No description.* | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | Instance type for manager EC2 instance. | | keyPairName | string | A set of security credentials that you use to prove your identity when connecting to an Amazon EC2 instance. | | machineImage | aws-cdk-lib.aws_ec2.IMachineImage | An Amazon Machine Image ID for the Manager EC2 instance. | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | | network | Network | *No description.* | | runners | GitlabRunnerAutoscalingJobRunner[] | *No description.* | | runnersSecurityGroup | @pepperize/cdk-security-group.SecurityGroup | *No description.* | | globalConfiguration | GlobalConfiguration | *No description.* | | role | aws-cdk-lib.aws_iam.IRole | *No description.* | --- ##### `dockerMachineVersion`Optional ```typescript public readonly dockerMachineVersion: DockerMachineVersion; ``` - *Type:* DockerMachineVersion --- ##### `instanceType`Optional ```typescript public readonly instanceType: InstanceType; ``` - *Type:* aws-cdk-lib.aws_ec2.InstanceType - *Default:* InstanceType.of(InstanceClass.T3, InstanceSize.NANO) Instance type for manager EC2 instance. It's a combination of a class and size. --- ##### `keyPairName`Optional ```typescript public readonly keyPairName: string; ``` - *Type:* string A set of security credentials that you use to prove your identity when connecting to an Amazon EC2 instance. You won't be able to ssh into an instance without the Key Pair. --- ##### `machineImage`Optional ```typescript public readonly machineImage: IMachineImage; ``` - *Type:* aws-cdk-lib.aws_ec2.IMachineImage An Amazon Machine Image ID for the Manager EC2 instance. If empty the latest Amazon 2 Image will be looked up. Should be RHEL flavor like Amazon Linux 2 with yum available for instance initialization. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-init.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-init.html) --- ##### `cacheBucket`Required ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ##### `network`Required ```typescript public readonly network: Network; ``` - *Type:* Network --- ##### `runners`Required ```typescript public readonly runners: GitlabRunnerAutoscalingJobRunner[]; ``` - *Type:* GitlabRunnerAutoscalingJobRunner[] --- ##### `runnersSecurityGroup`Required ```typescript public readonly runnersSecurityGroup: SecurityGroup; ``` - *Type:* @pepperize/cdk-security-group.SecurityGroup --- ##### `globalConfiguration`Optional ```typescript public readonly globalConfiguration: GlobalConfiguration; ``` - *Type:* GlobalConfiguration --- ##### `role`Optional ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole --- ### GitlabRunnerAutoscalingProps Properties of the Gitlab Runner. You have to provide at least the GitLab's Runner's authentication token. #### Initializer ```typescript import { GitlabRunnerAutoscalingProps } from '@pepperize/cdk-autoscaling-gitlab-runner' const gitlabRunnerAutoscalingProps: GitlabRunnerAutoscalingProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | checkInterval | number | The check_interval option defines how often the runner should check GitLab for new jobs\| in seconds. | | concurrent | number | The limit of the jobs that can be run concurrently across all runners (concurrent). | | logFormat | string | The log format. | | logLevel | string | The log_level. | | runners | GitlabRunnerAutoscalingJobRunnerProps[] | The runner EC2 instances settings. | | cache | GitlabRunnerAutoscalingCacheProps | *No description.* | | manager | GitlabRunnerAutoscalingManagerBaseProps | The manager EC2 instance configuration. | | network | NetworkProps | The network configuration for the Runner. | --- ##### `checkInterval`Optional ```typescript public readonly checkInterval: number; ``` - *Type:* number - *Default:* 0 The check_interval option defines how often the runner should check GitLab for new jobs| in seconds. --- ##### `concurrent`Optional ```typescript public readonly concurrent: number; ``` - *Type:* number - *Default:* 10 The limit of the jobs that can be run concurrently across all runners (concurrent). --- ##### `logFormat`Optional ```typescript public readonly logFormat: string; ``` - *Type:* string - *Default:* "runner" The log format. --- ##### `logLevel`Optional ```typescript public readonly logLevel: string; ``` - *Type:* string - *Default:* "info" The log_level. --- ##### `runners`Required ```typescript public readonly runners: GitlabRunnerAutoscalingJobRunnerProps[]; ``` - *Type:* GitlabRunnerAutoscalingJobRunnerProps[] The runner EC2 instances settings. At least one runner should be set up. > [GitlabRunnerAutoscalingJobRunnerProps](GitlabRunnerAutoscalingJobRunnerProps) --- ##### `cache`Optional ```typescript public readonly cache: GitlabRunnerAutoscalingCacheProps; ``` - *Type:* GitlabRunnerAutoscalingCacheProps --- ##### `manager`Optional ```typescript public readonly manager: GitlabRunnerAutoscalingManagerBaseProps; ``` - *Type:* GitlabRunnerAutoscalingManagerBaseProps The manager EC2 instance configuration. If not set, the defaults will be used. > [GitlabRunnerAutoscalingManagerBaseProps](GitlabRunnerAutoscalingManagerBaseProps) --- ##### `network`Optional ```typescript public readonly network: NetworkProps; ``` - *Type:* NetworkProps The network configuration for the Runner. If not set, the defaults will be used. > [NetworkProps](NetworkProps) --- ### GlobalConfiguration You can change the behavior of GitLab Runner and of individual registered runners. This imitates the structure of Gitlab Runner advanced configuration that originally is set with config.toml file. > [https://docs.gitlab.com/runner/configuration/advanced-configuration.html](https://docs.gitlab.com/runner/configuration/advanced-configuration.html) #### Initializer ```typescript import { GlobalConfiguration } from '@pepperize/cdk-autoscaling-gitlab-runner' const globalConfiguration: GlobalConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | checkInterval | number | The check_interval option defines how often the runner should check GitLab for new jobs\| in seconds. | | concurrent | number | The limit of the jobs that can be run concurrently across all runners (concurrent). | | logFormat | string | The log format. | | logLevel | string | The log_level. | --- ##### `checkInterval`Optional ```typescript public readonly checkInterval: number; ``` - *Type:* number - *Default:* 0 The check_interval option defines how often the runner should check GitLab for new jobs| in seconds. --- ##### `concurrent`Optional ```typescript public readonly concurrent: number; ``` - *Type:* number - *Default:* 10 The limit of the jobs that can be run concurrently across all runners (concurrent). --- ##### `logFormat`Optional ```typescript public readonly logFormat: string; ``` - *Type:* string - *Default:* "runner" The log format. --- ##### `logLevel`Optional ```typescript public readonly logLevel: string; ``` - *Type:* string - *Default:* "info" The log_level. --- ### MachineConfiguration #### Initializer ```typescript import { MachineConfiguration } from '@pepperize/cdk-autoscaling-gitlab-runner' const machineConfiguration: MachineConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | autoscaling | AutoscalingConfiguration[] | *No description.* | | idleCount | number | Number of machines that need to be created and waiting in Idle state. | | idleTime | number | Time (in seconds) for machine to be in Idle state before it is removed. | | machineDriver | string | Docker Machine driver. | | machineName | string | *No description.* | | machineOptions | MachineOptions | Docker Machine options passed to the Docker Machine driver. | | maxBuilds | number | Maximum job (build) count before machine is removed. | --- ##### `autoscaling`Optional ```typescript public readonly autoscaling: AutoscalingConfiguration[]; ``` - *Type:* AutoscalingConfiguration[] --- ##### `idleCount`Optional ```typescript public readonly idleCount: number; ``` - *Type:* number - *Default:* 0 Number of machines that need to be created and waiting in Idle state. --- ##### `idleTime`Optional ```typescript public readonly idleTime: number; ``` - *Type:* number - *Default:* 300 Time (in seconds) for machine to be in Idle state before it is removed. --- ##### `machineDriver`Optional ```typescript public readonly machineDriver: string; ``` - *Type:* string - *Default:* "amazonec2" Docker Machine driver. --- ##### `machineName`Optional ```typescript public readonly machineName: string; ``` - *Type:* string - *Default:* "gitlab-runner" --- ##### `machineOptions`Optional ```typescript public readonly machineOptions: MachineOptions; ``` - *Type:* MachineOptions Docker Machine options passed to the Docker Machine driver. --- ##### `maxBuilds`Optional ```typescript public readonly maxBuilds: number; ``` - *Type:* number - *Default:* 20 Maximum job (build) count before machine is removed. --- ### MachineOptions > [https://gitlab.com/gitlab-org/ci-cd/docker-machine/-/blob/main/drivers/amazonec2/amazonec2.go](https://gitlab.com/gitlab-org/ci-cd/docker-machine/-/blob/main/drivers/amazonec2/amazonec2.go) #### Initializer ```typescript import { MachineOptions } from '@pepperize/cdk-autoscaling-gitlab-runner' const machineOptions: MachineOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | engineInstallUrl | string | Custom URL to use for engine installation. | | ami | string | *No description.* | | blockDurationMinutes | number | The amazonec2-block-duration-minutes parameter. | | iamInstanceProfile | string | *No description.* | | instanceType | string | *No description.* | | keypairName | string | The amazonec2-keypair-name parameter. | | metadataToken | string | Whether the metadata token is required or optional. | | metadataTokenResponseHopLimit | number | The number of network hops that the metadata token can travel. | | privateAddressOnly | boolean | The amazonec2-private-address-only parameter. | | region | string | *No description.* | | requestSpotInstance | boolean | The amazonec2-request-spot-instance parameter. | | rootSize | number | The root disk size of the instance (in GB). | | securityGroup | string | The SecurityGroup's GroupName, not the GroupId. | | spotPrice | number | The amazonec2-spot-price parameter. | | sshKeypath | string | The amazonec2-ssh-keypath parameter. | | subnetId | string | *No description.* | | useEbsOptimizedInstance | boolean | Create an EBS Optimized Instance, instance type must support it. | | usePrivateAddress | boolean | Use the private IP address of Docker Machines, but still create a public IP address. | | userdata | string | The path of the runner machine's userdata file on the manager instance used by the amazonec2 driver to create a new instance. | | volumeType | string | The Amazon EBS volume type to be attached to the instance. | | vpcId | string | *No description.* | | zone | string | Extract the availabilityZone last character for the needs of gitlab configuration. | --- ##### `engineInstallUrl`Optional ```typescript public readonly engineInstallUrl: string; ``` - *Type:* string - *Default:* https://releases.rancher.com/install-docker/20.10.21.sh Custom URL to use for engine installation. --- ##### `ami`Optional ```typescript public readonly ami: string; ``` - *Type:* string --- ##### `blockDurationMinutes`Optional ```typescript public readonly blockDurationMinutes: number; ``` - *Type:* number The amazonec2-block-duration-minutes parameter. AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360). > [https://docs.gitlab.com/runner/configuration/runner_autoscale_aws/#cutting-down-costs-with-amazon-ec2-spot-instances](https://docs.gitlab.com/runner/configuration/runner_autoscale_aws/#cutting-down-costs-with-amazon-ec2-spot-instances) --- ##### `iamInstanceProfile`Optional ```typescript public readonly iamInstanceProfile: string; ``` - *Type:* string --- ##### `instanceType`Optional ```typescript public readonly instanceType: string; ``` - *Type:* string --- ##### `keypairName`Optional ```typescript public readonly keypairName: string; ``` - *Type:* string The amazonec2-keypair-name parameter. A set of security credentials that you use to prove your identity when connecting to an Amazon EC2 instance. using --amazonec2-keypair-name also requires --amazonec2-ssh-keypath > [https://gitlab.com/gitlab-org/ci-cd/docker-machine/-/blob/main/drivers/amazonec2/amazonec2.go#L398](https://gitlab.com/gitlab-org/ci-cd/docker-machine/-/blob/main/drivers/amazonec2/amazonec2.go#L398) --- ##### `metadataToken`Optional ```typescript public readonly metadataToken: string; ``` - *Type:* string - *Default:* required Whether the metadata token is required or optional. > [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html) --- ##### `metadataTokenResponseHopLimit`Optional ```typescript public readonly metadataTokenResponseHopLimit: number; ``` - *Type:* number - *Default:* 2 The number of network hops that the metadata token can travel. --- ##### `privateAddressOnly`Optional ```typescript public readonly privateAddressOnly: boolean; ``` - *Type:* boolean The amazonec2-private-address-only parameter. If true, your EC2 instance won’t get assigned a public IP. This is ok if your VPC is configured correctly with an Internet Gateway (IGW), NatGateway (NGW) and routing is fine, but it’s something to consider if you’ve got a more complex configuration. > [https://docs.gitlab.com/runner/configuration/runner_autoscale_aws/#the-runnersmachine-section](https://docs.gitlab.com/runner/configuration/runner_autoscale_aws/#the-runnersmachine-section) --- ##### `region`Optional ```typescript public readonly region: string; ``` - *Type:* string --- ##### `requestSpotInstance`Optional ```typescript public readonly requestSpotInstance: boolean; ``` - *Type:* boolean - *Default:* true The amazonec2-request-spot-instance parameter. Whether or not to request spot instances. > [https://aws.amazon.com/ec2/spot/](https://aws.amazon.com/ec2/spot/) --- ##### `rootSize`Optional ```typescript public readonly rootSize: number; ``` - *Type:* number - *Default:* 16 The root disk size of the instance (in GB). > [https://gitlab.com/gitlab-org/ci-cd/docker-machine/-/blob/main/docs/drivers/aws.md#options](https://gitlab.com/gitlab-org/ci-cd/docker-machine/-/blob/main/docs/drivers/aws.md#options) --- ##### `securityGroup`Optional ```typescript public readonly securityGroup: string; ``` - *Type:* string The SecurityGroup's GroupName, not the GroupId. --- ##### `spotPrice`Optional ```typescript public readonly spotPrice: number; ``` - *Type:* number - *Default:* 0.03 The amazonec2-spot-price parameter. The bidding price for spot instances. > [https://aws.amazon.com/ec2/spot/pricing/](https://aws.amazon.com/ec2/spot/pricing/) --- ##### `sshKeypath`Optional ```typescript public readonly sshKeypath: string; ``` - *Type:* string - *Default:* /etc/gitlab-runner/ssh The amazonec2-ssh-keypath parameter. --- ##### `subnetId`Optional ```typescript public readonly subnetId: string; ``` - *Type:* string --- ##### `useEbsOptimizedInstance`Optional ```typescript public readonly useEbsOptimizedInstance: boolean; ``` - *Type:* boolean Create an EBS Optimized Instance, instance type must support it. --- ##### `usePrivateAddress`Optional ```typescript public readonly usePrivateAddress: boolean; ``` - *Type:* boolean Use the private IP address of Docker Machines, but still create a public IP address. Useful to keep the traffic internal and avoid extra costs. > [https://docs.gitlab.com/runner/configuration/runner_autoscale_aws/#the-runnersmachine-section](https://docs.gitlab.com/runner/configuration/runner_autoscale_aws/#the-runnersmachine-section) --- ##### `userdata`Optional ```typescript public readonly userdata: string; ``` - *Type:* string - *Default:* /etc/gitlab-runner/user_data_runners The path of the runner machine's userdata file on the manager instance used by the amazonec2 driver to create a new instance. > [https://gitlab.com/gitlab-org/ci-cd/docker-machine/-/blob/main/drivers/amazonec2/amazonec2.go](https://gitlab.com/gitlab-org/ci-cd/docker-machine/-/blob/main/drivers/amazonec2/amazonec2.go) --- ##### `volumeType`Optional ```typescript public readonly volumeType: string; ``` - *Type:* string - *Default:* gp2 The Amazon EBS volume type to be attached to the instance. --- ##### `vpcId`Optional ```typescript public readonly vpcId: string; ``` - *Type:* string --- ##### `zone`Optional ```typescript public readonly zone: string; ``` - *Type:* string Extract the availabilityZone last character for the needs of gitlab configuration. > [https://docs.gitlab.com/runners/configuration/runners_autoscale_aws/#the-runnerssmachine-section](https://docs.gitlab.com/runners/configuration/runners_autoscale_aws/#the-runnerssmachine-section) --- ### NetworkProps #### Initializer ```typescript import { NetworkProps } from '@pepperize/cdk-autoscaling-gitlab-runner' const networkProps: NetworkProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | subnetSelection | aws-cdk-lib.aws_ec2.SubnetSelection | The GitLab Runner's subnets. | | vpc | aws-cdk-lib.aws_ec2.IVpc | If no existing VPC is provided, a default Vpc will be created. | --- ##### `subnetSelection`Optional ```typescript public readonly subnetSelection: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection The GitLab Runner's subnets. It should be either public or private. If more then subnet is selected, then the first found (private) subnet will be used. > [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.SubnetSelection.html A network is considered private, if - tagged by 'aws-cdk:subnet-type' - doesn't route to an Internet Gateway (not public) - has an Nat Gateway](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.SubnetSelection.html A network is considered private, if - tagged by 'aws-cdk:subnet-type' - doesn't route to an Internet Gateway (not public) - has an Nat Gateway) --- ##### `vpc`Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc If no existing VPC is provided, a default Vpc will be created. --- ### RunnerConfiguration #### Initializer ```typescript import { RunnerConfiguration } from '@pepperize/cdk-autoscaling-gitlab-runner' const runnerConfiguration: RunnerConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildsDir | string | Absolute path to a directory where builds are stored in the context of the selected executor. | | cache | CacheConfiguration | The runner's AWS S3 cache configuration. | | cacheDir | string | Absolute path to a directory where build caches are stored in context of selected executor. | | cloneUrl | string | Overwrite the URL for the GitLab instance. | | debugTraceDisabled | boolean | Disables the CI_DEBUG_TRACE feature. | | docker | DockerConfiguration | The runner's docker configuration. | | environment | string[] | Append or overwrite environment variables. | | executor | string | Select how a project should be built. | | limit | number | Limit how many jobs can be handled concurrently by this registered runner. | | machine | MachineConfiguration | The runner's Docker Machine configuration. | | name | string | The runner’s description. | | outputLimit | number | Maximum build log size in kilobytes. | | postBuildScript | string | Commands to be executed on the runner just after executing the build, but before executing after_script. | | preBuildScript | string | Commands to be executed on the runner after cloning the Git repository, but before executing the build. | | preCloneScript | string | Commands to be executed on the runner before cloning the Git repository. | | referees | string | Extra job monitoring workers that pass their results as job artifacts to GitLab. | | requestConcurrency | number | Limit number of concurrent requests for new jobs from GitLab. | | shell | string | Name of shell to generate the script. | | tlsCaFile | string | When using HTTPS, file that contains the certificates to verify the peer. | | tlsCertFile | string | When using HTTPS, file that contains the certificate to authenticate with the peer. | | tlsKeyFile | string | When using HTTPS, file that contains the private key to authenticate with the peer. | | token | string | The runner’s authentication token, which is obtained during runner registration. Not the same as the registration token. | | url | string | GitLab instance URL. | --- ##### `buildsDir`Optional ```typescript public readonly buildsDir: string; ``` - *Type:* string Absolute path to a directory where builds are stored in the context of the selected executor. For example, locally, Docker, or SSH. --- ##### `cache`Optional ```typescript public readonly cache: CacheConfiguration; ``` - *Type:* CacheConfiguration The runner's AWS S3 cache configuration. > [https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnerscaches3-section](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnerscaches3-section) --- ##### `cacheDir`Optional ```typescript public readonly cacheDir: string; ``` - *Type:* string Absolute path to a directory where build caches are stored in context of selected executor. For example, locally, Docker, or SSH. If the docker executor is used, this directory needs to be included in its volumes parameter. --- ##### `cloneUrl`Optional ```typescript public readonly cloneUrl: string; ``` - *Type:* string Overwrite the URL for the GitLab instance. Used only if the runner can’t connect to the GitLab URL. --- ##### `debugTraceDisabled`Optional ```typescript public readonly debugTraceDisabled: boolean; ``` - *Type:* boolean Disables the CI_DEBUG_TRACE feature. When set to true, then debug log (trace) remains disabled, even if CI_DEBUG_TRACE is set to true by the user. --- ##### `docker`Optional ```typescript public readonly docker: DockerConfiguration; ``` - *Type:* DockerConfiguration The runner's docker configuration. > [https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersdocker-section](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersdocker-section) --- ##### `environment`Optional ```typescript public readonly environment: string[]; ``` - *Type:* string[] - *Default:* ["DOCKER_DRIVER=overlay2", "DOCKER_TLS_CERTDIR=/certs"] Append or overwrite environment variables. --- ##### `executor`Optional ```typescript public readonly executor: string; ``` - *Type:* string - *Default:* "docker+machine" Select how a project should be built. --- ##### `limit`Optional ```typescript public readonly limit: number; ``` - *Type:* number - *Default:* 10 Limit how many jobs can be handled concurrently by this registered runner. 0 (default) means do not limit. --- ##### `machine`Optional ```typescript public readonly machine: MachineConfiguration; ``` - *Type:* MachineConfiguration The runner's Docker Machine configuration. > [https://docs.gitlab.com/runner/configuration/runner_autoscale_aws/#the-runnersmachine-section](https://docs.gitlab.com/runner/configuration/runner_autoscale_aws/#the-runnersmachine-section) --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* "gitlab-runner" The runner’s description. Informational only. --- ##### `outputLimit`Optional ```typescript public readonly outputLimit: number; ``` - *Type:* number - *Default:* 52428800 (50GB) Maximum build log size in kilobytes. Default is 4096 (4MB). --- ##### `postBuildScript`Optional ```typescript public readonly postBuildScript: string; ``` - *Type:* string Commands to be executed on the runner just after executing the build, but before executing after_script. To insert multiple commands, use a (triple-quoted) multi-line string or \n character. --- ##### `preBuildScript`Optional ```typescript public readonly preBuildScript: string; ``` - *Type:* string Commands to be executed on the runner after cloning the Git repository, but before executing the build. To insert multiple commands, use a (triple-quoted) multi-line string or \n character. --- ##### `preCloneScript`Optional ```typescript public readonly preCloneScript: string; ``` - *Type:* string Commands to be executed on the runner before cloning the Git repository. Use it to adjust the Git client configuration first, for example. To insert multiple commands, use a (triple-quoted) multi-line string or \n character. --- ##### `referees`Optional ```typescript public readonly referees: string; ``` - *Type:* string Extra job monitoring workers that pass their results as job artifacts to GitLab. --- ##### `requestConcurrency`Optional ```typescript public readonly requestConcurrency: number; ``` - *Type:* number Limit number of concurrent requests for new jobs from GitLab. Default is 1. --- ##### `shell`Optional ```typescript public readonly shell: string; ``` - *Type:* string Name of shell to generate the script. Default value is platform dependent. --- ##### `tlsCaFile`Optional ```typescript public readonly tlsCaFile: string; ``` - *Type:* string When using HTTPS, file that contains the certificates to verify the peer. See Self-signed certificates or custom Certification Authorities documentation. --- ##### `tlsCertFile`Optional ```typescript public readonly tlsCertFile: string; ``` - *Type:* string When using HTTPS, file that contains the certificate to authenticate with the peer. --- ##### `tlsKeyFile`Optional ```typescript public readonly tlsKeyFile: string; ``` - *Type:* string When using HTTPS, file that contains the private key to authenticate with the peer. --- ##### `token`Optional ```typescript public readonly token: string; ``` - *Type:* string The runner’s authentication token, which is obtained during runner registration. Not the same as the registration token. Will be replaced by the runner's props token SSM Parameter > [https://docs.gitlab.com/ee/api/runners.html#register-a-new-runner](https://docs.gitlab.com/ee/api/runners.html#register-a-new-runner) --- ##### `url`Optional ```typescript public readonly url: string; ``` - *Type:* string - *Default:* "https://gitlab.com" GitLab instance URL. --- ### SharedCreateOptions > [https://gitlab.com/gitlab-org/ci-cd/docker-machine/-/blob/main/commands/create.go](https://gitlab.com/gitlab-org/ci-cd/docker-machine/-/blob/main/commands/create.go) #### Initializer ```typescript import { SharedCreateOptions } from '@pepperize/cdk-autoscaling-gitlab-runner' const sharedCreateOptions: SharedCreateOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | engineInstallUrl | string | Custom URL to use for engine installation. | --- ##### `engineInstallUrl`Optional ```typescript public readonly engineInstallUrl: string; ``` - *Type:* string - *Default:* https://releases.rancher.com/install-docker/20.10.21.sh Custom URL to use for engine installation. --- ## Classes ### ConfigurationMapper #### Methods | **Name** | **Description** | | --- | --- | | toToml | *No description.* | --- ##### `toToml` ```typescript public toToml(): string ``` #### Static Functions | **Name** | **Description** | | --- | --- | | fromProps | *No description.* | | withDefaults | *No description.* | --- ##### `fromProps` ```typescript import { ConfigurationMapper } from '@pepperize/cdk-autoscaling-gitlab-runner' ConfigurationMapper.fromProps(props: ConfigurationMapperProps) ``` ###### `props`Required - *Type:* ConfigurationMapperProps --- ##### `withDefaults` ```typescript import { ConfigurationMapper } from '@pepperize/cdk-autoscaling-gitlab-runner' ConfigurationMapper.withDefaults(props: ConfigurationMapperProps) ``` ###### `props`Required - *Type:* ConfigurationMapperProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ConfigurationMapperProps | *No description.* | --- ##### `props`Required ```typescript public readonly props: ConfigurationMapperProps; ``` - *Type:* ConfigurationMapperProps --- ### DockerMachineVersion Docker+machine version. > [https://gitlab.com/gitlab-org/ci-cd/docker-machine](https://gitlab.com/gitlab-org/ci-cd/docker-machine) #### Static Functions | **Name** | **Description** | | --- | --- | | of | Custom docker+machine version. | --- ##### `of` ```typescript import { DockerMachineVersion } from '@pepperize/cdk-autoscaling-gitlab-runner' DockerMachineVersion.of(version: string) ``` Custom docker+machine version. ###### `version`Required - *Type:* string docker+machine version number. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | version | string | *No description.* | --- ##### `version`Required ```typescript public readonly version: string; ``` - *Type:* string --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | V0_16_2_GITLAB_15 | DockerMachineVersion | Docker+machine version 0.16.2-gitlab.15. | --- ##### `V0_16_2_GITLAB_15`Required ```typescript public readonly V0_16_2_GITLAB_15: DockerMachineVersion; ``` - *Type:* DockerMachineVersion Docker+machine version 0.16.2-gitlab.15. ---