[](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.8",
"maintainer_email": null,
"keywords": null,
"author": "Neil Kuan<guan840912@gmail.com>",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ea/43/92eb3ff118bbe8e0be8aa9d82d7dd7e10e8e9b71fa5aa6d8941c5dd9a47c/cdktf-gitlab-runner-0.0.916.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.916",
"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": "",
"digests": {
"blake2b_256": "fa79d531b72bd768dc96f360a08d42be3d659df62af1fe947690e5abb3499984",
"md5": "2e329d3931e420d3e844ce80cbab6a2d",
"sha256": "8f34fdd62eabd75494ba27ace41fa63efb728a3305eb875da85ffc886f7bc97f"
},
"downloads": -1,
"filename": "cdktf_gitlab_runner-0.0.916-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2e329d3931e420d3e844ce80cbab6a2d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 43432,
"upload_time": "2024-05-11T00:13:40",
"upload_time_iso_8601": "2024-05-11T00:13:40.141733Z",
"url": "https://files.pythonhosted.org/packages/fa/79/d531b72bd768dc96f360a08d42be3d659df62af1fe947690e5abb3499984/cdktf_gitlab_runner-0.0.916-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ea4392eb3ff118bbe8e0be8aa9d82d7dd7e10e8e9b71fa5aa6d8941c5dd9a47c",
"md5": "e78c681d6b549eb8e9a65626309ae1c0",
"sha256": "2cf96c25cd9fe2fc9406ccadec0786cb957c56d183ef8bf781396c67e0f5b5a5"
},
"downloads": -1,
"filename": "cdktf-gitlab-runner-0.0.916.tar.gz",
"has_sig": false,
"md5_digest": "e78c681d6b549eb8e9a65626309ae1c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 45348,
"upload_time": "2024-05-11T00:13:54",
"upload_time_iso_8601": "2024-05-11T00:13:54.163449Z",
"url": "https://files.pythonhosted.org/packages/ea/43/92eb3ff118bbe8e0be8aa9d82d7dd7e10e8e9b71fa5aa6d8941c5dd9a47c/cdktf-gitlab-runner-0.0.916.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-11 00:13:54",
"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
