https://github.com/neilkuan/cdktf-gitlab-runner

Create gitlab runner on GCP via cdktf.
https://github.com/neilkuan/cdktf-gitlab-runner

Last synced: 9 days ago
JSON representation

Create gitlab runner on GCP via cdktf.

• Host: GitHub
• URL: https://github.com/neilkuan/cdktf-gitlab-runner
• Owner: neilkuan
• License: apache-2.0
• Created: 2021-08-27T04:48:31.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T00:11:38.000Z (7 months ago)
• Last Synced: 2024-04-13T23:16:41.463Z (7 months ago)
• Language: TypeScript
• Size: 3.22 MB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
[![NPM version](https://badge.fury.io/js/cdktf-gitlab-runner.svg)](https://badge.fury.io/js/cdktf-gitlab-runner)

[![PyPI version](https://badge.fury.io/py/cdktf-gitlab-runner.svg)](https://badge.fury.io/py/cdktf-gitlab-runner)

![Release](https://github.com/neilkuan/cdktf-gitlab-runner/workflows/release/badge.svg)

![Downloads](https://img.shields.io/badge/-DOWNLOADS:-brightgreen?color=gray)

![npm](https://img.shields.io/npm/dt/cdktf-gitlab-runner?label=npm&color=orange)

![PyPI](https://img.shields.io/pypi/dm/cdktf-gitlab-runner?label=pypi&color=blue)

# Welcome to `cdktf-gitlab-runner`

Use CDK fo Terraform 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)

### Feature

- Instance Manager Group

- Auto Register Gitlab Runner

- Auto Unregister Gitlab Runner ([when destroy and shutdown](https://cloud.google.com/compute/docs/shutdownscript))

- Support [preemptible](https://cloud.google.com/compute/docs/instances/preemptible)

### Init CDKTF Project

```bash

mkdir demo

cd demo

cdktf init --template typescript --local

```

### Install `cdktf-gitlab-runner`

```bash

yarn add cdktf-gitlab-runner

or

npm i cdktf-gitlab-runner

```

### Example

```ts

import * as gcp from '@cdktf/provider-google';

import * as cdktf from 'cdktf';

import { Construct } from 'constructs';

import { GitlabRunnerAutoscaling } from './index';

export class IntegDefaultStack extends cdktf.TerraformStack {

  constructor(scope: Construct, id: string) {

    super(scope, id);

    const local = 'asia-east1';

    const projectId = `${process.env.PROJECT_ID}`;

    const provider = new gcp.GoogleProvider(this, 'GoogleAuth', {

      region: local,

      zone: local+'-c',

      project: projectId,

    });

    new GitlabRunnerAutoscaling(this, 'GitlabRunnerAutoscaling', {

      gitlabToken: `${process.env.GITLAB_TOKEN}`,

      provider,

    });

  }

}

const app = new cdktf.App();

new IntegDefaultStack(app, 'gitlab-runner');

app.synth();

```