PyPI 官网下载 | cdk-gitlab-runner-1.94.19.tar.gz

[](https://badge.fury.io/js/cdk-gitlab-runner) [](https://badge.fury.io/py/cdk-gitlab-runner)         # Welcome to `cdk-gitlab-runner` This repository template helps you create gitlab runner on your aws account via AWS CDK one line. ## Note ### Default will help you generate below services: * VPC * Public Subnet (2) * EC2 (1 T3.micro) ## Before start you need gitlab runner token in your `gitlab project` or `gitlab group` ### In Group Group > Settings > CI/CD  ### In Group Project > Settings > CI/CD > Runners  ## Usage Replace your gitlab runner token in `$GITLABTOKEN` ### Instance Type ```python # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 from cdk_gitlab_runner import GitlabContainerRunner # If want change instance type to t3.large . GitlabContainerRunner(self, "runner-instance", gitlabtoken="$GITLABTOKEN", ec2type="t3.large") # OR # Just create a gitlab runner , by default instance type is t3.micro . from cdk_gitlab_runner import GitlabContainerRunner GitlabContainerRunner(self, "runner-instance", gitlabtoken="$GITLABTOKEN") ``` ### Gitlab Server Customize Url . If you want change what you want tag name . ```python # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 # If you want change what your self Gitlab Server Url . from cdk_gitlab_runner import GitlabContainerRunner GitlabContainerRunner(self, "runner-instance-change-tag", gitlabtoken="$GITLABTOKEN", gitlaburl="https://gitlab.my.com/" ) ``` ### Tags If you want change what you want tag name . ```python # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 # If you want change what you want tag name . from cdk_gitlab_runner import GitlabContainerRunner GitlabContainerRunner(self, "runner-instance-change-tag", gitlabtoken="$GITLABTOKEN", tags=["aa", "bb", "cc"] ) ``` ### IAM Policy If you want add runner other IAM Policy like s3-readonly-access. ```python # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 # If you want add runner other IAM Policy like s3-readonly-access. from cdk_gitlab_runner import GitlabContainerRunner from aws_cdk.aws_iam import ManagedPolicy runner = GitlabContainerRunner(self, "runner-instance-add-policy", gitlabtoken="$GITLABTOKEN", tags=["aa", "bb", "cc"] ) runner.runner_role.add_managed_policy( ManagedPolicy.from_aws_managed_policy_name("AmazonS3ReadOnlyAccess")) ``` ### Security Group If you want add runner other SG Ingress . ```python # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 # If you want add runner other SG Ingress . from cdk_gitlab_runner import GitlabContainerRunner from aws_cdk.aws_ec2 import Port, Peer runner = GitlabContainerRunner(self, "runner-add-SG-ingress", gitlabtoken="GITLABTOKEN", tags=["aa", "bb", "cc"] ) # you can add ingress in your runner SG . runner.default_runner_sG.connections.allow_from( Peer.ipv4("0.0.0.0/0"), Port.tcp(80)) ``` ### Use self VPC > 2020/06/27 , you can use your self exist VPC or new VPC , but please check your `vpc public Subnet` Auto-assign public IPv4 address must be Yes ,or `vpc private Subnet` route table associated `nat gateway` . ```python # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 from cdk_gitlab_runner import GitlabContainerRunner from aws_cdk.aws_ec2 import Port, Peer, Vpc, SubnetType from aws_cdk.aws_iam import ManagedPolicy newvpc = Vpc(stack, "VPC", cidr="10.1.0.0/16", max_azs=2, subnet_configuration=[SubnetConfiguration( cidr_mask=26, name="RunnerVPC", subnet_type=SubnetType.PUBLIC ) ], nat_gateways=0 ) runner = GitlabContainerRunner(self, "testing", gitlabtoken="$GITLABTOKEN", ec2type="t3.small", selfvpc=newvpc ) ``` ### Use your self exist role > 2020/06/27 , you can use your self exist role assign to runner ```python # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 from cdk_gitlab_runner import GitlabContainerRunner from aws_cdk.aws_ec2 import Port, Peer from aws_cdk.aws_iam import ManagedPolicy, Role, ServicePrincipal role = Role(self, "runner-role", assumed_by=ServicePrincipal("ec2.amazonaws.com"), description="For Gitlab EC2 Runner Test Role", role_name="TestRole" ) runner = GitlabContainerRunner(stack, "testing", gitlabtoken="$GITLAB_TOKEN", ec2iamrole=role ) runner.runner_role.add_managed_policy( ManagedPolicy.from_aws_managed_policy_name("AmazonS3ReadOnlyAccess")) ``` ### Custom Gitlab Runner EBS szie > 2020/08/22 , you can change you want ebs size. ```python # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 from cdk_gitlab_runner import GitlabContainerRunner GitlabContainerRunner(stack, "testing", gitlabtoken="$GITLAB_TOKEN", ebs_size=50 ) ``` ### Control the number of runners with AutoScalingGroup > 2020/11/25 , you can set the number of runners. ```python # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 from cdk_gitlab_runner import GitlabRunnerAutoscaling GitlabRunnerAutoscaling(stack, "testing", gitlab_token="$GITLAB_TOKEN", min_capacity=2, max_capacity=2 ) ``` ### Support Spotfleet Gitlab Runner > 2020/08/27 , you can use spotfleet instance be your gitlab runner, > after create spotfleet instance will auto output instance id .thank [@pahud](https://github.com/pahud/cdk-spot-one) again ~~~ ```python # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 from cdk_gitlab_runner import GitlabContainerRunner, BlockDuration runner = GitlabContainerRunner(stack, "testing", gitlabtoken="GITLAB_TOKEN", ec2type="t3.large", block_duration=BlockDuration.ONE_HOUR, spot_fleet=True ) # configure the expiration after 1 hours runner.expire_after(Duration.hours(1)) ``` > 2020/11/19, you setting job runtime bind host volumes. > see more https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersdocker-section ```python # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 from cdk_gitlab_runner import GitlabContainerRunner, BlockDuration runner = GitlabContainerRunner(stack, "testing", gitlabtoken="GITLAB_TOKEN", ec2type="t3.large", docker_volumes=[{ "host_path": "/tmp/cahce", "container_path": "/tmp/cahce" } ] ) ``` > 2020/11/19, support runner auto unregister runner when cdk app destroy. # Note  vs  > About change instance type This is before  ( included  ) ```pyth