[](https://badge.fury.io/js/cdktf-gitlab-runner)
[](https://badge.fury.io/py/cdktf-gitlab-runner)
# 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
```python
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();
```
Raw data
{
"_id": null,
"home_page": "https://github.com/neilkuan/cdktf-gitlab-runner.git",
"name": "cdktf-gitlab-runner",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Neil Kuan<guan840912@gmail.com>",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/5f/8c/ccf4d43c8c308c63ce66ded16b503d80f9f04efafadd29e43e8aabe478df/cdktf_gitlab_runner-0.0.1372.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/js/cdktf-gitlab-runner)\n[](https://badge.fury.io/py/cdktf-gitlab-runner)\n\n\n\n\n\n\n# Welcome to `cdktf-gitlab-runner`\n\nUse 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.\n\n> 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)\n\n### Feature\n\n* Instance Manager Group\n* Auto Register Gitlab Runner\n* Auto Unregister Gitlab Runner ([when destroy and shutdown](https://cloud.google.com/compute/docs/shutdownscript))\n* Support [preemptible](https://cloud.google.com/compute/docs/instances/preemptible)\n\n### Init CDKTF Project\n\n```bash\nmkdir demo\ncd demo\ncdktf init --template typescript --local\n```\n\n### Install `cdktf-gitlab-runner`\n\n```bash\nyarn add cdktf-gitlab-runner\nor\nnpm i cdktf-gitlab-runner\n```\n\n### Example\n\n```python\nimport * as gcp from '@cdktf/provider-google';\nimport * as cdktf from 'cdktf';\nimport { Construct } from 'constructs';\nimport { GitlabRunnerAutoscaling } from './index';\n\n\nexport class IntegDefaultStack extends cdktf.TerraformStack {\n constructor(scope: Construct, id: string) {\n super(scope, id);\n const local = 'asia-east1';\n const projectId = `${process.env.PROJECT_ID}`;\n const provider = new gcp.GoogleProvider(this, 'GoogleAuth', {\n region: local,\n zone: local+'-c',\n project: projectId,\n });\n new GitlabRunnerAutoscaling(this, 'GitlabRunnerAutoscaling', {\n gitlabToken: `${process.env.GITLAB_TOKEN}`,\n provider,\n });\n }\n}\n\n\nconst app = new cdktf.App();\nnew IntegDefaultStack(app, 'gitlab-runner');\napp.synth();\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "The CDK for Terraform Construct for Gitlab Runner on GCP",
"version": "0.0.1372",
"project_urls": {
"Homepage": "https://github.com/neilkuan/cdktf-gitlab-runner.git",
"Source": "https://github.com/neilkuan/cdktf-gitlab-runner.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e5f481d4ecad68b0d365119a202e845c687d659f31d58acfde090eaca9d418e3",
"md5": "919ccace2f4653bf8260876be49d68c8",
"sha256": "1dced8ab9b2eb001a7ccfe90a83c08183a2b61b537bc28fd2d642a0cb6eb90fb"
},
"downloads": -1,
"filename": "cdktf_gitlab_runner-0.0.1372-py3-none-any.whl",
"has_sig": false,
"md5_digest": "919ccace2f4653bf8260876be49d68c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.9",
"size": 45335,
"upload_time": "2025-09-02T00:16:33",
"upload_time_iso_8601": "2025-09-02T00:16:33.525181Z",
"url": "https://files.pythonhosted.org/packages/e5/f4/81d4ecad68b0d365119a202e845c687d659f31d58acfde090eaca9d418e3/cdktf_gitlab_runner-0.0.1372-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5f8cccf4d43c8c308c63ce66ded16b503d80f9f04efafadd29e43e8aabe478df",
"md5": "1a7bb78e0979cda27b210048c6d6f54d",
"sha256": "759172bb2e4091538f9898bb9072e344bb696dad547aab0d5239a7a44509cf6a"
},
"downloads": -1,
"filename": "cdktf_gitlab_runner-0.0.1372.tar.gz",
"has_sig": false,
"md5_digest": "1a7bb78e0979cda27b210048c6d6f54d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.9",
"size": 47307,
"upload_time": "2025-09-02T00:16:35",
"upload_time_iso_8601": "2025-09-02T00:16:35.958139Z",
"url": "https://files.pythonhosted.org/packages/5f/8c/ccf4d43c8c308c63ce66ded16b503d80f9f04efafadd29e43e8aabe478df/cdktf_gitlab_runner-0.0.1372.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-02 00:16:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "neilkuan",
"github_project": "cdktf-gitlab-runner",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cdktf-gitlab-runner"
}
JSON
