diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-04-11 03:12:15 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-04-11 03:12:15 +0000 |
| commit | 4784e1a9d1621513b1c731a7fb82106a3d432ac4 (patch) | |
| tree | 921021da4ee4e580136ad267a8b279ccc752b47b | |
| parent | 88de656e4045e232bd5daf4f3d78bd1ac70f5298 (diff) | |
automatic import of python-cdk-gitlab-runner
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-cdk-gitlab-runner.spec | 1046 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 1048 insertions, 0 deletions
@@ -0,0 +1 @@ +/cdk-gitlab-runner-2.1.172.tar.gz diff --git a/python-cdk-gitlab-runner.spec b/python-cdk-gitlab-runner.spec new file mode 100644 index 0000000..37812a2 --- /dev/null +++ b/python-cdk-gitlab-runner.spec @@ -0,0 +1,1046 @@ +%global _empty_manifest_terminate_build 0 +Name: python-cdk-gitlab-runner +Version: 2.1.172 +Release: 1 +Summary: Use AWS CDK to create a gitlab runner, and use gitlab runner to help you execute your Gitlab pipeline job. +License: Apache-2.0 +URL: https://github.com/neilkuan/cdk-gitlab-runner.git +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/bb/ce/ae7af38b455ea481d8d0b1cd5ac8ae81bd5d923e02a72b7544d059b1b141/cdk-gitlab-runner-2.1.172.tar.gz +BuildArch: noarch + +Requires: python3-aws-cdk-lib +Requires: python3-constructs +Requires: python3-jsii +Requires: python3-publication +Requires: python3-typeguard + +%description +[](https://badge.fury.io/js/cdk-gitlab-runner) +[](https://badge.fury.io/py/cdk-gitlab-runner) + + + + + + + + + + + +# Welcome to `cdk-gitlab-runner` + +Use AWS CDK to create gitlab runner, and use [gitlab runner](https://gitlab.com/gitlab-org/gitlab-runner) to help you execute your Gitlab Pipeline Job. + +> GitLab Runner is the open source project that is used to run your CI/CD jobs and send the results back to GitLab. [(source repo)](https://gitlab.com/gitlab-org/gitlab-runner) + +## Why + +Gitlab provides [400 minutes per month for each free user](https://about.gitlab.com/pricing/), hosted Gitlab Runner to execute your gitlab pipeline job.That's pretty good and users don't need to manage gitlab runner. If it is just a simple ci job for test 400, it may be enough. +But what if you want to deploy to your AWS production environment through pipeline job? +Is there any security consideration for using the hosted gitlab runner?! + +But creating Gitlab Runner is not that simple, so I created this OSS so that you can quickly create Gitlab Runner and delete your Gitlab Runner via AWS CDK. +It will be used with AWS IAM Role, so you don't need to put AKSK in Gitlab environment variables. + + + +## 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 Project + +Project > Settings > CI/CD > Runners + + +## Usage + +Replace your gitlab runner token in `$GITLABTOKEN` + +## Install + +Use the npm dist tag to opt in CDKv1 or CDKv2: + +```bash +// for CDKv2 +npm install cdk-gitlab-runner +or +npm install cdk-gitlab-runner@latest + +// for CDKv1 +npm install cdk-gitlab-runner@cdkv1 +``` + +## 💡💡💡 please click [here](https://github.com/neilkuan/cdk-gitlab-runner/tree/cdkv1#readme), if you are using aws-cdk v1.x.x version.💡💡💡 + +### Instance Type + +```python +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; + +// If want change instance type to t3.large . +new GitlabContainerRunner(this, 'runner-instance', { gitlabtoken: '$GITLABTOKEN', ec2type:'t3.large' }); +// OR +// Just create a gitlab runner , by default instance type is t3.micro . +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; + +new GitlabContainerRunner(this, 'runner-instance', { gitlabtoken: '$GITLABTOKEN' });}) +``` + +### Gitlab Server Customize Url . + +If you want change what you want tag name . + +```python +// If you want change what your self Gitlab Server Url . +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; + +new GitlabContainerRunner(this, 'runner-instance-change-tag', { + gitlabtoken: '$GITLABTOKEN', + gitlaburl: 'https://gitlab.my.com/', +}); +``` + +### Tags + +If you want change what you want tag name . + +```python +// If you want change what you want tag name . +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; + +new GitlabContainerRunner(this, '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 +// If you want add runner other IAM Policy like s3-readonly-access. +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; +import { ManagedPolicy } from 'aws-cdk-lib/aws-iam'; + +const runner = new GitlabContainerRunner(this, 'runner-instance-add-policy', { + gitlabtoken: '$GITLABTOKEN', + tags: ['aa', 'bb', 'cc'], +}); +runner.runnerRole.addManagedPolicy( + ManagedPolicy.fromAwsManagedPolicyName('AmazonS3ReadOnlyAccess'), +); +``` + +### Security Group + +If you want add runner other SG Ingress . + +```python +// If you want add runner other SG Ingress . +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; +import { Port, Peer } from 'aws-cdk-lib/aws-ec2'; + +const runner = new GitlabContainerRunner(this, 'runner-add-SG-ingress', { + gitlabtoken: 'GITLABTOKEN', + tags: ['aa', 'bb', 'cc'], +}); + +// you can add ingress in your runner SG . +runner.defaultRunnerSG.connections.allowFrom( + 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 +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; +import { Port, Peer, Vpc, SubnetType } from 'aws-cdk-lib/aws-ec2'; +import { ManagedPolicy } from 'aws-cdk-lib/aws-iam'; + +const newvpc = new Vpc(stack, 'VPC', { + cidr: '10.1.0.0/16', + maxAzs: 2, + subnetConfiguration: [ + { + cidrMask: 26, + name: 'RunnerVPC', + subnetType: SubnetType.PUBLIC, + }, + ], + natGateways: 0, +}); + +const runner = new GitlabContainerRunner(this, '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 +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; +import { Port, Peer } from 'aws-cdk-lib/aws-ec2'; +import { ManagedPolicy, Role, ServicePrincipal } from 'aws-cdk-lib/aws-iam'; + +const role = new Role(this, 'runner-role', { + assumedBy: new ServicePrincipal('ec2.amazonaws.com'), + description: 'For Gitlab EC2 Runner Test Role', + roleName: 'TestRole', +}); + +const runner = new GitlabContainerRunner(stack, 'testing', { + gitlabtoken: '$GITLAB_TOKEN', + ec2iamrole: role, +}); +runner.runnerRole.addManagedPolicy( + ManagedPolicy.fromAwsManagedPolicyName('AmazonS3ReadOnlyAccess'), +); +``` + +### Custom Gitlab Runner EBS szie + +> 2020/08/22 , you can change you want ebs size. + +```python +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; + +new GitlabContainerRunner(stack, 'testing', { + gitlabtoken: '$GITLAB_TOKEN', + ebsSize: 50, +}); +``` + +### Control the number of runners with AutoScalingGroup + +> 2020/11/25 , you can set the number of runners. + +```python +import { GitlabRunnerAutoscaling } from 'cdk-gitlab-runner'; + +new GitlabRunnerAutoscaling(stack, 'testing', { + gitlabToken: '$GITLAB_TOKEN', + minCapacity: 2, + maxCapacity: 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. + +```python +import { GitlabContainerRunner, BlockDuration } from 'cdk-gitlab-runner'; + +const runner = new GitlabContainerRunner(stack, 'testing', { + gitlabtoken: 'GITLAB_TOKEN', + ec2type: 't3.large', + spotFleet: true, +}); +// configure the expiration after 1 hours +runner.expireAfter(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 +import { GitlabContainerRunner, BlockDuration } from 'cdk-gitlab-runner'; + +const runner = new GitlabContainerRunner(stack, 'testing', { + gitlabtoken: 'GITLAB_TOKEN', + ec2type: 't3.large', + dockerVolumes: [ + { + hostPath: '/tmp/cache', + containerPath: '/tmp/cache', + }, + ], +}); +``` + +## Wait about 6 mins , If success you will see your runner in that page . + + + +#### you can use tag `gitlab` , `runner` , `awscdk` , + +## Example *`gitlab-ci.yaml`* + +[gitlab docs see more ...](https://docs.gitlab.com/ee/ci/yaml/README.html) + +```yaml +dockerjob: + image: docker:18.09-dind + variables: + tags: + - runner + - awscdk + - gitlab + variables: + DOCKER_TLS_CERTDIR: "" + before_script: + - docker info + script: + - docker info; + - echo 'test 123'; + - echo 'hello world 1228' +``` + +### If your want to debug you can go to aws console + +# `In your runner region !!!` + +## AWS Systems Manager > Session Manager > Start a session + + + +#### click your `runner` and click `start session` + +#### in the brower console in put `bash` + +```bash +# become to root +sudo -i + +# list runner container . +root# docker ps -a + +# modify gitlab-runner/config.toml + +root# cd /home/ec2-user/.gitlab-runner/ && ls +config.toml +``` + +## :clap: Supporters + +[](https://github.com/neilkuan/cdk-gitlab-runner/stargazers) + + +%package -n python3-cdk-gitlab-runner +Summary: Use AWS CDK to create a gitlab runner, and use gitlab runner to help you execute your Gitlab pipeline job. +Provides: python-cdk-gitlab-runner +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-cdk-gitlab-runner +[](https://badge.fury.io/js/cdk-gitlab-runner) +[](https://badge.fury.io/py/cdk-gitlab-runner) + + + + + + + + + + + +# Welcome to `cdk-gitlab-runner` + +Use AWS CDK to create gitlab runner, and use [gitlab runner](https://gitlab.com/gitlab-org/gitlab-runner) to help you execute your Gitlab Pipeline Job. + +> GitLab Runner is the open source project that is used to run your CI/CD jobs and send the results back to GitLab. [(source repo)](https://gitlab.com/gitlab-org/gitlab-runner) + +## Why + +Gitlab provides [400 minutes per month for each free user](https://about.gitlab.com/pricing/), hosted Gitlab Runner to execute your gitlab pipeline job.That's pretty good and users don't need to manage gitlab runner. If it is just a simple ci job for test 400, it may be enough. +But what if you want to deploy to your AWS production environment through pipeline job? +Is there any security consideration for using the hosted gitlab runner?! + +But creating Gitlab Runner is not that simple, so I created this OSS so that you can quickly create Gitlab Runner and delete your Gitlab Runner via AWS CDK. +It will be used with AWS IAM Role, so you don't need to put AKSK in Gitlab environment variables. + + + +## 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 Project + +Project > Settings > CI/CD > Runners + + +## Usage + +Replace your gitlab runner token in `$GITLABTOKEN` + +## Install + +Use the npm dist tag to opt in CDKv1 or CDKv2: + +```bash +// for CDKv2 +npm install cdk-gitlab-runner +or +npm install cdk-gitlab-runner@latest + +// for CDKv1 +npm install cdk-gitlab-runner@cdkv1 +``` + +## 💡💡💡 please click [here](https://github.com/neilkuan/cdk-gitlab-runner/tree/cdkv1#readme), if you are using aws-cdk v1.x.x version.💡💡💡 + +### Instance Type + +```python +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; + +// If want change instance type to t3.large . +new GitlabContainerRunner(this, 'runner-instance', { gitlabtoken: '$GITLABTOKEN', ec2type:'t3.large' }); +// OR +// Just create a gitlab runner , by default instance type is t3.micro . +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; + +new GitlabContainerRunner(this, 'runner-instance', { gitlabtoken: '$GITLABTOKEN' });}) +``` + +### Gitlab Server Customize Url . + +If you want change what you want tag name . + +```python +// If you want change what your self Gitlab Server Url . +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; + +new GitlabContainerRunner(this, 'runner-instance-change-tag', { + gitlabtoken: '$GITLABTOKEN', + gitlaburl: 'https://gitlab.my.com/', +}); +``` + +### Tags + +If you want change what you want tag name . + +```python +// If you want change what you want tag name . +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; + +new GitlabContainerRunner(this, '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 +// If you want add runner other IAM Policy like s3-readonly-access. +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; +import { ManagedPolicy } from 'aws-cdk-lib/aws-iam'; + +const runner = new GitlabContainerRunner(this, 'runner-instance-add-policy', { + gitlabtoken: '$GITLABTOKEN', + tags: ['aa', 'bb', 'cc'], +}); +runner.runnerRole.addManagedPolicy( + ManagedPolicy.fromAwsManagedPolicyName('AmazonS3ReadOnlyAccess'), +); +``` + +### Security Group + +If you want add runner other SG Ingress . + +```python +// If you want add runner other SG Ingress . +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; +import { Port, Peer } from 'aws-cdk-lib/aws-ec2'; + +const runner = new GitlabContainerRunner(this, 'runner-add-SG-ingress', { + gitlabtoken: 'GITLABTOKEN', + tags: ['aa', 'bb', 'cc'], +}); + +// you can add ingress in your runner SG . +runner.defaultRunnerSG.connections.allowFrom( + 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 +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; +import { Port, Peer, Vpc, SubnetType } from 'aws-cdk-lib/aws-ec2'; +import { ManagedPolicy } from 'aws-cdk-lib/aws-iam'; + +const newvpc = new Vpc(stack, 'VPC', { + cidr: '10.1.0.0/16', + maxAzs: 2, + subnetConfiguration: [ + { + cidrMask: 26, + name: 'RunnerVPC', + subnetType: SubnetType.PUBLIC, + }, + ], + natGateways: 0, +}); + +const runner = new GitlabContainerRunner(this, '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 +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; +import { Port, Peer } from 'aws-cdk-lib/aws-ec2'; +import { ManagedPolicy, Role, ServicePrincipal } from 'aws-cdk-lib/aws-iam'; + +const role = new Role(this, 'runner-role', { + assumedBy: new ServicePrincipal('ec2.amazonaws.com'), + description: 'For Gitlab EC2 Runner Test Role', + roleName: 'TestRole', +}); + +const runner = new GitlabContainerRunner(stack, 'testing', { + gitlabtoken: '$GITLAB_TOKEN', + ec2iamrole: role, +}); +runner.runnerRole.addManagedPolicy( + ManagedPolicy.fromAwsManagedPolicyName('AmazonS3ReadOnlyAccess'), +); +``` + +### Custom Gitlab Runner EBS szie + +> 2020/08/22 , you can change you want ebs size. + +```python +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; + +new GitlabContainerRunner(stack, 'testing', { + gitlabtoken: '$GITLAB_TOKEN', + ebsSize: 50, +}); +``` + +### Control the number of runners with AutoScalingGroup + +> 2020/11/25 , you can set the number of runners. + +```python +import { GitlabRunnerAutoscaling } from 'cdk-gitlab-runner'; + +new GitlabRunnerAutoscaling(stack, 'testing', { + gitlabToken: '$GITLAB_TOKEN', + minCapacity: 2, + maxCapacity: 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. + +```python +import { GitlabContainerRunner, BlockDuration } from 'cdk-gitlab-runner'; + +const runner = new GitlabContainerRunner(stack, 'testing', { + gitlabtoken: 'GITLAB_TOKEN', + ec2type: 't3.large', + spotFleet: true, +}); +// configure the expiration after 1 hours +runner.expireAfter(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 +import { GitlabContainerRunner, BlockDuration } from 'cdk-gitlab-runner'; + +const runner = new GitlabContainerRunner(stack, 'testing', { + gitlabtoken: 'GITLAB_TOKEN', + ec2type: 't3.large', + dockerVolumes: [ + { + hostPath: '/tmp/cache', + containerPath: '/tmp/cache', + }, + ], +}); +``` + +## Wait about 6 mins , If success you will see your runner in that page . + + + +#### you can use tag `gitlab` , `runner` , `awscdk` , + +## Example *`gitlab-ci.yaml`* + +[gitlab docs see more ...](https://docs.gitlab.com/ee/ci/yaml/README.html) + +```yaml +dockerjob: + image: docker:18.09-dind + variables: + tags: + - runner + - awscdk + - gitlab + variables: + DOCKER_TLS_CERTDIR: "" + before_script: + - docker info + script: + - docker info; + - echo 'test 123'; + - echo 'hello world 1228' +``` + +### If your want to debug you can go to aws console + +# `In your runner region !!!` + +## AWS Systems Manager > Session Manager > Start a session + + + +#### click your `runner` and click `start session` + +#### in the brower console in put `bash` + +```bash +# become to root +sudo -i + +# list runner container . +root# docker ps -a + +# modify gitlab-runner/config.toml + +root# cd /home/ec2-user/.gitlab-runner/ && ls +config.toml +``` + +## :clap: Supporters + +[](https://github.com/neilkuan/cdk-gitlab-runner/stargazers) + + +%package help +Summary: Development documents and examples for cdk-gitlab-runner +Provides: python3-cdk-gitlab-runner-doc +%description help +[](https://badge.fury.io/js/cdk-gitlab-runner) +[](https://badge.fury.io/py/cdk-gitlab-runner) + + + + + + + + + + + +# Welcome to `cdk-gitlab-runner` + +Use AWS CDK to create gitlab runner, and use [gitlab runner](https://gitlab.com/gitlab-org/gitlab-runner) to help you execute your Gitlab Pipeline Job. + +> GitLab Runner is the open source project that is used to run your CI/CD jobs and send the results back to GitLab. [(source repo)](https://gitlab.com/gitlab-org/gitlab-runner) + +## Why + +Gitlab provides [400 minutes per month for each free user](https://about.gitlab.com/pricing/), hosted Gitlab Runner to execute your gitlab pipeline job.That's pretty good and users don't need to manage gitlab runner. If it is just a simple ci job for test 400, it may be enough. +But what if you want to deploy to your AWS production environment through pipeline job? +Is there any security consideration for using the hosted gitlab runner?! + +But creating Gitlab Runner is not that simple, so I created this OSS so that you can quickly create Gitlab Runner and delete your Gitlab Runner via AWS CDK. +It will be used with AWS IAM Role, so you don't need to put AKSK in Gitlab environment variables. + + + +## 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 Project + +Project > Settings > CI/CD > Runners + + +## Usage + +Replace your gitlab runner token in `$GITLABTOKEN` + +## Install + +Use the npm dist tag to opt in CDKv1 or CDKv2: + +```bash +// for CDKv2 +npm install cdk-gitlab-runner +or +npm install cdk-gitlab-runner@latest + +// for CDKv1 +npm install cdk-gitlab-runner@cdkv1 +``` + +## 💡💡💡 please click [here](https://github.com/neilkuan/cdk-gitlab-runner/tree/cdkv1#readme), if you are using aws-cdk v1.x.x version.💡💡💡 + +### Instance Type + +```python +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; + +// If want change instance type to t3.large . +new GitlabContainerRunner(this, 'runner-instance', { gitlabtoken: '$GITLABTOKEN', ec2type:'t3.large' }); +// OR +// Just create a gitlab runner , by default instance type is t3.micro . +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; + +new GitlabContainerRunner(this, 'runner-instance', { gitlabtoken: '$GITLABTOKEN' });}) +``` + +### Gitlab Server Customize Url . + +If you want change what you want tag name . + +```python +// If you want change what your self Gitlab Server Url . +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; + +new GitlabContainerRunner(this, 'runner-instance-change-tag', { + gitlabtoken: '$GITLABTOKEN', + gitlaburl: 'https://gitlab.my.com/', +}); +``` + +### Tags + +If you want change what you want tag name . + +```python +// If you want change what you want tag name . +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; + +new GitlabContainerRunner(this, '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 +// If you want add runner other IAM Policy like s3-readonly-access. +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; +import { ManagedPolicy } from 'aws-cdk-lib/aws-iam'; + +const runner = new GitlabContainerRunner(this, 'runner-instance-add-policy', { + gitlabtoken: '$GITLABTOKEN', + tags: ['aa', 'bb', 'cc'], +}); +runner.runnerRole.addManagedPolicy( + ManagedPolicy.fromAwsManagedPolicyName('AmazonS3ReadOnlyAccess'), +); +``` + +### Security Group + +If you want add runner other SG Ingress . + +```python +// If you want add runner other SG Ingress . +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; +import { Port, Peer } from 'aws-cdk-lib/aws-ec2'; + +const runner = new GitlabContainerRunner(this, 'runner-add-SG-ingress', { + gitlabtoken: 'GITLABTOKEN', + tags: ['aa', 'bb', 'cc'], +}); + +// you can add ingress in your runner SG . +runner.defaultRunnerSG.connections.allowFrom( + 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 +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; +import { Port, Peer, Vpc, SubnetType } from 'aws-cdk-lib/aws-ec2'; +import { ManagedPolicy } from 'aws-cdk-lib/aws-iam'; + +const newvpc = new Vpc(stack, 'VPC', { + cidr: '10.1.0.0/16', + maxAzs: 2, + subnetConfiguration: [ + { + cidrMask: 26, + name: 'RunnerVPC', + subnetType: SubnetType.PUBLIC, + }, + ], + natGateways: 0, +}); + +const runner = new GitlabContainerRunner(this, '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 +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; +import { Port, Peer } from 'aws-cdk-lib/aws-ec2'; +import { ManagedPolicy, Role, ServicePrincipal } from 'aws-cdk-lib/aws-iam'; + +const role = new Role(this, 'runner-role', { + assumedBy: new ServicePrincipal('ec2.amazonaws.com'), + description: 'For Gitlab EC2 Runner Test Role', + roleName: 'TestRole', +}); + +const runner = new GitlabContainerRunner(stack, 'testing', { + gitlabtoken: '$GITLAB_TOKEN', + ec2iamrole: role, +}); +runner.runnerRole.addManagedPolicy( + ManagedPolicy.fromAwsManagedPolicyName('AmazonS3ReadOnlyAccess'), +); +``` + +### Custom Gitlab Runner EBS szie + +> 2020/08/22 , you can change you want ebs size. + +```python +import { GitlabContainerRunner } from 'cdk-gitlab-runner'; + +new GitlabContainerRunner(stack, 'testing', { + gitlabtoken: '$GITLAB_TOKEN', + ebsSize: 50, +}); +``` + +### Control the number of runners with AutoScalingGroup + +> 2020/11/25 , you can set the number of runners. + +```python +import { GitlabRunnerAutoscaling } from 'cdk-gitlab-runner'; + +new GitlabRunnerAutoscaling(stack, 'testing', { + gitlabToken: '$GITLAB_TOKEN', + minCapacity: 2, + maxCapacity: 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. + +```python +import { GitlabContainerRunner, BlockDuration } from 'cdk-gitlab-runner'; + +const runner = new GitlabContainerRunner(stack, 'testing', { + gitlabtoken: 'GITLAB_TOKEN', + ec2type: 't3.large', + spotFleet: true, +}); +// configure the expiration after 1 hours +runner.expireAfter(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 +import { GitlabContainerRunner, BlockDuration } from 'cdk-gitlab-runner'; + +const runner = new GitlabContainerRunner(stack, 'testing', { + gitlabtoken: 'GITLAB_TOKEN', + ec2type: 't3.large', + dockerVolumes: [ + { + hostPath: '/tmp/cache', + containerPath: '/tmp/cache', + }, + ], +}); +``` + +## Wait about 6 mins , If success you will see your runner in that page . + + + +#### you can use tag `gitlab` , `runner` , `awscdk` , + +## Example *`gitlab-ci.yaml`* + +[gitlab docs see more ...](https://docs.gitlab.com/ee/ci/yaml/README.html) + +```yaml +dockerjob: + image: docker:18.09-dind + variables: + tags: + - runner + - awscdk + - gitlab + variables: + DOCKER_TLS_CERTDIR: "" + before_script: + - docker info + script: + - docker info; + - echo 'test 123'; + - echo 'hello world 1228' +``` + +### If your want to debug you can go to aws console + +# `In your runner region !!!` + +## AWS Systems Manager > Session Manager > Start a session + + + +#### click your `runner` and click `start session` + +#### in the brower console in put `bash` + +```bash +# become to root +sudo -i + +# list runner container . +root# docker ps -a + +# modify gitlab-runner/config.toml + +root# cd /home/ec2-user/.gitlab-runner/ && ls +config.toml +``` + +## :clap: Supporters + +[](https://github.com/neilkuan/cdk-gitlab-runner/stargazers) + + +%prep +%autosetup -n cdk-gitlab-runner-2.1.172 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-cdk-gitlab-runner -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 2.1.172-1 +- Package Spec generated @@ -0,0 +1 @@ +1fded989cd7440941648e6fd6ac24f26 cdk-gitlab-runner-2.1.172.tar.gz |