Skip to content

Latest commit

 

History

History
3422 lines (2092 loc) · 132 KB

API.md

File metadata and controls

3422 lines (2092 loc) · 132 KB
Raw

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 

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.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsOptional

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { Cache } from '@pepperize/cdk-autoscaling-gitlab-runner'

Cache.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
bucket aws-cdk-lib.aws_s3.IBucket No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

bucketRequired 
public readonly bucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket

GitlabRunnerAutoscaling

The Gitlab Runner autoscaling on EC2 by Docker Machine.

Example

<caption>Provisioning a basic Runner</caption>
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 

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.
scopeRequired
  • Type: aws-cdk-lib.Stack
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { GitlabRunnerAutoscaling } from '@pepperize/cdk-autoscaling-gitlab-runner'

GitlabRunnerAutoscaling.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • 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.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cacheBucketRequired 
public readonly cacheBucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket
managerRequired 
public readonly manager: GitlabRunnerAutoscalingManager;
networkRequired 
public readonly network: Network;
runnersRequired 
public readonly runners: GitlabRunnerAutoscalingJobRunner[];
checkIntervalOptional 
public readonly checkInterval: number;
  • Type: number
concurrentOptional 
public readonly concurrent: number;
  • Type: number
logFormatOptional 
public readonly logFormat: string;
  • Type: string
logLevelOptional 
public readonly logLevel: string;
  • Type: string

GitlabRunnerAutoscalingJobRunner

Initializers 

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.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { GitlabRunnerAutoscalingJobRunner } from '@pepperize/cdk-autoscaling-gitlab-runner'

GitlabRunnerAutoscalingJobRunner.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • 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.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

configurationRequired 
public readonly configuration: RunnerConfiguration;
instanceProfileRequired 
public readonly instanceProfile: CfnInstanceProfile;
  • Type: aws-cdk-lib.aws_iam.CfnInstanceProfile
instanceTypeRequired 
public readonly instanceType: InstanceType;
  • Type: aws-cdk-lib.aws_ec2.InstanceType
machineImageRequired 
public readonly machineImage: IMachineImage;
  • Type: aws-cdk-lib.aws_ec2.IMachineImage
roleRequired 
public readonly role: IRole;
  • Type: aws-cdk-lib.aws_iam.IRole
keyPairOptional 
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 

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.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { GitlabRunnerAutoscalingManager } from '@pepperize/cdk-autoscaling-gitlab-runner'

GitlabRunnerAutoscalingManager.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • 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.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cacheBucketRequired 
public readonly cacheBucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket
globalConfigurationRequired 
public readonly globalConfiguration: GlobalConfiguration;
initConfigRequired 
public readonly initConfig: CloudFormationInit;
  • Type: aws-cdk-lib.aws_ec2.CloudFormationInit
instanceTypeRequired 
public readonly instanceType: InstanceType;
  • Type: aws-cdk-lib.aws_ec2.InstanceType
machineImageRequired 
public readonly machineImage: IMachineImage;
  • Type: aws-cdk-lib.aws_ec2.IMachineImage
networkRequired 
public readonly network: Network;
roleRequired 
public readonly role: IRole;
  • Type: aws-cdk-lib.aws_iam.IRole
runnersRequired 
public readonly runners: GitlabRunnerAutoscalingJobRunner[];
runnersSecurityGroupNameRequired 
public readonly runnersSecurityGroupName: string;
  • Type: string
userDataRequired 
public readonly userData: UserData;
  • Type: aws-cdk-lib.aws_ec2.UserData
keyPairNameOptional 
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 

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.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsOptional

Methods

Name Description
toString Returns a string representation of this construct.
hasPrivateSubnets No description.
toString 
public toString(): string

Returns a string representation of this construct.

hasPrivateSubnets 
public hasPrivateSubnets(): boolean

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { Network } from '@pepperize/cdk-autoscaling-gitlab-runner'

Network.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • 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.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

availabilityZoneRequired 
public readonly availabilityZone: string;
  • Type: string
subnetRequired 
public readonly subnet: ISubnet;
  • Type: aws-cdk-lib.aws_ec2.ISubnet
vpcRequired 
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

Initializer 

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.
idleCountOptional 
public readonly idleCount: number;
  • Type: number
idleTimeOptional 
public readonly idleTime: number;
  • Type: number
periodsOptional 
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

// "* * 7-22 * * mon-fri *"
timezoneOptional 
public readonly timezone: string;
  • Type: string

CacheConfiguration

Initializer 

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.
s3Optional 
public readonly s3: CacheS3Configuration;
sharedOptional 
public readonly shared: boolean;
  • Type: boolean
typeOptional 
public readonly type: string;
  • Type: string

CacheProps

Initializer 

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.
bucketNameOptional 
public readonly bucketName: string;
  • Type: string
  • Default: "runner-cache"

The infix of the physical cache bucket name.

expirationOptional 
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

Initializer 

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.
accessKeyOptional 
public readonly accessKey: string;
  • Type: string
authenticationTypeOptional 
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

bucketLocationOptional 
public readonly bucketLocation: string;
  • Type: string

The name of the S3 region.

bucketNameOptional 
public readonly bucketName: string;
  • Type: string
  • Default: "runners-cache"

The name of the storage bucket where cache is stored.

insecureOptional 
public readonly insecure: boolean;
  • Type: boolean
  • Default: false

Set to true if the S3 service is available by HTTP.

secretKeyOptional 
public readonly secretKey: string;
  • Type: string
serverAddressOptional 
public readonly serverAddress: string;
  • Type: string
  • Default: "s3.amazonaws.com"

The AWS S3 host.

ConfigurationMapperProps

Initializer 

import { ConfigurationMapperProps } from '@pepperize/cdk-autoscaling-gitlab-runner'

const configurationMapperProps: ConfigurationMapperProps = { ... }

Properties

Name Type Description
globalConfiguration GlobalConfiguration No description.
runnersConfiguration RunnerConfiguration[] No description.
globalConfigurationRequired 
public readonly globalConfiguration: GlobalConfiguration;
runnersConfigurationRequired 
public readonly runnersConfiguration: RunnerConfiguration[];

DockerConfiguration

Configure docker on the runners.

https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersdocker-section

Initializer 

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 [:<ro|rw>].
waitForServicesTimeout number How long to wait for Docker services.
allowedImagesOptional 
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.

allowedServicesOptional 
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.

cacheDirOptional 
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.

capAddOptional 
public readonly capAdd: string[];
  • Type: string[]
  • Default: ["CAP_SYS_ADMIN"]

Add additional Linux capabilities to the container.

capDropOptional 
public readonly capDrop: string[];
  • Type: string[]

Drop additional Linux capabilities from the container.

cpusOptional 
public readonly cpus: string;
  • Type: string

Number of CPUs (available in Docker 1.13 or later. A string.

cpusetCpusOptional 
public readonly cpusetCpus: string;
  • Type: string

The control group’s CpusetCpus.

A string.

cpuSharesOptional 
public readonly cpuShares: number;
  • Type: number

Number of CPU shares used to set relative CPU usage.

Default is 1024.

devicesOptional 
public readonly devices: string[];
  • Type: string[]

Share additional host devices with the container.

disableCacheOptional 
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.

disableEntrypointOverwriteOptional 
public readonly disableEntrypointOverwrite: boolean;
  • Type: boolean

Disable the image entrypoint overwriting.

dnsOptional 
public readonly dns: string[];
  • Type: string[]

A list of DNS servers for the container to use.

dnsSearchOptional 
public readonly dnsSearch: string[];
  • Type: string[]

A list of DNS search domains.

extraHostsOptional 
public readonly extraHosts: string[];
  • Type: string[]

Hosts that should be defined in container environment.

gpusOptional 
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.

helperImageOptional 
public readonly helperImage: string;
  • Type: string

(Advanced) The default helper image used to clone repositories and upload artifacts.

helperImageFlavorOptional 
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.

hostOptional 
public readonly host: string;
  • Type: string

Custom Docker endpoint.

Default is DOCKER_HOST environment or unix:///var/run/docker.sock.

hostnameOptional 
public readonly hostname: string;
  • Type: string

Custom hostname for the Docker container.

imageOptional 
public readonly image: string;
  • Type: string

The image to run jobs with.

linksOptional 
public readonly links: string[];
  • Type: string[]

Containers that should be linked with container that runs the job.

memoryOptional 
public readonly memory: string;
  • Type: string

The memory limit.

A string.

memoryReservationOptional 
public readonly memoryReservation: string;
  • Type: string

The memory soft limit.

A string.

memorySwapOptional 
public readonly memorySwap: string;
  • Type: string

The total memory limit.

A string.

networkModeOptional 
public readonly networkMode: string;
  • Type: string

Add container to a custom network.

oomKillDisableOptional 
public readonly oomKillDisable: boolean;
  • Type: boolean

If an out-of-memory (OOM) error occurs, do not kill processes in a container.

oomScoreAdjustOptional 
public readonly oomScoreAdjust: string;
  • Type: string

OOM score adjustment.

Positive means kill earlier.

privilegedOptional 
public readonly privileged: boolean;
  • Type: boolean
  • Default: true

Make the container run in privileged mode.

Insecure.

pullPolicyOptional 
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.

runtimeOptional 
public readonly runtime: string;
  • Type: string

The runtime for the Docker container.

securityOptOptional 
public readonly securityOpt: string;
  • Type: string

Security options (–security-opt in docker run).

Takes a list of : separated key/values.

shmSizeOptional 
public readonly shmSize: number;
  • Type: number
  • Default: 0

Shared memory size for images (in bytes).

sysctlsOptional 
public readonly sysctls: string;
  • Type: string

The sysctl options.

tlsCertPathOptional 
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.

tlsVerifyOptional 
public readonly tlsVerify: boolean;
  • Type: boolean
  • Default: false

Enable or disable TLS verification of connections to Docker daemon.

Disabled by default.

usernsModeOptional 
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.

volumeDriverOptional 
public readonly volumeDriver: string;
  • Type: string

The volume driver to use for the container.

volumesOptional 
public readonly volumes: string[];
  • Type: string[]

Additional volumes that should be mounted.

Same syntax as the Docker -v flag.

volumesFromOptional 
public readonly volumesFrom: string[];
  • Type: string[]

A list of volumes to inherit from another container in the form [:<ro|rw>].

Access level defaults to read-write, but can be manually set to ro (read-only) or rw (read-write).

waitForServicesTimeoutOptional 
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

Initializer 

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.
bucketOptional 
public readonly bucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket

An existing S3 bucket used as runner's cache.

optionsOptional 
public readonly options: 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 

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.
configurationRequired 
public readonly configuration: RunnerConfiguration;

The runner EC2 instances configuration.

If not set, the defaults will be used.

RunnerConfiguration

tokenRequired 
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

instanceTypeOptional 
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.

keyPairOptional 
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
machineImageOptional 
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

roleOptional 
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 

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.
dockerMachineVersionOptional 
public readonly dockerMachineVersion: DockerMachineVersion;
instanceTypeOptional 
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.

keyPairNameOptional 
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.

machineImageOptional 
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

GitlabRunnerAutoscalingManagerProps

Initializer 

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.
dockerMachineVersionOptional 
public readonly dockerMachineVersion: DockerMachineVersion;
instanceTypeOptional 
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.

keyPairNameOptional 
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.

machineImageOptional 
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

cacheBucketRequired 
public readonly cacheBucket: IBucket;
  • Type: aws-cdk-lib.aws_s3.IBucket
networkRequired 
public readonly network: Network;
runnersRequired 
public readonly runners: GitlabRunnerAutoscalingJobRunner[];
runnersSecurityGroupRequired 
public readonly runnersSecurityGroup: SecurityGroup;
  • Type: @pepperize/cdk-security-group.SecurityGroup
globalConfigurationOptional 
public readonly globalConfiguration: GlobalConfiguration;
roleOptional 
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 

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.
checkIntervalOptional 
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.

concurrentOptional 
public readonly concurrent: number;
  • Type: number
  • Default: 10

The limit of the jobs that can be run concurrently across all runners (concurrent).

logFormatOptional 
public readonly logFormat: string;
  • Type: string
  • Default: "runner"

The log format.

logLevelOptional 
public readonly logLevel: string;
  • Type: string
  • Default: "info"

The log_level.

runnersRequired 
public readonly runners: GitlabRunnerAutoscalingJobRunnerProps[];

The runner EC2 instances settings.

At least one runner should be set up.

GitlabRunnerAutoscalingJobRunnerProps

cacheOptional 
public readonly cache: GitlabRunnerAutoscalingCacheProps;
managerOptional 
public readonly manager: GitlabRunnerAutoscalingManagerBaseProps;

The manager EC2 instance configuration.

If not set, the defaults will be used.

GitlabRunnerAutoscalingManagerBaseProps

networkOptional 
public readonly network: NetworkProps;

The network configuration for the Runner.

If not set, the defaults will be used.

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

Initializer 

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.
checkIntervalOptional 
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.

concurrentOptional 
public readonly concurrent: number;
  • Type: number
  • Default: 10

The limit of the jobs that can be run concurrently across all runners (concurrent).

logFormatOptional 
public readonly logFormat: string;
  • Type: string
  • Default: "runner"

The log format.

logLevelOptional 
public readonly logLevel: string;
  • Type: string
  • Default: "info"

The log_level.

MachineConfiguration

Initializer 

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.
autoscalingOptional 
public readonly autoscaling: AutoscalingConfiguration[];
idleCountOptional 
public readonly idleCount: number;
  • Type: number
  • Default: 0

Number of machines that need to be created and waiting in Idle state.

idleTimeOptional 
public readonly idleTime: number;
  • Type: number
  • Default: 300

Time (in seconds) for machine to be in Idle state before it is removed.

machineDriverOptional 
public readonly machineDriver: string;
  • Type: string
  • Default: "amazonec2"

Docker Machine driver.

machineNameOptional 
public readonly machineName: string;
  • Type: string
  • Default: "gitlab-runner"
machineOptionsOptional 
public readonly machineOptions: MachineOptions;

Docker Machine options passed to the Docker Machine driver.

maxBuildsOptional 
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

Initializer 

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.
engineInstallUrlOptional 
public readonly engineInstallUrl: string;

Custom URL to use for engine installation.

amiOptional 
public readonly ami: string;
  • Type: string
blockDurationMinutesOptional 
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

iamInstanceProfileOptional 
public readonly iamInstanceProfile: string;
  • Type: string
instanceTypeOptional 
public readonly instanceType: string;
  • Type: string
keypairNameOptional 
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

metadataTokenOptional 
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

metadataTokenResponseHopLimitOptional 
public readonly metadataTokenResponseHopLimit: number;
  • Type: number
  • Default: 2

The number of network hops that the metadata token can travel.

privateAddressOnlyOptional 
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

regionOptional 
public readonly region: string;
  • Type: string
requestSpotInstanceOptional 
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/

rootSizeOptional 
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

securityGroupOptional 
public readonly securityGroup: string;
  • Type: string

The SecurityGroup's GroupName, not the GroupId.

spotPriceOptional 
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/

sshKeypathOptional 
public readonly sshKeypath: string;
  • Type: string
  • Default: /etc/gitlab-runner/ssh

The amazonec2-ssh-keypath parameter.

subnetIdOptional 
public readonly subnetId: string;
  • Type: string
useEbsOptimizedInstanceOptional 
public readonly useEbsOptimizedInstance: boolean;
  • Type: boolean

Create an EBS Optimized Instance, instance type must support it.

usePrivateAddressOptional 
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

userdataOptional 
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

volumeTypeOptional 
public readonly volumeType: string;
  • Type: string
  • Default: gp2

The Amazon EBS volume type to be attached to the instance.

vpcIdOptional 
public readonly vpcId: string;
  • Type: string
zoneOptional 
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

NetworkProps

Initializer 

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.
subnetSelectionOptional 
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

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)
vpcOptional 
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 

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.
buildsDirOptional 
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.

cacheOptional 
public readonly cache: CacheConfiguration;

The runner's AWS S3 cache configuration.

https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnerscaches3-section

cacheDirOptional 
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.

cloneUrlOptional 
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.

debugTraceDisabledOptional 
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.

dockerOptional 
public readonly docker: DockerConfiguration;

The runner's docker configuration.

https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersdocker-section

environmentOptional 
public readonly environment: string[];
  • Type: string[]
  • Default: ["DOCKER_DRIVER=overlay2", "DOCKER_TLS_CERTDIR=/certs"]

Append or overwrite environment variables.

executorOptional 
public readonly executor: string;
  • Type: string
  • Default: "docker+machine"

Select how a project should be built.

limitOptional 
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.

machineOptional 
public readonly machine: MachineConfiguration;

The runner's Docker Machine configuration.

https://docs.gitlab.com/runner/configuration/runner_autoscale_aws/#the-runnersmachine-section

nameOptional 
public readonly name: string;
  • Type: string
  • Default: "gitlab-runner"

The runner’s description.

Informational only.

outputLimitOptional 
public readonly outputLimit: number;
  • Type: number
  • Default: 52428800 (50GB)

Maximum build log size in kilobytes.

Default is 4096 (4MB).

postBuildScriptOptional 
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.

preBuildScriptOptional 
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.

preCloneScriptOptional 
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.

refereesOptional 
public readonly referees: string;
  • Type: string

Extra job monitoring workers that pass their results as job artifacts to GitLab.

requestConcurrencyOptional 
public readonly requestConcurrency: number;
  • Type: number

Limit number of concurrent requests for new jobs from GitLab.

Default is 1.

shellOptional 
public readonly shell: string;
  • Type: string

Name of shell to generate the script.

Default value is platform dependent.

tlsCaFileOptional 
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.

tlsCertFileOptional 
public readonly tlsCertFile: string;
  • Type: string

When using HTTPS, file that contains the certificate to authenticate with the peer.

tlsKeyFileOptional 
public readonly tlsKeyFile: string;
  • Type: string

When using HTTPS, file that contains the private key to authenticate with the peer.

tokenOptional 
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

urlOptional 
public readonly url: string;

GitLab instance URL.

SharedCreateOptions

https://gitlab.com/gitlab-org/ci-cd/docker-machine/-/blob/main/commands/create.go

Initializer 

import { SharedCreateOptions } from '@pepperize/cdk-autoscaling-gitlab-runner'

const sharedCreateOptions: SharedCreateOptions = { ... }

Properties

Name Type Description
engineInstallUrl string Custom URL to use for engine installation.
engineInstallUrlOptional 
public readonly engineInstallUrl: string;

Custom URL to use for engine installation.

Classes

ConfigurationMapper

Methods

Name Description
toToml No description.
toToml 
public toToml(): string

Static Functions

Name Description
fromProps No description.
withDefaults No description.
fromProps 
import { ConfigurationMapper } from '@pepperize/cdk-autoscaling-gitlab-runner'

ConfigurationMapper.fromProps(props: ConfigurationMapperProps)
propsRequired
withDefaults 
import { ConfigurationMapper } from '@pepperize/cdk-autoscaling-gitlab-runner'

ConfigurationMapper.withDefaults(props: ConfigurationMapperProps)
propsRequired

Properties

Name Type Description
props ConfigurationMapperProps No description.
propsRequired 
public readonly props: ConfigurationMapperProps;

DockerMachineVersion

Docker+machine version.

https://gitlab.com/gitlab-org/ci-cd/docker-machine

Static Functions

Name Description
of Custom docker+machine version.
of 
import { DockerMachineVersion } from '@pepperize/cdk-autoscaling-gitlab-runner'

DockerMachineVersion.of(version: string)

Custom docker+machine version.

versionRequired
  • Type: string

docker+machine version number.

Properties

Name Type Description
version string No description.
versionRequired 
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_15Required 
public readonly V0_16_2_GITLAB_15: DockerMachineVersion;

Docker+machine version 0.16.2-gitlab.15.