Skip to content

API.md

Latest commit

 

History

History
177 lines (111 loc) · 8.57 KB

API.md

File metadata and controls

177 lines (111 loc) · 8.57 KB

API Reference

Classes

Name Description
GitlabContainerRunner No description

Structs

Name Description
DockerVolumes No description
GitlabContainerRunnerProps No description

Enums

Name Description
BlockDuration No description
InstanceInterruptionBehavior No description

class GitlabContainerRunner 🔹

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new GitlabContainerRunner(scope: Construct, id: string, props: GitlabContainerRunnerProps)
  • scope (Construct) No description
  • id (string) No description
  • props (GitlabContainerRunnerProps) No description
    • gitlabtoken (string) Gitlab token for the Register Runner .
    • blockDuration (BlockDuration) Reservce the Spot Runner instance as spot block with defined duration. Default: BlockDuration.ONE_HOUR , !!! only support spotfleet runner !!! .
    • dockerVolumes (Array<DockerVolumes>) add another Gitlab Container Runner Docker Volumes Path at job runner runtime. Default: already mount "/var/run/docker.sock:/var/run/docker.sock"
    • ebsSize (number) Gitlab Runner instance EBS size . Default: ebsSize=60
    • ec2iamrole (IRole) IAM role for the Gitlab Runner Instance . Default: new Role for Gitlab Runner Instance , attach AmazonSSMManagedInstanceCore Policy .
    • ec2type (string) Runner default EC2 instance type. Default: t3.micro
    • gitlaburl (string) Gitlab Runner register url . Default: gitlaburl='https://gitlab.com/' , please use https://yourgitlab.com/ do not use https://yourgitlab.com
    • instanceInterruptionBehavior (InstanceInterruptionBehavior) The behavior when a Spot Runner Instance is interrupted. Default: InstanceInterruptionBehavior.TERMINATE , !!! only support spotfleet runner !!! .
    • keyName (string) SSH key name. Default: no ssh key will be assigned , !!! only support spotfleet runner !!! .
    • selfvpc (IVpc) VPC for the Gitlab Runner . Default: new VPC will be created , 1 Vpc , 2 Public Subnet .
    • spotFleet (boolean) Gitlab Runner instance Use Spot Fleet or not ?!. Default: spotFleet=false
    • tag1 (string) Gitlab Runner register tag1 . Default: tag1: gitlab .
    • tag2 (string) Gitlab Runner register tag2 . Default: tag2: awscdk .
    • tag3 (string) Gitlab Runner register tag3 . Default: tag3: runner .
    • tags (Array) tags for the runner. Default: ['runner', 'gitlab', 'awscdk']
    • validUntil (string) the time when the spot fleet allocation expires. Default: no expiration , !!! only support spotfleet runner !!! .
    • vpcSubnet (SubnetSelection) VPC subnet for the spot fleet. Default: public subnet

Properties

Name Type Description
defaultRunnerSG🔹 ISecurityGroup The EC2 runner's default SecurityGroup.
runnerEc2🔹 IInstance This represents a Runner EC2 instance , !!! only support On-demand runner instance !!!
runnerRole🔹 IRole The IAM role assumed by the Runner instance .
spotFleetInstanceId🔹 string the first instance id in this fleet , !!! only support spotfleet runner !!!
spotFleetRequestId🔹 string SpotFleetRequestId for this spot fleet , !!! only support spotfleet runner !!!
vpc🔹 IVpc The EC2 runner's vpc.

Methods

expireAfter(duration)🔹 

expireAfter(duration: Duration): void

struct DockerVolumes 🔹

Name Type Description
containerPath🔹 string Job Runtime Container Path Host Path.
hostPath🔹 string EC2 Runner Host Path.

struct GitlabContainerRunnerProps 🔹

Name Type Description
gitlabtoken🔹 string Gitlab token for the Register Runner .
blockDuration?🔹 BlockDuration Reservce the Spot Runner instance as spot block with defined duration.
Default: BlockDuration.ONE_HOUR , !!! only support spotfleet runner !!! .
dockerVolumes?🔹 Array<DockerVolumes> add another Gitlab Container Runner Docker Volumes Path at job runner runtime.
Default: already mount "/var/run/docker.sock:/var/run/docker.sock"
ebsSize?🔹 number Gitlab Runner instance EBS size .
Default: ebsSize=60
ec2iamrole?🔹 IRole IAM role for the Gitlab Runner Instance .
Default: new Role for Gitlab Runner Instance , attach AmazonSSMManagedInstanceCore Policy .
ec2type?🔹 string Runner default EC2 instance type.
Default: t3.micro
gitlaburl?🔹 string Gitlab Runner register url .
Default: gitlaburl='https://gitlab.com/' , please use https://yourgitlab.com/ do not use https://yourgitlab.com
instanceInterruptionBehavior?🔹 InstanceInterruptionBehavior The behavior when a Spot Runner Instance is interrupted.
Default: InstanceInterruptionBehavior.TERMINATE , !!! only support spotfleet runner !!! .
keyName?🔹 string SSH key name.
Default: no ssh key will be assigned , !!! only support spotfleet runner !!! .
selfvpc?🔹 IVpc VPC for the Gitlab Runner .
Default: new VPC will be created , 1 Vpc , 2 Public Subnet .
spotFleet?🔹 boolean Gitlab Runner instance Use Spot Fleet or not ?!.
Default: spotFleet=false
tag1?⚠️ string Gitlab Runner register tag1 .
Default: tag1: gitlab .
tag2?⚠️ string Gitlab Runner register tag2 .
Default: tag2: awscdk .
tag3?⚠️ string Gitlab Runner register tag3 .
Default: tag3: runner .
tags?🔹 Array tags for the runner.
Default: ['runner', 'gitlab', 'awscdk']
validUntil?🔹 string the time when the spot fleet allocation expires.
Default: no expiration , !!! only support spotfleet runner !!! .
vpcSubnet?🔹 SubnetSelection VPC subnet for the spot fleet.
Default: public subnet

enum BlockDuration 🔹

Name Description
ONE_HOUR 🔹
TWO_HOURS 🔹
THREE_HOURS 🔹
FOUR_HOURS 🔹
FIVE_HOURS 🔹
SIX_HOURS 🔹
SEVEN_HOURS 🔹
EIGHT_HOURS 🔹
NINE_HOURS 🔹
TEN_HOURS 🔹
ELEVEN_HOURS 🔹
TWELVE_HOURS 🔹
THIRTEEN_HOURS 🔹
FOURTEEN_HOURS 🔹
FIFTEEN_HOURS 🔹
SIXTEEN_HOURS 🔹
SEVENTEEN_HOURS 🔹
EIGHTTEEN_HOURS 🔹
NINETEEN_HOURS 🔹
TWENTY_HOURS 🔹

enum InstanceInterruptionBehavior 🔹

Name Description
HIBERNATE 🔹
STOP 🔹
TERMINATE 🔹