@cloudsnorkel/cdk-github-runners 0.9.4 → 0.9.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitattributes +5 -3
- package/.jsii +332 -284
- package/API.md +55 -19
- package/README.md +135 -65
- package/assets/{providers/image-builders → image-builders}/aws-image-builder/delete-ami.lambda/index.js +2 -2
- package/assets/{providers/image-builders → image-builders}/aws-image-builder/filter-failed-builds.lambda/index.js +1 -1
- package/assets/image-builders/aws-image-builder/reaper.lambda/index.js +163 -0
- package/assets/{providers/image-builders → image-builders}/aws-image-builder/versioner.lambda/index.js +2 -2
- package/cdk.json +10 -0
- package/lib/access.js +1 -1
- package/lib/image-builders/api.js +47 -0
- package/lib/{providers/image-builders → image-builders}/aws-image-builder/ami.d.ts +2 -3
- package/lib/image-builders/aws-image-builder/ami.js +93 -0
- package/lib/{providers/image-builders → image-builders}/aws-image-builder/builder.d.ts +10 -3
- package/lib/image-builders/aws-image-builder/builder.js +568 -0
- package/lib/image-builders/aws-image-builder/common.js +46 -0
- package/lib/{providers/image-builders → image-builders}/aws-image-builder/container.d.ts +1 -1
- package/lib/image-builders/aws-image-builder/container.js +63 -0
- package/lib/{providers/image-builders → image-builders}/aws-image-builder/delete-ami-function.d.ts +1 -1
- package/lib/image-builders/aws-image-builder/delete-ami-function.js +23 -0
- package/lib/image-builders/aws-image-builder/delete-ami.lambda.js +87 -0
- package/lib/{providers/image-builders → image-builders}/aws-image-builder/deprecated/ami.d.ts +4 -4
- package/lib/image-builders/aws-image-builder/deprecated/ami.js +240 -0
- package/lib/{providers/image-builders → image-builders}/aws-image-builder/deprecated/common.d.ts +1 -1
- package/lib/image-builders/aws-image-builder/deprecated/common.js +144 -0
- package/lib/{providers/image-builders → image-builders}/aws-image-builder/deprecated/container.d.ts +3 -3
- package/lib/image-builders/aws-image-builder/deprecated/container.js +222 -0
- package/lib/{providers/image-builders → image-builders}/aws-image-builder/deprecated/index.js +1 -1
- package/lib/{providers/image-builders → image-builders}/aws-image-builder/deprecated/linux-components.d.ts +1 -1
- package/lib/image-builders/aws-image-builder/deprecated/linux-components.js +172 -0
- package/lib/{providers/image-builders → image-builders}/aws-image-builder/deprecated/windows-components.d.ts +1 -1
- package/lib/image-builders/aws-image-builder/deprecated/windows-components.js +126 -0
- package/lib/{providers/image-builders → image-builders}/aws-image-builder/filter-failed-builds-function.d.ts +1 -1
- package/lib/image-builders/aws-image-builder/filter-failed-builds-function.js +23 -0
- package/lib/image-builders/aws-image-builder/filter-failed-builds.lambda.js +18 -0
- package/lib/{providers/image-builders → image-builders}/aws-image-builder/index.js +1 -1
- package/lib/image-builders/aws-image-builder/reaper-function.d.ts +13 -0
- package/lib/image-builders/aws-image-builder/reaper-function.js +23 -0
- package/lib/image-builders/aws-image-builder/reaper.lambda.d.ts +1 -0
- package/lib/image-builders/aws-image-builder/reaper.lambda.js +149 -0
- package/lib/{providers/image-builders → image-builders}/aws-image-builder/versioner-function.d.ts +1 -1
- package/lib/image-builders/aws-image-builder/versioner-function.js +23 -0
- package/lib/image-builders/aws-image-builder/versioner.lambda.js +96 -0
- package/lib/{providers/image-builders → image-builders}/codebuild-deprecated.d.ts +5 -5
- package/lib/image-builders/codebuild-deprecated.js +373 -0
- package/lib/{providers/image-builders → image-builders}/codebuild.d.ts +2 -2
- package/lib/image-builders/codebuild.js +289 -0
- package/lib/{providers/image-builders → image-builders}/common.d.ts +6 -4
- package/lib/{providers/image-builders → image-builders}/common.js +1 -1
- package/lib/{providers/image-builders → image-builders}/components.d.ts +8 -2
- package/lib/image-builders/components.js +568 -0
- package/lib/{providers/image-builders → image-builders}/index.js +1 -1
- package/lib/{providers/image-builders → image-builders}/static.d.ts +1 -1
- package/lib/image-builders/static.js +58 -0
- package/lib/providers/codebuild.d.ts +1 -1
- package/lib/providers/codebuild.js +4 -4
- package/lib/providers/common.js +3 -3
- package/lib/providers/ec2.d.ts +2 -2
- package/lib/providers/ec2.js +4 -4
- package/lib/providers/ecs.d.ts +1 -1
- package/lib/providers/ecs.js +3 -3
- package/lib/providers/fargate.d.ts +1 -1
- package/lib/providers/fargate.js +4 -4
- package/lib/providers/index.d.ts +1 -1
- package/lib/providers/index.js +2 -2
- package/lib/providers/lambda.d.ts +1 -1
- package/lib/providers/lambda.js +4 -4
- package/lib/runner.d.ts +3 -3
- package/lib/runner.js +5 -5
- package/lib/secrets.js +1 -1
- package/package.json +12 -10
- package/lib/providers/image-builders/api.js +0 -47
- package/lib/providers/image-builders/aws-image-builder/ami.js +0 -81
- package/lib/providers/image-builders/aws-image-builder/builder.js +0 -520
- package/lib/providers/image-builders/aws-image-builder/common.js +0 -46
- package/lib/providers/image-builders/aws-image-builder/container.js +0 -63
- package/lib/providers/image-builders/aws-image-builder/delete-ami-function.js +0 -23
- package/lib/providers/image-builders/aws-image-builder/delete-ami.lambda.js +0 -87
- package/lib/providers/image-builders/aws-image-builder/deprecated/ami.js +0 -240
- package/lib/providers/image-builders/aws-image-builder/deprecated/common.js +0 -144
- package/lib/providers/image-builders/aws-image-builder/deprecated/container.js +0 -222
- package/lib/providers/image-builders/aws-image-builder/deprecated/linux-components.js +0 -172
- package/lib/providers/image-builders/aws-image-builder/deprecated/windows-components.js +0 -129
- package/lib/providers/image-builders/aws-image-builder/filter-failed-builds-function.js +0 -23
- package/lib/providers/image-builders/aws-image-builder/filter-failed-builds.lambda.js +0 -18
- package/lib/providers/image-builders/aws-image-builder/versioner-function.js +0 -23
- package/lib/providers/image-builders/aws-image-builder/versioner.lambda.js +0 -96
- package/lib/providers/image-builders/codebuild-deprecated.js +0 -373
- package/lib/providers/image-builders/codebuild.js +0 -287
- package/lib/providers/image-builders/components.js +0 -535
- package/lib/providers/image-builders/static.js +0 -58
- /package/lib/{providers/image-builders → image-builders}/api.d.ts +0 -0
- /package/lib/{providers/image-builders → image-builders}/aws-image-builder/common.d.ts +0 -0
- /package/lib/{providers/image-builders → image-builders}/aws-image-builder/delete-ami.lambda.d.ts +0 -0
- /package/lib/{providers/image-builders → image-builders}/aws-image-builder/deprecated/index.d.ts +0 -0
- /package/lib/{providers/image-builders → image-builders}/aws-image-builder/filter-failed-builds.lambda.d.ts +0 -0
- /package/lib/{providers/image-builders → image-builders}/aws-image-builder/index.d.ts +0 -0
- /package/lib/{providers/image-builders → image-builders}/aws-image-builder/versioner.lambda.d.ts +0 -0
- /package/lib/{providers/image-builders → image-builders}/index.d.ts +0 -0
package/.jsii
CHANGED
|
@@ -3114,7 +3114,7 @@
|
|
|
3114
3114
|
"stability": "experimental"
|
|
3115
3115
|
},
|
|
3116
3116
|
"homepage": "https://github.com/CloudSnorkel/cdk-github-runners.git",
|
|
3117
|
-
"jsiiVersion": "5.0.
|
|
3117
|
+
"jsiiVersion": "5.0.5 (build ba9b985)",
|
|
3118
3118
|
"keywords": [
|
|
3119
3119
|
"aws",
|
|
3120
3120
|
"aws-cdk",
|
|
@@ -3138,7 +3138,7 @@
|
|
|
3138
3138
|
},
|
|
3139
3139
|
"name": "@cloudsnorkel/cdk-github-runners",
|
|
3140
3140
|
"readme": {
|
|
3141
|
-
"markdown": "# GitHub Self-Hosted Runners CDK Constructs\n\n[][7]\n[][6]\n[][8]\n[][11]\n[][12]\n[](https://github.com/CloudSnorkel/cdk-github-runners/actions/workflows/release.yml)\n[](https://github.com/CloudSnorkel/cdk-github-runners/blob/main/LICENSE)\n\nUse this CDK construct to create ephemeral [self-hosted GitHub runners][1] on-demand inside your AWS account.\n\n* Easy to configure GitHub integration with a web-based interface\n* Customizable runners with decent defaults\n* Multiple runner configurations controlled by labels\n* Everything fully hosted in your account\n* Automatically updated build environment with latest runner version\n\nSelf-hosted runners in AWS are useful when:\n\n* You need easy access to internal resources in your actions\n* You want to pre-install some software for your actions\n* You want to provide some basic AWS API access (but [aws-actions/configure-aws-credentials][2] has more security controls)\n\nEphemeral (or on-demand) runners are the [recommended way by GitHub][14] for auto-scaling, and they make sure all jobs run with a clean image. Runners are started on-demand. You don't pay unless a job is running.\n\n## API\n\nThe best way to browse API documentation is on [Constructs Hub][13]. It is available in all supported programming languages.\n\n## Providers\n\nA runner provider creates compute resources on-demand and uses [actions/runner][5] to start a runner.\n\n| | EC2 | CodeBuild | Fargate | ECS | Lambda |\n|------------------|-------------------|----------------------------|----------------|----------------|---------------|\n| **Time limit** | Unlimited | 8 hours | Unlimited | Unlimited | 15 minutes |\n| **vCPUs** | Unlimited | 2, 4, 8, or 72 | 0.25 to 4 | Unlimited | 1 to 6 |\n| **RAM** | Unlimited | 3gb, 7gb, 15gb, or 145gb | 512mb to 30gb | Unlimited | 128mb to 10gb |\n| **Storage** | Unlimited | 50gb to 824gb | 20gb to 200gb | Unlimited | Up to 10gb |\n| **Architecture** | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 |\n| **sudo** | ✔ | ✔ | ✔ | ✔ | ❌ |\n| **Docker** | ✔ | ✔ (Linux only) | ❌ | ✔ | ❌ |\n| **Spot pricing** | ✔ | ❌ | ✔ | ✔ | ❌ |\n| **OS** | Linux, Windows | Linux, Windows | Linux, Windows | Linux, Windows | Linux |\n\nThe best provider to use mostly depends on your current infrastructure. When in doubt, CodeBuild is always a good choice. Execution history and logs are easy to view, and it has no restrictive limits unless you need to run for more than 8 hours.\n\n* EC2 is useful when you want runners to have complete access to the host\n* ECS is useful when you want to control the infrastructure, like leaving the runner host running for faster startups\n* Lambda is useful for short jobs that can work within time, size and readonly system constraints\n\nYou can also create your own provider by implementing `IRunnerProvider`.\n\n## Installation\n\n1. Confirm you're using CDK v2\n2. Install the appropriate package\n 1. [Python][6]\n ```\n pip install cloudsnorkel.cdk-github-runners\n ```\n 2. [TypeScript or JavaScript][7]\n ```\n npm i @cloudsnorkel/cdk-github-runners\n ```\n 3. [Java][8]\n ```xml\n <dependency>\n <groupId>com.cloudsnorkel</groupId>\n <artifactId>cdk.github.runners</artifactId>\n </dependency>\n ```\n 4. [Go][11]\n ```\n go get github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners\n ```\n 5. [.NET][12]\n ```\n dotnet add package CloudSnorkel.Cdk.Github.Runners\n ```\n3. Use `GitHubRunners` construct in your code (starting with default arguments is fine)\n4. Deploy your stack\n5. Look for the status command output similar to `aws --region us-east-1 lambda invoke --function-name status-XYZ123 status.json`\n6. Execute the status command (you may need to specify `--profile` too) and open the resulting `status.json` file\n7. Open the URL in `github.setup.url` from `status.json` or [manually setup GitHub](SETUP_GITHUB.md) integration as an app or with personal access token\n8. Run status command again to confirm `github.auth.status` and `github.webhook.status` are OK\n9. Trigger a GitHub action that has a `self-hosted` label with `runs-on: [self-hosted, linux, codebuild]` or similar\n10. If the action is not successful, see [troubleshooting](#Troubleshooting)\n\n[](https://youtu.be/wlyv_3V8lIw)\n\n## Customizing\n\nThe default providers configured by `GitHubRunners` are useful for testing but probably not too much for actual production work. They run in the default VPC or no VPC and have no added IAM permissions. You would usually want to configure the providers yourself.\n\nFor example:\n\n```typescript\nlet vpc: ec2.Vpc;\nlet runnerSg: ec2.SecurityGroup;\nlet dbSg: ec2.SecurityGroup;\nlet bucket: s3.Bucket;\n\n// create a custom CodeBuild provider\nconst myProvider = new CodeBuildRunnerProvider(this, 'codebuild runner', {\n label: 'my-codebuild',\n vpc: vpc,\n securityGroup: runnerSg,\n});\n// grant some permissions to the provider\nbucket.grantReadWrite(myProvider);\ndbSg.connections.allowFrom(runnerSg, ec2.Port.tcp(3306), 'allow runners to connect to MySQL database');\n\n// create the runner infrastructure\nnew GitHubRunners(this, 'runners', {\n providers: [myProvider],\n});\n```\n\nAnother way to customize runners is by modifying the image used to spin them up. The image contains the [runner][5], any required dependencies, and integration code with the provider. You may choose to customize this image by adding more packages, for example.\n\n```typescript\nconst myBuilder = CodeBuildRunnerProvider.imageBuilder(this, 'image builder', {\n dockerfilePath: FargateRunner.LINUX_X64_DOCKERFILE_PATH,\n runnerVersion: RunnerVersion.specific('2.291.0'),\n rebuildInterval: Duration.days(14),\n});\nmyBuilder.addComponent(\n RunnerImageComponent.custom({ commands: ['apt install -y nginx xz-utils'] })\n);\n\nconst myProvider = new FargateRunnerProvider(this, 'fargate runner', {\n label: 'customized-fargate',\n vpc: vpc,\n securityGroup: runnerSg,\n imageBuilder: myBuilder,\n});\n\n// create the runner infrastructure\nnew GitHubRunners(this, 'runners', {\n providers: [myProvider],\n});\n```\n\nYour workflow will then look like:\n\n```yaml\nname: self-hosted example\non: push\njobs:\n self-hosted:\n runs-on: [self-hosted, customized-fargate]\n steps:\n - run: echo hello world\n```\n\nWindows images can also be customized the same way.\n\n```typescript\nconst myWindowsBuilder = FargateRunnerProvider.imageBuilder(this, 'Windows image builder', {\n architecture: Architecture.X86_64,\n os: Os.WINDOWS,\n runnerVersion: RunnerVersion.specific('2.291.0'),\n rebuildInterval: Duration.days(14),\n});\nmyWindowsBuilder.addComponent(\n RunnerImageComponent.custom({\n name: 'Ninja',\n commands: [\n 'Invoke-WebRequest -UseBasicParsing -Uri \"https://github.com/ninja-build/ninja/releases/download/v1.11.1/ninja-win.zip\" -OutFile ninja.zip',\n 'Expand-Archive ninja.zip -DestinationPath C:\\\\actions',\n 'del ninja.zip',\n ],\n })\n);\n\nconst myProvider = new FargateRunnerProvider(this, 'fargate runner', {\n label: 'customized-windows-fargate',\n vpc: vpc,\n securityGroup: runnerSg,\n imageBuidler: myWindowsBuilder,\n});\n\nnew GitHubRunners(this, 'runners', {\n providers: [myProvider],\n});\n```\n\nThe runner OS and architecture is determined by the image it is set to use. For example, to create a Fargate runner provider for ARM64 set the `architecture` property for the image builder to `Architecture.ARM64` in the image builder properties.\n\n```typescript\nnew GitHubRunners(this, 'runners', {\n providers: [\n new FargateRunnerProvider(this, 'fargate runner', {\n labels: ['arm64', 'fargate'],\n imageBuidler: FargateRunnerProvider.imageBuilder(this, 'image builder', {\n architecture: Architecture.ARM64,\n os: Os.LINUX,\n }),\n }),\n ],\n});\n```\n\n## Architecture\n\n\n\n## Troubleshooting\n\n1. Always start with the status function, make sure no errors are reported, and confirm all status codes are OK\n2. If jobs are stuck on pending:\n 1. Make sure `runs-on` in the workflow matches the expected labels set in the runner provider\n 2. If it happens every time, cancel the job and start it again\n4. Confirm the webhook Lambda was called by visiting the URL in `troubleshooting.webhookHandlerUrl` from `status.json`\n 1. If it's not called or logs errors, confirm the webhook settings on the GitHub side\n 2. If you see too many errors, make sure you're only sending `workflow_job` events\n5. When using GitHub app, make sure there are active installation in `github.auth.app.installations`\n6. Check execution details of the orchestrator step function by visiting the URL in `troubleshooting.stepFunctionUrl` from `status.json`\n 1. Use the details tab to find the specific execution of the provider (Lambda, CodeBuild, Fargate, etc.)\n 2. Every step function execution should be successful, even if the runner action inside it failed\n\n## Other Options\n\n1. [philips-labs/terraform-aws-github-runner][3] if you're using Terraform\n2. [actions/actions-runner-controller][4] if you're using Kubernetes\n\n\n[1]: https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners\n[2]: https://github.com/marketplace/actions/configure-aws-credentials-action-for-github-actions\n[3]: https://github.com/philips-labs/terraform-aws-github-runner\n[4]: https://github.com/actions/actions-runner-controller\n[5]: https://github.com/actions/runner\n[6]: https://pypi.org/project/cloudsnorkel.cdk-github-runners\n[7]: https://www.npmjs.com/package/@cloudsnorkel/cdk-github-runners\n[8]: https://search.maven.org/search?q=g:%22com.cloudsnorkel%22%20AND%20a:%22cdk.github.runners%22\n[9]: https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps\n[10]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token\n[11]: https://pkg.go.dev/github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners\n[12]: https://www.nuget.org/packages/CloudSnorkel.Cdk.Github.Runners/\n[13]: https://constructs.dev/packages/@cloudsnorkel/cdk-github-runners/\n[14]: https://docs.github.com/en/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#using-ephemeral-runners-for-autoscaling\n"
|
|
3141
|
+
"markdown": "# GitHub Self-Hosted Runners CDK Constructs\n\n[][7]\n[][6]\n[][8]\n[][11]\n[][12]\n[](https://github.com/CloudSnorkel/cdk-github-runners/actions/workflows/release.yml)\n[](https://github.com/CloudSnorkel/cdk-github-runners/blob/main/LICENSE)\n\nUse this CDK construct to create ephemeral [self-hosted GitHub runners][1] on-demand inside your AWS account.\n\n* Easy to configure GitHub integration with a web-based interface\n* Customizable runners with decent defaults\n* Multiple runner configurations controlled by labels\n* Everything fully hosted in your account\n* Automatically updated build environment with latest runner version\n\nSelf-hosted runners in AWS are useful when:\n\n* You need easy access to internal resources in your actions\n* You want to pre-install some software for your actions\n* You want to provide some basic AWS API access (but [aws-actions/configure-aws-credentials][2] has more security controls)\n* You are using GitHub Enterprise Server\n\nEphemeral (or on-demand) runners are the [recommended way by GitHub][14] for auto-scaling, and they make sure all jobs run with a clean image. Runners are started on-demand. You don't pay unless a job is running.\n\n## API\n\nThe best way to browse API documentation is on [Constructs Hub][13]. It is available in all supported programming languages.\n\n## Providers\n\nA runner provider creates compute resources on-demand and uses [actions/runner][5] to start a runner.\n\n| | EC2 | CodeBuild | Fargate | ECS | Lambda |\n|------------------|-------------------|----------------------------|----------------|----------------|---------------|\n| **Time limit** | Unlimited | 8 hours | Unlimited | Unlimited | 15 minutes |\n| **vCPUs** | Unlimited | 2, 4, 8, or 72 | 0.25 to 4 | Unlimited | 1 to 6 |\n| **RAM** | Unlimited | 3gb, 7gb, 15gb, or 145gb | 512mb to 30gb | Unlimited | 128mb to 10gb |\n| **Storage** | Unlimited | 50gb to 824gb | 20gb to 200gb | Unlimited | Up to 10gb |\n| **Architecture** | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 |\n| **sudo** | ✔ | ✔ | ✔ | ✔ | ❌ |\n| **Docker** | ✔ | ✔ (Linux only) | ❌ | ✔ | ❌ |\n| **Spot pricing** | ✔ | ❌ | ✔ | ✔ | ❌ |\n| **OS** | Linux, Windows | Linux, Windows | Linux, Windows | Linux, Windows | Linux |\n\nThe best provider to use mostly depends on your current infrastructure. When in doubt, CodeBuild is always a good choice. Execution history and logs are easy to view, and it has no restrictive limits unless you need to run for more than 8 hours.\n\n* EC2 is useful when you want runners to have complete access to the host\n* ECS is useful when you want to control the infrastructure, like leaving the runner host running for faster startups\n* Lambda is useful for short jobs that can work within time, size and readonly system constraints\n\nYou can also create your own provider by implementing `IRunnerProvider`.\n\n## Installation\n\n1. Install and use the appropriate package\n <details><summary>Python</summary>\n\n ### Install\n Available on [PyPI][6].\n ```bash\n pip install cloudsnorkel.cdk-github-runners\n ```\n ### Use\n ```python\n from cloudsnorkel.cdk_github_runners import GitHubRunners\n\n GitHubRunners(self, \"runners\")\n ```\n </details>\n <details><summary>TypeScript or JavaScript</summary>\n\n ### Install\n Available on [npm][7].\n ```bash\n npm i @cloudsnorkel/cdk-github-runners\n ```\n ### Use\n ```typescript\n import { GitHubRunners } from '@cloudsnorkel/cdk-github-runners';\n\n new GitHubRunners(this, \"runners\");\n ```\n </details>\n <details><summary>Java</summary>\n\n ### Install\n Available on [Maven][8].\n ```xml\n <dependency>\n <groupId>com.cloudsnorkel</groupId>\n <artifactId>cdk.github.runners</artifactId>\n </dependency>\n ```\n ### Use\n ```java\n import com.cloudsnorkel.cdk.github.runners.GitHubRunners;\n\n GitHubRunners.Builder.create(this, \"runners\").build();\n ```\n </details>\n <details><summary>Go</summary>\n\n ### Install\n Available on [GitHub][11].\n ```bash\n go get github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners\n ```\n ### Use\n ```go\n import \"github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners\"\n\n NewGitHubRunners(this, jsii.String(\"runners\"))\n ```\n </details>\n <details><summary>.NET</summary>\n\n ### Install\n Available on [Nuget][12].\n ```bash\n dotnet add package CloudSnorkel.Cdk.Github.Runners\n ```\n ### Use\n ```csharp\n using CloudSnorkel;\n\n new GitHubRunners(this, \"runners\");\n ```\n </details>\n2. Use `GitHubRunners` construct in your code (starting with default arguments is fine)\n3. Deploy your stack\n4. Look for the status command output similar to `aws --region us-east-1 lambda invoke --function-name status-XYZ123 status.json`\n ```\n ✅ github-runners-test\n\n ✨ Deployment time: 260.01s\n\n Outputs:\n github-runners-test.runnersstatuscommand4A30F0F5 = aws --region us-east-1 lambda invoke --function-name github-runners-test-runnersstatus1A5771C0-mvttg8oPQnQS status.json\n ```\n5. Execute the status command (you may need to specify `--profile` too) and open the resulting `status.json` file\n6. Open the URL in `github.setup.url` from `status.json` or [manually setup GitHub](SETUP_GITHUB.md) integration as an app or with personal access token\n7. Run status command again to confirm `github.auth.status` and `github.webhook.status` are OK\n8. Trigger a GitHub action that has a `self-hosted` label with `runs-on: [self-hosted, linux, codebuild]` or similar\n9. If the action is not successful, see [troubleshooting](#Troubleshooting)\n\n[](https://youtu.be/wlyv_3V8lIw)\n\n## Customizing\n\nThe default providers configured by `GitHubRunners` are useful for testing but probably not too much for actual production work. They run in the default VPC or no VPC and have no added IAM permissions. You would usually want to configure the providers yourself.\n\nFor example:\n\n```typescript\nlet vpc: ec2.Vpc;\nlet runnerSg: ec2.SecurityGroup;\nlet dbSg: ec2.SecurityGroup;\nlet bucket: s3.Bucket;\n\n// create a custom CodeBuild provider\nconst myProvider = new CodeBuildRunnerProvider(this, 'codebuild runner', {\n labels: ['my-codebuild'],\n vpc: vpc,\n securityGroups: [runnerSg],\n});\n// grant some permissions to the provider\nbucket.grantReadWrite(myProvider);\ndbSg.connections.allowFrom(runnerSg, ec2.Port.tcp(3306), 'allow runners to connect to MySQL database');\n\n// create the runner infrastructure\nnew GitHubRunners(this, 'runners', {\n providers: [myProvider],\n});\n```\n\nAnother way to customize runners is by modifying the image used to spin them up. The image contains the [runner][5], any required dependencies, and integration code with the provider. You may choose to customize this image by adding more packages, for example.\n\n```typescript\nconst myBuilder = CodeBuildRunnerProvider.imageBuilder(this, 'image builder', {\n dockerfilePath: FargateRunner.LINUX_X64_DOCKERFILE_PATH,\n runnerVersion: RunnerVersion.specific('2.291.0'),\n rebuildInterval: Duration.days(14),\n});\nmyBuilder.addComponent(\n RunnerImageComponent.custom({ commands: ['apt install -y nginx xz-utils'] })\n);\n\nconst myProvider = new FargateRunnerProvider(this, 'fargate runner', {\n labels: ['customized-fargate'],\n vpc: vpc,\n securityGroups: [runnerSg],\n imageBuilder: myBuilder,\n});\n\n// create the runner infrastructure\nnew GitHubRunners(this, 'runners', {\n providers: [myProvider],\n});\n```\n\nYour workflow will then look like:\n\n```yaml\nname: self-hosted example\non: push\njobs:\n self-hosted:\n runs-on: [self-hosted, customized-fargate]\n steps:\n - run: echo hello world\n```\n\nWindows images can also be customized the same way.\n\n```typescript\nconst myWindowsBuilder = FargateRunnerProvider.imageBuilder(this, 'Windows image builder', {\n architecture: Architecture.X86_64,\n os: Os.WINDOWS,\n runnerVersion: RunnerVersion.specific('2.291.0'),\n rebuildInterval: Duration.days(14),\n});\nmyWindowsBuilder.addComponent(\n RunnerImageComponent.custom({\n name: 'Ninja',\n commands: [\n 'Invoke-WebRequest -UseBasicParsing -Uri \"https://github.com/ninja-build/ninja/releases/download/v1.11.1/ninja-win.zip\" -OutFile ninja.zip',\n 'Expand-Archive ninja.zip -DestinationPath C:\\\\actions',\n 'del ninja.zip',\n ],\n })\n);\n\nconst myProvider = new FargateRunnerProvider(this, 'fargate runner', {\n labels: ['customized-windows-fargate'],\n vpc: vpc,\n securityGroups: [runnerSg],\n imageBuidler: myWindowsBuilder,\n});\n\nnew GitHubRunners(this, 'runners', {\n providers: [myProvider],\n});\n```\n\nThe runner OS and architecture is determined by the image it is set to use. For example, to create a Fargate runner provider for ARM64 set the `architecture` property for the image builder to `Architecture.ARM64` in the image builder properties.\n\n```typescript\nnew GitHubRunners(this, 'runners', {\n providers: [\n new FargateRunnerProvider(this, 'fargate runner', {\n labels: ['arm64', 'fargate'],\n imageBuidler: FargateRunnerProvider.imageBuilder(this, 'image builder', {\n architecture: Architecture.ARM64,\n os: Os.LINUX_UBUNTU,\n }),\n }),\n ],\n});\n```\n\n## Architecture\n\n\n\n## Troubleshooting\n\n1. Always start with the status function, make sure no errors are reported, and confirm all status codes are OK\n2. If jobs are stuck on pending:\n 1. Make sure `runs-on` in the workflow matches the expected labels set in the runner provider\n 2. If jobs get stuck often and take a long time to start, cancel the pending jobs and start them again\n4. Confirm the webhook Lambda was called by visiting the URL in `troubleshooting.webhookHandlerUrl` from `status.json`\n 1. If it's not called or logs errors, confirm the webhook settings on the GitHub side\n 2. If you see too many errors, make sure you're only sending `workflow_job` events\n5. When using GitHub app, make sure there are active installation in `github.auth.app.installations`\n6. Check execution details of the orchestrator step function by visiting the URL in `troubleshooting.stepFunctionUrl` from `status.json`\n 1. Use the details tab to find the specific execution of the provider (Lambda, CodeBuild, Fargate, etc.)\n 2. Every step function execution should be successful, even if the runner action inside it failed\n\n## Monitoring\n\nThere are two important ways to monitor your runners:\n\n1. Make sure runners don't fail to start. When that happens, jobs may sit and wait. Use `GitHubRunners.metricFailed()` to get a metric for the number of failed runner starts. You should use this metric to trigger an alarm.\n2. Make sure runner images don't fail to build. Failed runner image builds mean you will get stuck with out-of-date software on your runners. It may lead to security vulnerabilities, or it may lead to slower runner start-ups as the runner software itself needs to be updated. Use `GitHubRunners.failedImageBuildsTopic()` to get SNS topic that gets notified of failed runner image builds. You should subscribe to this topic.\n\nOther useful metrics to track:\n\n1. Use `GitHubRunners.metricJobCompleted()` to get a metric for the number of completed jobs broken down by labels and job success.\n2. Use `GitHubRunners.metricTime()` to get a metric for the total time a runner is running. This includes the overhead of starting the runner.\n\n## Other Options\n\n1. [philips-labs/terraform-aws-github-runner][3] if you're using Terraform\n2. [actions/actions-runner-controller][4] if you're using Kubernetes\n\n\n[1]: https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners\n[2]: https://github.com/marketplace/actions/configure-aws-credentials-action-for-github-actions\n[3]: https://github.com/philips-labs/terraform-aws-github-runner\n[4]: https://github.com/actions/actions-runner-controller\n[5]: https://github.com/actions/runner\n[6]: https://pypi.org/project/cloudsnorkel.cdk-github-runners\n[7]: https://www.npmjs.com/package/@cloudsnorkel/cdk-github-runners\n[8]: https://central.sonatype.com/artifact/com.cloudsnorkel/cdk.github.runners/\n[9]: https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps\n[10]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token\n[11]: https://pkg.go.dev/github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners\n[12]: https://www.nuget.org/packages/CloudSnorkel.Cdk.Github.Runners/\n[13]: https://constructs.dev/packages/@cloudsnorkel/cdk-github-runners/\n[14]: https://docs.github.com/en/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#using-ephemeral-runners-for-autoscaling\n"
|
|
3142
3142
|
},
|
|
3143
3143
|
"repository": {
|
|
3144
3144
|
"type": "git",
|
|
@@ -3174,7 +3174,7 @@
|
|
|
3174
3174
|
"base": "constructs.Construct",
|
|
3175
3175
|
"docs": {
|
|
3176
3176
|
"deprecated": "use RunnerImageBuilder",
|
|
3177
|
-
"remarks": "Builders can be used with {@link Ec2Runner }.\n\nEach builder re-runs automatically at a set interval to make sure the AMIs contain the latest versions of everything.\n\nYou can create an instance of this construct to customize the AMI used to spin-up runners. Some runner providers may require custom components. Check the runner provider documentation.\n\nFor example, to set a specific runner version, rebuild the image every 2 weeks, and add a few packages for the EC2 provider, use:\n\n```\nconst builder = new AmiBuilder(this, 'Builder', {\n runnerVersion: RunnerVersion.specific('2.293.0'),\n rebuildInterval: Duration.days(14),\n});\nbuilder.addComponent(new ImageBuilderComponent(scope, id, {\n platform: 'Linux',\n displayName: 'p7zip',\n description: 'Install some more packages',\n commands: [\n 'apt-get install p7zip',\n ],\n}));\nnew
|
|
3177
|
+
"remarks": "Builders can be used with {@link Ec2Runner }.\n\nEach builder re-runs automatically at a set interval to make sure the AMIs contain the latest versions of everything.\n\nYou can create an instance of this construct to customize the AMI used to spin-up runners. Some runner providers may require custom components. Check the runner provider documentation.\n\nFor example, to set a specific runner version, rebuild the image every 2 weeks, and add a few packages for the EC2 provider, use:\n\n```\nconst builder = new AmiBuilder(this, 'Builder', {\n runnerVersion: RunnerVersion.specific('2.293.0'),\n rebuildInterval: Duration.days(14),\n});\nbuilder.addComponent(new ImageBuilderComponent(scope, id, {\n platform: 'Linux',\n displayName: 'p7zip',\n description: 'Install some more packages',\n commands: [\n 'apt-get install p7zip',\n ],\n}));\nnew Ec2RunnerProvider(this, 'EC2 provider', {\n labels: ['custom-ec2'],\n amiBuilder: builder,\n});\n```",
|
|
3178
3178
|
"stability": "deprecated",
|
|
3179
3179
|
"summary": "An AMI builder that uses AWS Image Builder to build AMIs pre-baked with all the GitHub Actions runner requirements."
|
|
3180
3180
|
},
|
|
@@ -3184,7 +3184,7 @@
|
|
|
3184
3184
|
"stability": "deprecated"
|
|
3185
3185
|
},
|
|
3186
3186
|
"locationInModule": {
|
|
3187
|
-
"filename": "src/
|
|
3187
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3188
3188
|
"line": 155
|
|
3189
3189
|
},
|
|
3190
3190
|
"parameters": [
|
|
@@ -3214,7 +3214,7 @@
|
|
|
3214
3214
|
],
|
|
3215
3215
|
"kind": "class",
|
|
3216
3216
|
"locationInModule": {
|
|
3217
|
-
"filename": "src/
|
|
3217
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3218
3218
|
"line": 152
|
|
3219
3219
|
},
|
|
3220
3220
|
"methods": [
|
|
@@ -3224,7 +3224,7 @@
|
|
|
3224
3224
|
"summary": "Add a component to be installed."
|
|
3225
3225
|
},
|
|
3226
3226
|
"locationInModule": {
|
|
3227
|
-
"filename": "src/
|
|
3227
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3228
3228
|
"line": 223
|
|
3229
3229
|
},
|
|
3230
3230
|
"name": "addComponent",
|
|
@@ -3244,7 +3244,7 @@
|
|
|
3244
3244
|
"summary": "Add extra trusted certificates."
|
|
3245
3245
|
},
|
|
3246
3246
|
"locationInModule": {
|
|
3247
|
-
"filename": "src/
|
|
3247
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3248
3248
|
"line": 238
|
|
3249
3249
|
},
|
|
3250
3250
|
"name": "addExtraCertificates",
|
|
@@ -3266,7 +3266,7 @@
|
|
|
3266
3266
|
"summary": "Called by IRunnerProvider to finalize settings and create the AMI builder."
|
|
3267
3267
|
},
|
|
3268
3268
|
"locationInModule": {
|
|
3269
|
-
"filename": "src/
|
|
3269
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3270
3270
|
"line": 251
|
|
3271
3271
|
},
|
|
3272
3272
|
"name": "bindAmi",
|
|
@@ -3284,7 +3284,7 @@
|
|
|
3284
3284
|
"summary": "Build and return a Docker image with GitHub Runner installed in it."
|
|
3285
3285
|
},
|
|
3286
3286
|
"locationInModule": {
|
|
3287
|
-
"filename": "src/
|
|
3287
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3288
3288
|
"line": 356
|
|
3289
3289
|
},
|
|
3290
3290
|
"name": "bindDockerImage",
|
|
@@ -3300,7 +3300,7 @@
|
|
|
3300
3300
|
"stability": "deprecated"
|
|
3301
3301
|
},
|
|
3302
3302
|
"locationInModule": {
|
|
3303
|
-
"filename": "src/
|
|
3303
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
3304
3304
|
"line": 126
|
|
3305
3305
|
},
|
|
3306
3306
|
"name": "createImage",
|
|
@@ -3350,7 +3350,7 @@
|
|
|
3350
3350
|
"stability": "deprecated"
|
|
3351
3351
|
},
|
|
3352
3352
|
"locationInModule": {
|
|
3353
|
-
"filename": "src/
|
|
3353
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
3354
3354
|
"line": 97
|
|
3355
3355
|
},
|
|
3356
3356
|
"name": "createInfrastructure",
|
|
@@ -3379,7 +3379,7 @@
|
|
|
3379
3379
|
"stability": "deprecated"
|
|
3380
3380
|
},
|
|
3381
3381
|
"locationInModule": {
|
|
3382
|
-
"filename": "src/
|
|
3382
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
3383
3383
|
"line": 89
|
|
3384
3384
|
},
|
|
3385
3385
|
"name": "createLog",
|
|
@@ -3403,7 +3403,7 @@
|
|
|
3403
3403
|
"stability": "deprecated"
|
|
3404
3404
|
},
|
|
3405
3405
|
"locationInModule": {
|
|
3406
|
-
"filename": "src/
|
|
3406
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
3407
3407
|
"line": 143
|
|
3408
3408
|
},
|
|
3409
3409
|
"name": "createPipeline",
|
|
@@ -3455,7 +3455,7 @@
|
|
|
3455
3455
|
"summary": "Add a component to be installed before any other components."
|
|
3456
3456
|
},
|
|
3457
3457
|
"locationInModule": {
|
|
3458
|
-
"filename": "src/
|
|
3458
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3459
3459
|
"line": 209
|
|
3460
3460
|
},
|
|
3461
3461
|
"name": "prependComponent",
|
|
@@ -3477,7 +3477,7 @@
|
|
|
3477
3477
|
},
|
|
3478
3478
|
"immutable": true,
|
|
3479
3479
|
"locationInModule": {
|
|
3480
|
-
"filename": "src/
|
|
3480
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
3481
3481
|
"line": 12
|
|
3482
3482
|
},
|
|
3483
3483
|
"name": "architecture",
|
|
@@ -3493,7 +3493,7 @@
|
|
|
3493
3493
|
},
|
|
3494
3494
|
"immutable": true,
|
|
3495
3495
|
"locationInModule": {
|
|
3496
|
-
"filename": "src/
|
|
3496
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
3497
3497
|
"line": 173
|
|
3498
3498
|
},
|
|
3499
3499
|
"name": "connections",
|
|
@@ -3507,7 +3507,7 @@
|
|
|
3507
3507
|
},
|
|
3508
3508
|
"immutable": true,
|
|
3509
3509
|
"locationInModule": {
|
|
3510
|
-
"filename": "src/
|
|
3510
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
3511
3511
|
"line": 16
|
|
3512
3512
|
},
|
|
3513
3513
|
"name": "description",
|
|
@@ -3522,7 +3522,7 @@
|
|
|
3522
3522
|
},
|
|
3523
3523
|
"immutable": true,
|
|
3524
3524
|
"locationInModule": {
|
|
3525
|
-
"filename": "src/
|
|
3525
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
3526
3526
|
"line": 13
|
|
3527
3527
|
},
|
|
3528
3528
|
"name": "os",
|
|
@@ -3537,7 +3537,7 @@
|
|
|
3537
3537
|
},
|
|
3538
3538
|
"immutable": true,
|
|
3539
3539
|
"locationInModule": {
|
|
3540
|
-
"filename": "src/
|
|
3540
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
3541
3541
|
"line": 14
|
|
3542
3542
|
},
|
|
3543
3543
|
"name": "platform",
|
|
@@ -3552,7 +3552,7 @@
|
|
|
3552
3552
|
},
|
|
3553
3553
|
"immutable": true,
|
|
3554
3554
|
"locationInModule": {
|
|
3555
|
-
"filename": "src/
|
|
3555
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
3556
3556
|
"line": 18
|
|
3557
3557
|
},
|
|
3558
3558
|
"name": "runnerVersion",
|
|
@@ -3566,7 +3566,7 @@
|
|
|
3566
3566
|
"stability": "deprecated"
|
|
3567
3567
|
},
|
|
3568
3568
|
"locationInModule": {
|
|
3569
|
-
"filename": "src/
|
|
3569
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
3570
3570
|
"line": 20
|
|
3571
3571
|
},
|
|
3572
3572
|
"name": "components",
|
|
@@ -3581,7 +3581,7 @@
|
|
|
3581
3581
|
}
|
|
3582
3582
|
}
|
|
3583
3583
|
],
|
|
3584
|
-
"symbolId": "src/
|
|
3584
|
+
"symbolId": "src/image-builders/aws-image-builder/deprecated/ami:AmiBuilder"
|
|
3585
3585
|
},
|
|
3586
3586
|
"@cloudsnorkel/cdk-github-runners.AmiBuilderProps": {
|
|
3587
3587
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
@@ -3593,7 +3593,7 @@
|
|
|
3593
3593
|
"fqn": "@cloudsnorkel/cdk-github-runners.AmiBuilderProps",
|
|
3594
3594
|
"kind": "interface",
|
|
3595
3595
|
"locationInModule": {
|
|
3596
|
-
"filename": "src/
|
|
3596
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3597
3597
|
"line": 28
|
|
3598
3598
|
},
|
|
3599
3599
|
"name": "AmiBuilderProps",
|
|
@@ -3607,7 +3607,7 @@
|
|
|
3607
3607
|
},
|
|
3608
3608
|
"immutable": true,
|
|
3609
3609
|
"locationInModule": {
|
|
3610
|
-
"filename": "src/
|
|
3610
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3611
3611
|
"line": 34
|
|
3612
3612
|
},
|
|
3613
3613
|
"name": "architecture",
|
|
@@ -3620,13 +3620,12 @@
|
|
|
3620
3620
|
"abstract": true,
|
|
3621
3621
|
"docs": {
|
|
3622
3622
|
"default": "true",
|
|
3623
|
-
"remarks": "You may want to disable this if you are building a Windows image and don't have a Docker Desktop license.",
|
|
3624
3623
|
"stability": "experimental",
|
|
3625
3624
|
"summary": "Install Docker inside the image, so it can be used by the runner."
|
|
3626
3625
|
},
|
|
3627
3626
|
"immutable": true,
|
|
3628
3627
|
"locationInModule": {
|
|
3629
|
-
"filename": "src/
|
|
3628
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3630
3629
|
"line": 119
|
|
3631
3630
|
},
|
|
3632
3631
|
"name": "installDocker",
|
|
@@ -3644,7 +3643,7 @@
|
|
|
3644
3643
|
},
|
|
3645
3644
|
"immutable": true,
|
|
3646
3645
|
"locationInModule": {
|
|
3647
|
-
"filename": "src/
|
|
3646
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3648
3647
|
"line": 94
|
|
3649
3648
|
},
|
|
3650
3649
|
"name": "instanceType",
|
|
@@ -3663,7 +3662,7 @@
|
|
|
3663
3662
|
},
|
|
3664
3663
|
"immutable": true,
|
|
3665
3664
|
"locationInModule": {
|
|
3666
|
-
"filename": "src/
|
|
3665
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3667
3666
|
"line": 112
|
|
3668
3667
|
},
|
|
3669
3668
|
"name": "logRemovalPolicy",
|
|
@@ -3682,7 +3681,7 @@
|
|
|
3682
3681
|
},
|
|
3683
3682
|
"immutable": true,
|
|
3684
3683
|
"locationInModule": {
|
|
3685
|
-
"filename": "src/
|
|
3684
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3686
3685
|
"line": 103
|
|
3687
3686
|
},
|
|
3688
3687
|
"name": "logRetention",
|
|
@@ -3700,7 +3699,7 @@
|
|
|
3700
3699
|
},
|
|
3701
3700
|
"immutable": true,
|
|
3702
3701
|
"locationInModule": {
|
|
3703
|
-
"filename": "src/
|
|
3702
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3704
3703
|
"line": 41
|
|
3705
3704
|
},
|
|
3706
3705
|
"name": "os",
|
|
@@ -3719,7 +3718,7 @@
|
|
|
3719
3718
|
},
|
|
3720
3719
|
"immutable": true,
|
|
3721
3720
|
"locationInModule": {
|
|
3722
|
-
"filename": "src/
|
|
3721
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3723
3722
|
"line": 57
|
|
3724
3723
|
},
|
|
3725
3724
|
"name": "rebuildInterval",
|
|
@@ -3737,7 +3736,7 @@
|
|
|
3737
3736
|
},
|
|
3738
3737
|
"immutable": true,
|
|
3739
3738
|
"locationInModule": {
|
|
3740
|
-
"filename": "src/
|
|
3739
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3741
3740
|
"line": 48
|
|
3742
3741
|
},
|
|
3743
3742
|
"name": "runnerVersion",
|
|
@@ -3756,7 +3755,7 @@
|
|
|
3756
3755
|
},
|
|
3757
3756
|
"immutable": true,
|
|
3758
3757
|
"locationInModule": {
|
|
3759
|
-
"filename": "src/
|
|
3758
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3760
3759
|
"line": 73
|
|
3761
3760
|
},
|
|
3762
3761
|
"name": "securityGroup",
|
|
@@ -3774,7 +3773,7 @@
|
|
|
3774
3773
|
},
|
|
3775
3774
|
"immutable": true,
|
|
3776
3775
|
"locationInModule": {
|
|
3777
|
-
"filename": "src/
|
|
3776
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3778
3777
|
"line": 80
|
|
3779
3778
|
},
|
|
3780
3779
|
"name": "securityGroups",
|
|
@@ -3798,7 +3797,7 @@
|
|
|
3798
3797
|
},
|
|
3799
3798
|
"immutable": true,
|
|
3800
3799
|
"locationInModule": {
|
|
3801
|
-
"filename": "src/
|
|
3800
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3802
3801
|
"line": 87
|
|
3803
3802
|
},
|
|
3804
3803
|
"name": "subnetSelection",
|
|
@@ -3816,7 +3815,7 @@
|
|
|
3816
3815
|
},
|
|
3817
3816
|
"immutable": true,
|
|
3818
3817
|
"locationInModule": {
|
|
3819
|
-
"filename": "src/
|
|
3818
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/ami.ts",
|
|
3820
3819
|
"line": 64
|
|
3821
3820
|
},
|
|
3822
3821
|
"name": "vpc",
|
|
@@ -3826,7 +3825,7 @@
|
|
|
3826
3825
|
}
|
|
3827
3826
|
}
|
|
3828
3827
|
],
|
|
3829
|
-
"symbolId": "src/
|
|
3828
|
+
"symbolId": "src/image-builders/aws-image-builder/deprecated/ami:AmiBuilderProps"
|
|
3830
3829
|
},
|
|
3831
3830
|
"@cloudsnorkel/cdk-github-runners.ApiGatewayAccessProps": {
|
|
3832
3831
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
@@ -4070,8 +4069,8 @@
|
|
|
4070
4069
|
"fqn": "@cloudsnorkel/cdk-github-runners.AwsImageBuilderRunnerImageBuilderProps",
|
|
4071
4070
|
"kind": "interface",
|
|
4072
4071
|
"locationInModule": {
|
|
4073
|
-
"filename": "src/
|
|
4074
|
-
"line":
|
|
4072
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
4073
|
+
"line": 33
|
|
4075
4074
|
},
|
|
4076
4075
|
"name": "AwsImageBuilderRunnerImageBuilderProps",
|
|
4077
4076
|
"properties": [
|
|
@@ -4084,8 +4083,8 @@
|
|
|
4084
4083
|
},
|
|
4085
4084
|
"immutable": true,
|
|
4086
4085
|
"locationInModule": {
|
|
4087
|
-
"filename": "src/
|
|
4088
|
-
"line":
|
|
4086
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
4087
|
+
"line": 39
|
|
4089
4088
|
},
|
|
4090
4089
|
"name": "instanceType",
|
|
4091
4090
|
"optional": true,
|
|
@@ -4094,14 +4093,14 @@
|
|
|
4094
4093
|
}
|
|
4095
4094
|
}
|
|
4096
4095
|
],
|
|
4097
|
-
"symbolId": "src/
|
|
4096
|
+
"symbolId": "src/image-builders/aws-image-builder/builder:AwsImageBuilderRunnerImageBuilderProps"
|
|
4098
4097
|
},
|
|
4099
4098
|
"@cloudsnorkel/cdk-github-runners.CodeBuildImageBuilder": {
|
|
4100
4099
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
4101
4100
|
"base": "constructs.Construct",
|
|
4102
4101
|
"docs": {
|
|
4103
4102
|
"deprecated": "use RunnerImageBuilder",
|
|
4104
|
-
"remarks": "Builders can be used with runner providers.\n\nEach builder re-runs automatically at a set interval to make sure the images contain the latest versions of everything.\n\nYou can create an instance of this construct to customize the image used to spin-up runners. Each provider has its own requirements for what an image should do. That's why they each provide their own Dockerfile.\n\nFor example, to set a specific runner version, rebuild the image every 2 weeks, and add a few packages for the Fargate provider, use:\n\n```\nconst builder = new CodeBuildImageBuilder(this, 'Builder', {\n dockerfilePath:
|
|
4103
|
+
"remarks": "Builders can be used with runner providers.\n\nEach builder re-runs automatically at a set interval to make sure the images contain the latest versions of everything.\n\nYou can create an instance of this construct to customize the image used to spin-up runners. Each provider has its own requirements for what an image should do. That's why they each provide their own Dockerfile.\n\nFor example, to set a specific runner version, rebuild the image every 2 weeks, and add a few packages for the Fargate provider, use:\n\n```\nconst builder = new CodeBuildImageBuilder(this, 'Builder', {\n dockerfilePath: FargateRunnerProvider.LINUX_X64_DOCKERFILE_PATH,\n runnerVersion: RunnerVersion.specific('2.293.0'),\n rebuildInterval: Duration.days(14),\n});\nbuilder.setBuildArg('EXTRA_PACKAGES', 'nginx xz-utils');\nnew FargateRunnerProvider(this, 'Fargate provider', {\n labels: ['customized-fargate'],\n imageBuilder: builder,\n});\n```",
|
|
4105
4104
|
"stability": "deprecated",
|
|
4106
4105
|
"summary": "An image builder that uses CodeBuild to build Docker images pre-baked with all the GitHub Actions runner requirements."
|
|
4107
4106
|
},
|
|
@@ -4111,7 +4110,7 @@
|
|
|
4111
4110
|
"stability": "deprecated"
|
|
4112
4111
|
},
|
|
4113
4112
|
"locationInModule": {
|
|
4114
|
-
"filename": "src/
|
|
4113
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4115
4114
|
"line": 181
|
|
4116
4115
|
},
|
|
4117
4116
|
"parameters": [
|
|
@@ -4140,7 +4139,7 @@
|
|
|
4140
4139
|
],
|
|
4141
4140
|
"kind": "class",
|
|
4142
4141
|
"locationInModule": {
|
|
4143
|
-
"filename": "src/
|
|
4142
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4144
4143
|
"line": 162
|
|
4145
4144
|
},
|
|
4146
4145
|
"methods": [
|
|
@@ -4151,7 +4150,7 @@
|
|
|
4151
4150
|
"summary": "Add extra trusted certificates. This helps deal with self-signed certificates for GitHub Enterprise Server."
|
|
4152
4151
|
},
|
|
4153
4152
|
"locationInModule": {
|
|
4154
|
-
"filename": "src/
|
|
4153
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4155
4154
|
"line": 288
|
|
4156
4155
|
},
|
|
4157
4156
|
"name": "addExtraCertificates",
|
|
@@ -4173,7 +4172,7 @@
|
|
|
4173
4172
|
"summary": "Uploads a folder to the build server at a given folder name."
|
|
4174
4173
|
},
|
|
4175
4174
|
"locationInModule": {
|
|
4176
|
-
"filename": "src/
|
|
4175
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4177
4176
|
"line": 222
|
|
4178
4177
|
},
|
|
4179
4178
|
"name": "addFiles",
|
|
@@ -4204,7 +4203,7 @@
|
|
|
4204
4203
|
"summary": "Add a policy statement to the builder to access resources required to the image build."
|
|
4205
4204
|
},
|
|
4206
4205
|
"locationInModule": {
|
|
4207
|
-
"filename": "src/
|
|
4206
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4208
4207
|
"line": 274
|
|
4209
4208
|
},
|
|
4210
4209
|
"name": "addPolicyStatement",
|
|
@@ -4226,7 +4225,7 @@
|
|
|
4226
4225
|
"summary": "Adds a command that runs after `docker build` and `docker push`."
|
|
4227
4226
|
},
|
|
4228
4227
|
"locationInModule": {
|
|
4229
|
-
"filename": "src/
|
|
4228
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4230
4229
|
"line": 249
|
|
4231
4230
|
},
|
|
4232
4231
|
"name": "addPostBuildCommand",
|
|
@@ -4248,7 +4247,7 @@
|
|
|
4248
4247
|
"summary": "Adds a command that runs before `docker build`."
|
|
4249
4248
|
},
|
|
4250
4249
|
"locationInModule": {
|
|
4251
|
-
"filename": "src/
|
|
4250
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4252
4251
|
"line": 237
|
|
4253
4252
|
},
|
|
4254
4253
|
"name": "addPreBuildCommand",
|
|
@@ -4271,7 +4270,7 @@
|
|
|
4271
4270
|
"summary": "Build and return an AMI with GitHub Runner installed in it."
|
|
4272
4271
|
},
|
|
4273
4272
|
"locationInModule": {
|
|
4274
|
-
"filename": "src/
|
|
4273
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4275
4274
|
"line": 533
|
|
4276
4275
|
},
|
|
4277
4276
|
"name": "bindAmi",
|
|
@@ -4288,7 +4287,7 @@
|
|
|
4288
4287
|
"summary": "Called by IRunnerProvider to finalize settings and create the image builder."
|
|
4289
4288
|
},
|
|
4290
4289
|
"locationInModule": {
|
|
4291
|
-
"filename": "src/
|
|
4290
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4292
4291
|
"line": 298
|
|
4293
4292
|
},
|
|
4294
4293
|
"name": "bindDockerImage",
|
|
@@ -4306,7 +4305,7 @@
|
|
|
4306
4305
|
"summary": "Adds a build argument for Docker."
|
|
4307
4306
|
},
|
|
4308
4307
|
"locationInModule": {
|
|
4309
|
-
"filename": "src/
|
|
4308
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4310
4309
|
"line": 262
|
|
4311
4310
|
},
|
|
4312
4311
|
"name": "setBuildArg",
|
|
@@ -4340,7 +4339,7 @@
|
|
|
4340
4339
|
},
|
|
4341
4340
|
"immutable": true,
|
|
4342
4341
|
"locationInModule": {
|
|
4343
|
-
"filename": "src/
|
|
4342
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4344
4343
|
"line": 527
|
|
4345
4344
|
},
|
|
4346
4345
|
"name": "connections",
|
|
@@ -4354,7 +4353,7 @@
|
|
|
4354
4353
|
},
|
|
4355
4354
|
"immutable": true,
|
|
4356
4355
|
"locationInModule": {
|
|
4357
|
-
"filename": "src/
|
|
4356
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4358
4357
|
"line": 181
|
|
4359
4358
|
},
|
|
4360
4359
|
"name": "props",
|
|
@@ -4363,7 +4362,7 @@
|
|
|
4363
4362
|
}
|
|
4364
4363
|
}
|
|
4365
4364
|
],
|
|
4366
|
-
"symbolId": "src/
|
|
4365
|
+
"symbolId": "src/image-builders/codebuild-deprecated:CodeBuildImageBuilder"
|
|
4367
4366
|
},
|
|
4368
4367
|
"@cloudsnorkel/cdk-github-runners.CodeBuildImageBuilderProps": {
|
|
4369
4368
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
@@ -4375,7 +4374,7 @@
|
|
|
4375
4374
|
"fqn": "@cloudsnorkel/cdk-github-runners.CodeBuildImageBuilderProps",
|
|
4376
4375
|
"kind": "interface",
|
|
4377
4376
|
"locationInModule": {
|
|
4378
|
-
"filename": "src/
|
|
4377
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4379
4378
|
"line": 36
|
|
4380
4379
|
},
|
|
4381
4380
|
"name": "CodeBuildImageBuilderProps",
|
|
@@ -4389,7 +4388,7 @@
|
|
|
4389
4388
|
},
|
|
4390
4389
|
"immutable": true,
|
|
4391
4390
|
"locationInModule": {
|
|
4392
|
-
"filename": "src/
|
|
4391
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4393
4392
|
"line": 54
|
|
4394
4393
|
},
|
|
4395
4394
|
"name": "dockerfilePath",
|
|
@@ -4406,7 +4405,7 @@
|
|
|
4406
4405
|
},
|
|
4407
4406
|
"immutable": true,
|
|
4408
4407
|
"locationInModule": {
|
|
4409
|
-
"filename": "src/
|
|
4408
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4410
4409
|
"line": 42
|
|
4411
4410
|
},
|
|
4412
4411
|
"name": "architecture",
|
|
@@ -4418,14 +4417,14 @@
|
|
|
4418
4417
|
{
|
|
4419
4418
|
"abstract": true,
|
|
4420
4419
|
"docs": {
|
|
4421
|
-
"default": "Ubuntu
|
|
4420
|
+
"default": "Ubuntu 22.04 for x64 and Amazon Linux 2 for ARM64",
|
|
4422
4421
|
"remarks": "This is the image that's going to run the code that builds the runner image.\n\nThe only action taken in CodeBuild is running `docker build`. You would therefore not need to change this setting often.",
|
|
4423
4422
|
"stability": "experimental",
|
|
4424
4423
|
"summary": "Build image to use in CodeBuild."
|
|
4425
4424
|
},
|
|
4426
4425
|
"immutable": true,
|
|
4427
4426
|
"locationInModule": {
|
|
4428
|
-
"filename": "src/
|
|
4427
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4429
4428
|
"line": 108
|
|
4430
4429
|
},
|
|
4431
4430
|
"name": "buildImage",
|
|
@@ -4444,7 +4443,7 @@
|
|
|
4444
4443
|
},
|
|
4445
4444
|
"immutable": true,
|
|
4446
4445
|
"locationInModule": {
|
|
4447
|
-
"filename": "src/
|
|
4446
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4448
4447
|
"line": 99
|
|
4449
4448
|
},
|
|
4450
4449
|
"name": "computeType",
|
|
@@ -4463,7 +4462,7 @@
|
|
|
4463
4462
|
},
|
|
4464
4463
|
"immutable": true,
|
|
4465
4464
|
"locationInModule": {
|
|
4466
|
-
"filename": "src/
|
|
4465
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4467
4466
|
"line": 135
|
|
4468
4467
|
},
|
|
4469
4468
|
"name": "logRemovalPolicy",
|
|
@@ -4482,7 +4481,7 @@
|
|
|
4482
4481
|
},
|
|
4483
4482
|
"immutable": true,
|
|
4484
4483
|
"locationInModule": {
|
|
4485
|
-
"filename": "src/
|
|
4484
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4486
4485
|
"line": 126
|
|
4487
4486
|
},
|
|
4488
4487
|
"name": "logRetention",
|
|
@@ -4500,7 +4499,7 @@
|
|
|
4500
4499
|
},
|
|
4501
4500
|
"immutable": true,
|
|
4502
4501
|
"locationInModule": {
|
|
4503
|
-
"filename": "src/
|
|
4502
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4504
4503
|
"line": 49
|
|
4505
4504
|
},
|
|
4506
4505
|
"name": "os",
|
|
@@ -4519,7 +4518,7 @@
|
|
|
4519
4518
|
},
|
|
4520
4519
|
"immutable": true,
|
|
4521
4520
|
"locationInModule": {
|
|
4522
|
-
"filename": "src/
|
|
4521
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4523
4522
|
"line": 70
|
|
4524
4523
|
},
|
|
4525
4524
|
"name": "rebuildInterval",
|
|
@@ -4537,7 +4536,7 @@
|
|
|
4537
4536
|
},
|
|
4538
4537
|
"immutable": true,
|
|
4539
4538
|
"locationInModule": {
|
|
4540
|
-
"filename": "src/
|
|
4539
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4541
4540
|
"line": 61
|
|
4542
4541
|
},
|
|
4543
4542
|
"name": "runnerVersion",
|
|
@@ -4555,7 +4554,7 @@
|
|
|
4555
4554
|
},
|
|
4556
4555
|
"immutable": true,
|
|
4557
4556
|
"locationInModule": {
|
|
4558
|
-
"filename": "src/
|
|
4557
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4559
4558
|
"line": 84
|
|
4560
4559
|
},
|
|
4561
4560
|
"name": "securityGroup",
|
|
@@ -4573,7 +4572,7 @@
|
|
|
4573
4572
|
},
|
|
4574
4573
|
"immutable": true,
|
|
4575
4574
|
"locationInModule": {
|
|
4576
|
-
"filename": "src/
|
|
4575
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4577
4576
|
"line": 91
|
|
4578
4577
|
},
|
|
4579
4578
|
"name": "subnetSelection",
|
|
@@ -4592,7 +4591,7 @@
|
|
|
4592
4591
|
},
|
|
4593
4592
|
"immutable": true,
|
|
4594
4593
|
"locationInModule": {
|
|
4595
|
-
"filename": "src/
|
|
4594
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4596
4595
|
"line": 117
|
|
4597
4596
|
},
|
|
4598
4597
|
"name": "timeout",
|
|
@@ -4610,7 +4609,7 @@
|
|
|
4610
4609
|
},
|
|
4611
4610
|
"immutable": true,
|
|
4612
4611
|
"locationInModule": {
|
|
4613
|
-
"filename": "src/
|
|
4612
|
+
"filename": "src/image-builders/codebuild-deprecated.ts",
|
|
4614
4613
|
"line": 77
|
|
4615
4614
|
},
|
|
4616
4615
|
"name": "vpc",
|
|
@@ -4620,7 +4619,7 @@
|
|
|
4620
4619
|
}
|
|
4621
4620
|
}
|
|
4622
4621
|
],
|
|
4623
|
-
"symbolId": "src/
|
|
4622
|
+
"symbolId": "src/image-builders/codebuild-deprecated:CodeBuildImageBuilderProps"
|
|
4624
4623
|
},
|
|
4625
4624
|
"@cloudsnorkel/cdk-github-runners.CodeBuildRunner": {
|
|
4626
4625
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
@@ -4677,7 +4676,7 @@
|
|
|
4677
4676
|
"fqn": "@cloudsnorkel/cdk-github-runners.CodeBuildRunnerImageBuilderProps",
|
|
4678
4677
|
"kind": "interface",
|
|
4679
4678
|
"locationInModule": {
|
|
4680
|
-
"filename": "src/
|
|
4679
|
+
"filename": "src/image-builders/codebuild.ts",
|
|
4681
4680
|
"line": 28
|
|
4682
4681
|
},
|
|
4683
4682
|
"name": "CodeBuildRunnerImageBuilderProps",
|
|
@@ -4685,14 +4684,14 @@
|
|
|
4685
4684
|
{
|
|
4686
4685
|
"abstract": true,
|
|
4687
4686
|
"docs": {
|
|
4688
|
-
"default": "Ubuntu
|
|
4687
|
+
"default": "Ubuntu 22.04 for x64 and Amazon Linux 2 for ARM64",
|
|
4689
4688
|
"remarks": "This is the image that's going to run the code that builds the runner image.\n\nThe only action taken in CodeBuild is running `docker build`. You would therefore not need to change this setting often.",
|
|
4690
4689
|
"stability": "experimental",
|
|
4691
4690
|
"summary": "Build image to use in CodeBuild."
|
|
4692
4691
|
},
|
|
4693
4692
|
"immutable": true,
|
|
4694
4693
|
"locationInModule": {
|
|
4695
|
-
"filename": "src/
|
|
4694
|
+
"filename": "src/image-builders/codebuild.ts",
|
|
4696
4695
|
"line": 44
|
|
4697
4696
|
},
|
|
4698
4697
|
"name": "buildImage",
|
|
@@ -4711,7 +4710,7 @@
|
|
|
4711
4710
|
},
|
|
4712
4711
|
"immutable": true,
|
|
4713
4712
|
"locationInModule": {
|
|
4714
|
-
"filename": "src/
|
|
4713
|
+
"filename": "src/image-builders/codebuild.ts",
|
|
4715
4714
|
"line": 35
|
|
4716
4715
|
},
|
|
4717
4716
|
"name": "computeType",
|
|
@@ -4730,7 +4729,7 @@
|
|
|
4730
4729
|
},
|
|
4731
4730
|
"immutable": true,
|
|
4732
4731
|
"locationInModule": {
|
|
4733
|
-
"filename": "src/
|
|
4732
|
+
"filename": "src/image-builders/codebuild.ts",
|
|
4734
4733
|
"line": 53
|
|
4735
4734
|
},
|
|
4736
4735
|
"name": "timeout",
|
|
@@ -4740,7 +4739,7 @@
|
|
|
4740
4739
|
}
|
|
4741
4740
|
}
|
|
4742
4741
|
],
|
|
4743
|
-
"symbolId": "src/
|
|
4742
|
+
"symbolId": "src/image-builders/codebuild:CodeBuildRunnerImageBuilderProps"
|
|
4744
4743
|
},
|
|
4745
4744
|
"@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProvider": {
|
|
4746
4745
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
@@ -5359,7 +5358,7 @@
|
|
|
5359
5358
|
"base": "constructs.Construct",
|
|
5360
5359
|
"docs": {
|
|
5361
5360
|
"deprecated": "use RunnerImageBuilder",
|
|
5362
|
-
"remarks": "Builders can be used with runner providers.\n\nThe CodeBuild builder is better and faster. Only use this one if you have no choice. For example, if you need Windows containers.\n\nEach builder re-runs automatically at a set interval to make sure the images contain the latest versions of everything.\n\nYou can create an instance of this construct to customize the image used to spin-up runners. Some runner providers may require custom components. Check the runner provider documentation. The default components work with CodeBuild and Fargate.\n\nFor example, to set a specific runner version, rebuild the image every 2 weeks, and add a few packages for the Fargate provider, use:\n\n```\nconst builder = new ContainerImageBuilder(this, 'Builder', {\n runnerVersion: RunnerVersion.specific('2.293.0'),\n rebuildInterval: Duration.days(14),\n});\nnew
|
|
5361
|
+
"remarks": "Builders can be used with runner providers.\n\nThe CodeBuild builder is better and faster. Only use this one if you have no choice. For example, if you need Windows containers.\n\nEach builder re-runs automatically at a set interval to make sure the images contain the latest versions of everything.\n\nYou can create an instance of this construct to customize the image used to spin-up runners. Some runner providers may require custom components. Check the runner provider documentation. The default components work with CodeBuild and Fargate.\n\nFor example, to set a specific runner version, rebuild the image every 2 weeks, and add a few packages for the Fargate provider, use:\n\n```\nconst builder = new ContainerImageBuilder(this, 'Builder', {\n runnerVersion: RunnerVersion.specific('2.293.0'),\n rebuildInterval: Duration.days(14),\n});\nnew CodeBuildRunnerProvider(this, 'CodeBuild provider', {\n labels: ['custom-codebuild'],\n imageBuilder: builder,\n});\n```",
|
|
5363
5362
|
"stability": "deprecated",
|
|
5364
5363
|
"summary": "An image builder that uses AWS Image Builder to build Docker images pre-baked with all the GitHub Actions runner requirements."
|
|
5365
5364
|
},
|
|
@@ -5369,7 +5368,7 @@
|
|
|
5369
5368
|
"stability": "deprecated"
|
|
5370
5369
|
},
|
|
5371
5370
|
"locationInModule": {
|
|
5372
|
-
"filename": "src/
|
|
5371
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5373
5372
|
"line": 156
|
|
5374
5373
|
},
|
|
5375
5374
|
"parameters": [
|
|
@@ -5399,7 +5398,7 @@
|
|
|
5399
5398
|
],
|
|
5400
5399
|
"kind": "class",
|
|
5401
5400
|
"locationInModule": {
|
|
5402
|
-
"filename": "src/
|
|
5401
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5403
5402
|
"line": 151
|
|
5404
5403
|
},
|
|
5405
5404
|
"methods": [
|
|
@@ -5409,7 +5408,7 @@
|
|
|
5409
5408
|
"summary": "Add a component to be installed."
|
|
5410
5409
|
},
|
|
5411
5410
|
"locationInModule": {
|
|
5412
|
-
"filename": "src/
|
|
5411
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5413
5412
|
"line": 218
|
|
5414
5413
|
},
|
|
5415
5414
|
"name": "addComponent",
|
|
@@ -5429,7 +5428,7 @@
|
|
|
5429
5428
|
"summary": "Add extra trusted certificates. This helps deal with self-signed certificates for GitHub Enterprise Server."
|
|
5430
5429
|
},
|
|
5431
5430
|
"locationInModule": {
|
|
5432
|
-
"filename": "src/
|
|
5431
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5433
5432
|
"line": 235
|
|
5434
5433
|
},
|
|
5435
5434
|
"name": "addExtraCertificates",
|
|
@@ -5452,7 +5451,7 @@
|
|
|
5452
5451
|
"summary": "Build and return an AMI with GitHub Runner installed in it."
|
|
5453
5452
|
},
|
|
5454
5453
|
"locationInModule": {
|
|
5455
|
-
"filename": "src/
|
|
5454
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5456
5455
|
"line": 345
|
|
5457
5456
|
},
|
|
5458
5457
|
"name": "bindAmi",
|
|
@@ -5469,7 +5468,7 @@
|
|
|
5469
5468
|
"summary": "Called by IRunnerProvider to finalize settings and create the image builder."
|
|
5470
5469
|
},
|
|
5471
5470
|
"locationInModule": {
|
|
5472
|
-
"filename": "src/
|
|
5471
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5473
5472
|
"line": 248
|
|
5474
5473
|
},
|
|
5475
5474
|
"name": "bindDockerImage",
|
|
@@ -5485,7 +5484,7 @@
|
|
|
5485
5484
|
"stability": "deprecated"
|
|
5486
5485
|
},
|
|
5487
5486
|
"locationInModule": {
|
|
5488
|
-
"filename": "src/
|
|
5487
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
5489
5488
|
"line": 126
|
|
5490
5489
|
},
|
|
5491
5490
|
"name": "createImage",
|
|
@@ -5535,7 +5534,7 @@
|
|
|
5535
5534
|
"stability": "deprecated"
|
|
5536
5535
|
},
|
|
5537
5536
|
"locationInModule": {
|
|
5538
|
-
"filename": "src/
|
|
5537
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
5539
5538
|
"line": 97
|
|
5540
5539
|
},
|
|
5541
5540
|
"name": "createInfrastructure",
|
|
@@ -5564,7 +5563,7 @@
|
|
|
5564
5563
|
"stability": "deprecated"
|
|
5565
5564
|
},
|
|
5566
5565
|
"locationInModule": {
|
|
5567
|
-
"filename": "src/
|
|
5566
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
5568
5567
|
"line": 89
|
|
5569
5568
|
},
|
|
5570
5569
|
"name": "createLog",
|
|
@@ -5588,7 +5587,7 @@
|
|
|
5588
5587
|
"stability": "deprecated"
|
|
5589
5588
|
},
|
|
5590
5589
|
"locationInModule": {
|
|
5591
|
-
"filename": "src/
|
|
5590
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
5592
5591
|
"line": 143
|
|
5593
5592
|
},
|
|
5594
5593
|
"name": "createPipeline",
|
|
@@ -5640,7 +5639,7 @@
|
|
|
5640
5639
|
"summary": "Add a component to be installed before any other components."
|
|
5641
5640
|
},
|
|
5642
5641
|
"locationInModule": {
|
|
5643
|
-
"filename": "src/
|
|
5642
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5644
5643
|
"line": 204
|
|
5645
5644
|
},
|
|
5646
5645
|
"name": "prependComponent",
|
|
@@ -5662,7 +5661,7 @@
|
|
|
5662
5661
|
},
|
|
5663
5662
|
"immutable": true,
|
|
5664
5663
|
"locationInModule": {
|
|
5665
|
-
"filename": "src/
|
|
5664
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
5666
5665
|
"line": 12
|
|
5667
5666
|
},
|
|
5668
5667
|
"name": "architecture",
|
|
@@ -5678,7 +5677,7 @@
|
|
|
5678
5677
|
},
|
|
5679
5678
|
"immutable": true,
|
|
5680
5679
|
"locationInModule": {
|
|
5681
|
-
"filename": "src/
|
|
5680
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
5682
5681
|
"line": 173
|
|
5683
5682
|
},
|
|
5684
5683
|
"name": "connections",
|
|
@@ -5692,7 +5691,7 @@
|
|
|
5692
5691
|
},
|
|
5693
5692
|
"immutable": true,
|
|
5694
5693
|
"locationInModule": {
|
|
5695
|
-
"filename": "src/
|
|
5694
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
5696
5695
|
"line": 16
|
|
5697
5696
|
},
|
|
5698
5697
|
"name": "description",
|
|
@@ -5707,7 +5706,7 @@
|
|
|
5707
5706
|
},
|
|
5708
5707
|
"immutable": true,
|
|
5709
5708
|
"locationInModule": {
|
|
5710
|
-
"filename": "src/
|
|
5709
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
5711
5710
|
"line": 13
|
|
5712
5711
|
},
|
|
5713
5712
|
"name": "os",
|
|
@@ -5722,7 +5721,7 @@
|
|
|
5722
5721
|
},
|
|
5723
5722
|
"immutable": true,
|
|
5724
5723
|
"locationInModule": {
|
|
5725
|
-
"filename": "src/
|
|
5724
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
5726
5725
|
"line": 14
|
|
5727
5726
|
},
|
|
5728
5727
|
"name": "platform",
|
|
@@ -5737,7 +5736,7 @@
|
|
|
5737
5736
|
},
|
|
5738
5737
|
"immutable": true,
|
|
5739
5738
|
"locationInModule": {
|
|
5740
|
-
"filename": "src/
|
|
5739
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5741
5740
|
"line": 152
|
|
5742
5741
|
},
|
|
5743
5742
|
"name": "repository",
|
|
@@ -5751,7 +5750,7 @@
|
|
|
5751
5750
|
},
|
|
5752
5751
|
"immutable": true,
|
|
5753
5752
|
"locationInModule": {
|
|
5754
|
-
"filename": "src/
|
|
5753
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
5755
5754
|
"line": 18
|
|
5756
5755
|
},
|
|
5757
5756
|
"name": "runnerVersion",
|
|
@@ -5765,7 +5764,7 @@
|
|
|
5765
5764
|
"stability": "deprecated"
|
|
5766
5765
|
},
|
|
5767
5766
|
"locationInModule": {
|
|
5768
|
-
"filename": "src/
|
|
5767
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/common.ts",
|
|
5769
5768
|
"line": 20
|
|
5770
5769
|
},
|
|
5771
5770
|
"name": "components",
|
|
@@ -5780,7 +5779,7 @@
|
|
|
5780
5779
|
}
|
|
5781
5780
|
}
|
|
5782
5781
|
],
|
|
5783
|
-
"symbolId": "src/
|
|
5782
|
+
"symbolId": "src/image-builders/aws-image-builder/deprecated/container:ContainerImageBuilder"
|
|
5784
5783
|
},
|
|
5785
5784
|
"@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps": {
|
|
5786
5785
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
@@ -5792,7 +5791,7 @@
|
|
|
5792
5791
|
"fqn": "@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps",
|
|
5793
5792
|
"kind": "interface",
|
|
5794
5793
|
"locationInModule": {
|
|
5795
|
-
"filename": "src/
|
|
5794
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5796
5795
|
"line": 33
|
|
5797
5796
|
},
|
|
5798
5797
|
"name": "ContainerImageBuilderProps",
|
|
@@ -5806,7 +5805,7 @@
|
|
|
5806
5805
|
},
|
|
5807
5806
|
"immutable": true,
|
|
5808
5807
|
"locationInModule": {
|
|
5809
|
-
"filename": "src/
|
|
5808
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5810
5809
|
"line": 39
|
|
5811
5810
|
},
|
|
5812
5811
|
"name": "architecture",
|
|
@@ -5824,7 +5823,7 @@
|
|
|
5824
5823
|
},
|
|
5825
5824
|
"immutable": true,
|
|
5826
5825
|
"locationInModule": {
|
|
5827
|
-
"filename": "src/
|
|
5826
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5828
5827
|
"line": 106
|
|
5829
5828
|
},
|
|
5830
5829
|
"name": "instanceType",
|
|
@@ -5843,7 +5842,7 @@
|
|
|
5843
5842
|
},
|
|
5844
5843
|
"immutable": true,
|
|
5845
5844
|
"locationInModule": {
|
|
5846
|
-
"filename": "src/
|
|
5845
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5847
5846
|
"line": 124
|
|
5848
5847
|
},
|
|
5849
5848
|
"name": "logRemovalPolicy",
|
|
@@ -5862,7 +5861,7 @@
|
|
|
5862
5861
|
},
|
|
5863
5862
|
"immutable": true,
|
|
5864
5863
|
"locationInModule": {
|
|
5865
|
-
"filename": "src/
|
|
5864
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5866
5865
|
"line": 115
|
|
5867
5866
|
},
|
|
5868
5867
|
"name": "logRetention",
|
|
@@ -5880,7 +5879,7 @@
|
|
|
5880
5879
|
},
|
|
5881
5880
|
"immutable": true,
|
|
5882
5881
|
"locationInModule": {
|
|
5883
|
-
"filename": "src/
|
|
5882
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5884
5883
|
"line": 46
|
|
5885
5884
|
},
|
|
5886
5885
|
"name": "os",
|
|
@@ -5899,7 +5898,7 @@
|
|
|
5899
5898
|
},
|
|
5900
5899
|
"immutable": true,
|
|
5901
5900
|
"locationInModule": {
|
|
5902
|
-
"filename": "src/
|
|
5901
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5903
5902
|
"line": 53
|
|
5904
5903
|
},
|
|
5905
5904
|
"name": "parentImage",
|
|
@@ -5918,7 +5917,7 @@
|
|
|
5918
5917
|
},
|
|
5919
5918
|
"immutable": true,
|
|
5920
5919
|
"locationInModule": {
|
|
5921
|
-
"filename": "src/
|
|
5920
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5922
5921
|
"line": 69
|
|
5923
5922
|
},
|
|
5924
5923
|
"name": "rebuildInterval",
|
|
@@ -5936,7 +5935,7 @@
|
|
|
5936
5935
|
},
|
|
5937
5936
|
"immutable": true,
|
|
5938
5937
|
"locationInModule": {
|
|
5939
|
-
"filename": "src/
|
|
5938
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5940
5939
|
"line": 60
|
|
5941
5940
|
},
|
|
5942
5941
|
"name": "runnerVersion",
|
|
@@ -5955,7 +5954,7 @@
|
|
|
5955
5954
|
},
|
|
5956
5955
|
"immutable": true,
|
|
5957
5956
|
"locationInModule": {
|
|
5958
|
-
"filename": "src/
|
|
5957
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5959
5958
|
"line": 85
|
|
5960
5959
|
},
|
|
5961
5960
|
"name": "securityGroup",
|
|
@@ -5973,7 +5972,7 @@
|
|
|
5973
5972
|
},
|
|
5974
5973
|
"immutable": true,
|
|
5975
5974
|
"locationInModule": {
|
|
5976
|
-
"filename": "src/
|
|
5975
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
5977
5976
|
"line": 92
|
|
5978
5977
|
},
|
|
5979
5978
|
"name": "securityGroups",
|
|
@@ -5996,7 +5995,7 @@
|
|
|
5996
5995
|
},
|
|
5997
5996
|
"immutable": true,
|
|
5998
5997
|
"locationInModule": {
|
|
5999
|
-
"filename": "src/
|
|
5998
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
6000
5999
|
"line": 99
|
|
6001
6000
|
},
|
|
6002
6001
|
"name": "subnetSelection",
|
|
@@ -6014,7 +6013,7 @@
|
|
|
6014
6013
|
},
|
|
6015
6014
|
"immutable": true,
|
|
6016
6015
|
"locationInModule": {
|
|
6017
|
-
"filename": "src/
|
|
6016
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/container.ts",
|
|
6018
6017
|
"line": 76
|
|
6019
6018
|
},
|
|
6020
6019
|
"name": "vpc",
|
|
@@ -6024,7 +6023,7 @@
|
|
|
6024
6023
|
}
|
|
6025
6024
|
}
|
|
6026
6025
|
],
|
|
6027
|
-
"symbolId": "src/
|
|
6026
|
+
"symbolId": "src/image-builders/aws-image-builder/deprecated/container:ContainerImageBuilderProps"
|
|
6028
6027
|
},
|
|
6029
6028
|
"@cloudsnorkel/cdk-github-runners.Ec2Runner": {
|
|
6030
6029
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
@@ -6436,7 +6435,7 @@
|
|
|
6436
6435
|
{
|
|
6437
6436
|
"abstract": true,
|
|
6438
6437
|
"docs": {
|
|
6439
|
-
"default": "
|
|
6438
|
+
"default": "Ec2RunnerProvider.imageBuilder()",
|
|
6440
6439
|
"remarks": "The image builder determines the OS and architecture of the runner.",
|
|
6441
6440
|
"stability": "experimental",
|
|
6442
6441
|
"summary": "Runner image builder used to build AMI containing GitHub Runner and all requirements."
|
|
@@ -8116,7 +8115,7 @@
|
|
|
8116
8115
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
8117
8116
|
"base": "constructs.Construct",
|
|
8118
8117
|
"docs": {
|
|
8119
|
-
"remarks": "It creates a webhook, secrets, and a step function to orchestrate all runs. Secrets are not automatically filled. See README.md for instructions on how to setup GitHub integration.\n\nBy default, this will create a runner provider of each available type with the defaults. This is good enough for the initial setup stage when you just want to get GitHub integration working.\n\n```typescript\nnew GitHubRunners(this, 'runners');\n```\n\nUsually you'd want to configure the runner providers so the runners can run in a certain VPC or have certain permissions.\n\n```typescript\nconst vpc = ec2.Vpc.fromLookup(this, 'vpc', { vpcId: 'vpc-1234567' });\nconst runnerSg = new ec2.SecurityGroup(this, 'runner security group', { vpc: vpc });\nconst dbSg = ec2.SecurityGroup.fromSecurityGroupId(this, 'database security group', 'sg-1234567');\nconst bucket = new s3.Bucket(this, 'runner bucket');\n\n// create a custom CodeBuild provider\nconst myProvider = new
|
|
8118
|
+
"remarks": "It creates a webhook, secrets, and a step function to orchestrate all runs. Secrets are not automatically filled. See README.md for instructions on how to setup GitHub integration.\n\nBy default, this will create a runner provider of each available type with the defaults. This is good enough for the initial setup stage when you just want to get GitHub integration working.\n\n```typescript\nnew GitHubRunners(this, 'runners');\n```\n\nUsually you'd want to configure the runner providers so the runners can run in a certain VPC or have certain permissions.\n\n```typescript\nconst vpc = ec2.Vpc.fromLookup(this, 'vpc', { vpcId: 'vpc-1234567' });\nconst runnerSg = new ec2.SecurityGroup(this, 'runner security group', { vpc: vpc });\nconst dbSg = ec2.SecurityGroup.fromSecurityGroupId(this, 'database security group', 'sg-1234567');\nconst bucket = new s3.Bucket(this, 'runner bucket');\n\n// create a custom CodeBuild provider\nconst myProvider = new CodeBuildRunnerProvider(\n this, 'codebuild runner',\n {\n labels: ['my-codebuild'],\n vpc: vpc,\n securityGroups: [runnerSg],\n },\n);\n// grant some permissions to the provider\nbucket.grantReadWrite(myProvider);\ndbSg.connections.allowFrom(runnerSg, ec2.Port.tcp(3306), 'allow runners to connect to MySQL database');\n\n// create the runner infrastructure\nnew GitHubRunners(\n this,\n 'runners',\n {\n providers: [myProvider],\n }\n);\n```",
|
|
8120
8119
|
"stability": "experimental",
|
|
8121
8120
|
"summary": "Create all the required infrastructure to provide self-hosted GitHub runners."
|
|
8122
8121
|
},
|
|
@@ -8621,8 +8620,8 @@
|
|
|
8621
8620
|
"fqn": "@cloudsnorkel/cdk-github-runners.IRunnerImageBuilder",
|
|
8622
8621
|
"kind": "interface",
|
|
8623
8622
|
"locationInModule": {
|
|
8624
|
-
"filename": "src/
|
|
8625
|
-
"line":
|
|
8623
|
+
"filename": "src/image-builders/common.ts",
|
|
8624
|
+
"line": 259
|
|
8626
8625
|
},
|
|
8627
8626
|
"methods": [
|
|
8628
8627
|
{
|
|
@@ -8633,8 +8632,8 @@
|
|
|
8633
8632
|
"summary": "Build and return an AMI with GitHub Runner installed in it."
|
|
8634
8633
|
},
|
|
8635
8634
|
"locationInModule": {
|
|
8636
|
-
"filename": "src/
|
|
8637
|
-
"line":
|
|
8635
|
+
"filename": "src/image-builders/common.ts",
|
|
8636
|
+
"line": 278
|
|
8638
8637
|
},
|
|
8639
8638
|
"name": "bindAmi",
|
|
8640
8639
|
"returns": {
|
|
@@ -8651,8 +8650,8 @@
|
|
|
8651
8650
|
"summary": "Build and return a Docker image with GitHub Runner installed in it."
|
|
8652
8651
|
},
|
|
8653
8652
|
"locationInModule": {
|
|
8654
|
-
"filename": "src/
|
|
8655
|
-
"line":
|
|
8653
|
+
"filename": "src/image-builders/common.ts",
|
|
8654
|
+
"line": 269
|
|
8656
8655
|
},
|
|
8657
8656
|
"name": "bindDockerImage",
|
|
8658
8657
|
"returns": {
|
|
@@ -8663,7 +8662,7 @@
|
|
|
8663
8662
|
}
|
|
8664
8663
|
],
|
|
8665
8664
|
"name": "IRunnerImageBuilder",
|
|
8666
|
-
"symbolId": "src/
|
|
8665
|
+
"symbolId": "src/image-builders/common:IRunnerImageBuilder"
|
|
8667
8666
|
},
|
|
8668
8667
|
"@cloudsnorkel/cdk-github-runners.IRunnerImageStatus": {
|
|
8669
8668
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
@@ -9048,8 +9047,8 @@
|
|
|
9048
9047
|
"fqn": "@cloudsnorkel/cdk-github-runners.ImageBuilderAsset",
|
|
9049
9048
|
"kind": "interface",
|
|
9050
9049
|
"locationInModule": {
|
|
9051
|
-
"filename": "src/
|
|
9052
|
-
"line":
|
|
9050
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9051
|
+
"line": 45
|
|
9053
9052
|
},
|
|
9054
9053
|
"name": "ImageBuilderAsset",
|
|
9055
9054
|
"properties": [
|
|
@@ -9061,8 +9060,8 @@
|
|
|
9061
9060
|
},
|
|
9062
9061
|
"immutable": true,
|
|
9063
9062
|
"locationInModule": {
|
|
9064
|
-
"filename": "src/
|
|
9065
|
-
"line":
|
|
9063
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9064
|
+
"line": 54
|
|
9066
9065
|
},
|
|
9067
9066
|
"name": "asset",
|
|
9068
9067
|
"type": {
|
|
@@ -9077,8 +9076,8 @@
|
|
|
9077
9076
|
},
|
|
9078
9077
|
"immutable": true,
|
|
9079
9078
|
"locationInModule": {
|
|
9080
|
-
"filename": "src/
|
|
9081
|
-
"line":
|
|
9079
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9080
|
+
"line": 49
|
|
9082
9081
|
},
|
|
9083
9082
|
"name": "path",
|
|
9084
9083
|
"type": {
|
|
@@ -9086,14 +9085,14 @@
|
|
|
9086
9085
|
}
|
|
9087
9086
|
}
|
|
9088
9087
|
],
|
|
9089
|
-
"symbolId": "src/
|
|
9088
|
+
"symbolId": "src/image-builders/aws-image-builder/builder:ImageBuilderAsset"
|
|
9090
9089
|
},
|
|
9091
9090
|
"@cloudsnorkel/cdk-github-runners.ImageBuilderComponent": {
|
|
9092
9091
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
9093
9092
|
"base": "aws-cdk-lib.Resource",
|
|
9094
9093
|
"docs": {
|
|
9095
9094
|
"deprecated": "Use `RunnerImageComponent` instead as this be internal soon.",
|
|
9096
|
-
"remarks": "Components are the building blocks of images built by Image Builder.\n\nExample:\n\n```\nnew ImageBuilderComponent(this, 'AWS CLI', {\n platform: 'Windows',\n displayName: 'AWS CLI',\n description: 'Install latest version of AWS CLI',\n commands: [\n 'Start-Process msiexec.exe -Wait -ArgumentList \\'/i https://awscli.amazonaws.com/AWSCLIV2.msi /qn\\'',\n ],\n}\n```",
|
|
9095
|
+
"remarks": "Components are the building blocks of images built by Image Builder.\n\nExample:\n\n```\nnew ImageBuilderComponent(this, 'AWS CLI', {\n platform: 'Windows',\n displayName: 'AWS CLI',\n description: 'Install latest version of AWS CLI',\n commands: [\n '$p = Start-Process msiexec.exe -PassThru -Wait -ArgumentList \\'/i https://awscli.amazonaws.com/AWSCLIV2.msi /qn\\'',\n 'if ($p.ExitCode -ne 0) { throw \"Exit code is $p.ExitCode\" }',\n ],\n}\n```",
|
|
9097
9096
|
"stability": "deprecated",
|
|
9098
9097
|
"summary": "Components are a set of commands to run and optional files to add to an image."
|
|
9099
9098
|
},
|
|
@@ -9103,8 +9102,8 @@
|
|
|
9103
9102
|
"stability": "deprecated"
|
|
9104
9103
|
},
|
|
9105
9104
|
"locationInModule": {
|
|
9106
|
-
"filename": "src/
|
|
9107
|
-
"line":
|
|
9105
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9106
|
+
"line": 128
|
|
9108
9107
|
},
|
|
9109
9108
|
"parameters": [
|
|
9110
9109
|
{
|
|
@@ -9129,8 +9128,8 @@
|
|
|
9129
9128
|
},
|
|
9130
9129
|
"kind": "class",
|
|
9131
9130
|
"locationInModule": {
|
|
9132
|
-
"filename": "src/
|
|
9133
|
-
"line":
|
|
9131
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9132
|
+
"line": 115
|
|
9134
9133
|
},
|
|
9135
9134
|
"methods": [
|
|
9136
9135
|
{
|
|
@@ -9139,8 +9138,8 @@
|
|
|
9139
9138
|
"summary": "Grants read permissions to the principal on the assets buckets."
|
|
9140
9139
|
},
|
|
9141
9140
|
"locationInModule": {
|
|
9142
|
-
"filename": "src/
|
|
9143
|
-
"line":
|
|
9141
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9142
|
+
"line": 230
|
|
9144
9143
|
},
|
|
9145
9144
|
"name": "grantAssetsRead",
|
|
9146
9145
|
"parameters": [
|
|
@@ -9157,8 +9156,8 @@
|
|
|
9157
9156
|
"stability": "deprecated"
|
|
9158
9157
|
},
|
|
9159
9158
|
"locationInModule": {
|
|
9160
|
-
"filename": "src/
|
|
9161
|
-
"line":
|
|
9159
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9160
|
+
"line": 236
|
|
9162
9161
|
},
|
|
9163
9162
|
"name": "prefixCommandsWithErrorHandling",
|
|
9164
9163
|
"parameters": [
|
|
@@ -9196,7 +9195,7 @@
|
|
|
9196
9195
|
"stability": "deprecated"
|
|
9197
9196
|
},
|
|
9198
9197
|
"locationInModule": {
|
|
9199
|
-
"filename": "src/
|
|
9198
|
+
"filename": "src/image-builders/aws-image-builder/common.ts",
|
|
9200
9199
|
"line": 15
|
|
9201
9200
|
},
|
|
9202
9201
|
"name": "version",
|
|
@@ -9237,8 +9236,8 @@
|
|
|
9237
9236
|
},
|
|
9238
9237
|
"immutable": true,
|
|
9239
9238
|
"locationInModule": {
|
|
9240
|
-
"filename": "src/
|
|
9241
|
-
"line":
|
|
9239
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9240
|
+
"line": 119
|
|
9242
9241
|
},
|
|
9243
9242
|
"name": "arn",
|
|
9244
9243
|
"type": {
|
|
@@ -9252,8 +9251,8 @@
|
|
|
9252
9251
|
},
|
|
9253
9252
|
"immutable": true,
|
|
9254
9253
|
"locationInModule": {
|
|
9255
|
-
"filename": "src/
|
|
9256
|
-
"line":
|
|
9254
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9255
|
+
"line": 124
|
|
9257
9256
|
},
|
|
9258
9257
|
"name": "platform",
|
|
9259
9258
|
"type": {
|
|
@@ -9261,7 +9260,7 @@
|
|
|
9261
9260
|
}
|
|
9262
9261
|
}
|
|
9263
9262
|
],
|
|
9264
|
-
"symbolId": "src/
|
|
9263
|
+
"symbolId": "src/image-builders/aws-image-builder/builder:ImageBuilderComponent"
|
|
9265
9264
|
},
|
|
9266
9265
|
"@cloudsnorkel/cdk-github-runners.ImageBuilderComponentProperties": {
|
|
9267
9266
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
@@ -9273,8 +9272,8 @@
|
|
|
9273
9272
|
"fqn": "@cloudsnorkel/cdk-github-runners.ImageBuilderComponentProperties",
|
|
9274
9273
|
"kind": "interface",
|
|
9275
9274
|
"locationInModule": {
|
|
9276
|
-
"filename": "src/
|
|
9277
|
-
"line":
|
|
9275
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9276
|
+
"line": 60
|
|
9278
9277
|
},
|
|
9279
9278
|
"name": "ImageBuilderComponentProperties",
|
|
9280
9279
|
"properties": [
|
|
@@ -9287,8 +9286,8 @@
|
|
|
9287
9286
|
},
|
|
9288
9287
|
"immutable": true,
|
|
9289
9288
|
"locationInModule": {
|
|
9290
|
-
"filename": "src/
|
|
9291
|
-
"line":
|
|
9289
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9290
|
+
"line": 81
|
|
9292
9291
|
},
|
|
9293
9292
|
"name": "commands",
|
|
9294
9293
|
"type": {
|
|
@@ -9308,8 +9307,8 @@
|
|
|
9308
9307
|
},
|
|
9309
9308
|
"immutable": true,
|
|
9310
9309
|
"locationInModule": {
|
|
9311
|
-
"filename": "src/
|
|
9312
|
-
"line":
|
|
9310
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9311
|
+
"line": 74
|
|
9313
9312
|
},
|
|
9314
9313
|
"name": "description",
|
|
9315
9314
|
"type": {
|
|
@@ -9324,8 +9323,8 @@
|
|
|
9324
9323
|
},
|
|
9325
9324
|
"immutable": true,
|
|
9326
9325
|
"locationInModule": {
|
|
9327
|
-
"filename": "src/
|
|
9328
|
-
"line":
|
|
9326
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9327
|
+
"line": 69
|
|
9329
9328
|
},
|
|
9330
9329
|
"name": "displayName",
|
|
9331
9330
|
"type": {
|
|
@@ -9341,8 +9340,8 @@
|
|
|
9341
9340
|
},
|
|
9342
9341
|
"immutable": true,
|
|
9343
9342
|
"locationInModule": {
|
|
9344
|
-
"filename": "src/
|
|
9345
|
-
"line":
|
|
9343
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9344
|
+
"line": 64
|
|
9346
9345
|
},
|
|
9347
9346
|
"name": "platform",
|
|
9348
9347
|
"type": {
|
|
@@ -9357,8 +9356,8 @@
|
|
|
9357
9356
|
},
|
|
9358
9357
|
"immutable": true,
|
|
9359
9358
|
"locationInModule": {
|
|
9360
|
-
"filename": "src/
|
|
9361
|
-
"line":
|
|
9359
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9360
|
+
"line": 86
|
|
9362
9361
|
},
|
|
9363
9362
|
"name": "assets",
|
|
9364
9363
|
"optional": true,
|
|
@@ -9370,9 +9369,27 @@
|
|
|
9370
9369
|
"kind": "array"
|
|
9371
9370
|
}
|
|
9372
9371
|
}
|
|
9372
|
+
},
|
|
9373
|
+
{
|
|
9374
|
+
"abstract": true,
|
|
9375
|
+
"docs": {
|
|
9376
|
+
"default": "false",
|
|
9377
|
+
"stability": "experimental",
|
|
9378
|
+
"summary": "Require a reboot after installing this component."
|
|
9379
|
+
},
|
|
9380
|
+
"immutable": true,
|
|
9381
|
+
"locationInModule": {
|
|
9382
|
+
"filename": "src/image-builders/aws-image-builder/builder.ts",
|
|
9383
|
+
"line": 93
|
|
9384
|
+
},
|
|
9385
|
+
"name": "reboot",
|
|
9386
|
+
"optional": true,
|
|
9387
|
+
"type": {
|
|
9388
|
+
"primitive": "boolean"
|
|
9389
|
+
}
|
|
9373
9390
|
}
|
|
9374
9391
|
],
|
|
9375
|
-
"symbolId": "src/
|
|
9392
|
+
"symbolId": "src/image-builders/aws-image-builder/builder:ImageBuilderComponentProperties"
|
|
9376
9393
|
},
|
|
9377
9394
|
"@cloudsnorkel/cdk-github-runners.LambdaAccess": {
|
|
9378
9395
|
"abstract": true,
|
|
@@ -10157,7 +10174,7 @@
|
|
|
10157
10174
|
},
|
|
10158
10175
|
"kind": "class",
|
|
10159
10176
|
"locationInModule": {
|
|
10160
|
-
"filename": "src/
|
|
10177
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/linux-components.ts",
|
|
10161
10178
|
"line": 11
|
|
10162
10179
|
},
|
|
10163
10180
|
"methods": [
|
|
@@ -10166,7 +10183,7 @@
|
|
|
10166
10183
|
"stability": "deprecated"
|
|
10167
10184
|
},
|
|
10168
10185
|
"locationInModule": {
|
|
10169
|
-
"filename": "src/
|
|
10186
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/linux-components.ts",
|
|
10170
10187
|
"line": 51
|
|
10171
10188
|
},
|
|
10172
10189
|
"name": "awsCli",
|
|
@@ -10202,7 +10219,7 @@
|
|
|
10202
10219
|
"stability": "deprecated"
|
|
10203
10220
|
},
|
|
10204
10221
|
"locationInModule": {
|
|
10205
|
-
"filename": "src/
|
|
10222
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/linux-components.ts",
|
|
10206
10223
|
"line": 134
|
|
10207
10224
|
},
|
|
10208
10225
|
"name": "docker",
|
|
@@ -10238,7 +10255,7 @@
|
|
|
10238
10255
|
"stability": "deprecated"
|
|
10239
10256
|
},
|
|
10240
10257
|
"locationInModule": {
|
|
10241
|
-
"filename": "src/
|
|
10258
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/linux-components.ts",
|
|
10242
10259
|
"line": 152
|
|
10243
10260
|
},
|
|
10244
10261
|
"name": "extraCertificates",
|
|
@@ -10274,7 +10291,7 @@
|
|
|
10274
10291
|
"stability": "deprecated"
|
|
10275
10292
|
},
|
|
10276
10293
|
"locationInModule": {
|
|
10277
|
-
"filename": "src/
|
|
10294
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/linux-components.ts",
|
|
10278
10295
|
"line": 89
|
|
10279
10296
|
},
|
|
10280
10297
|
"name": "git",
|
|
@@ -10310,7 +10327,7 @@
|
|
|
10310
10327
|
"stability": "deprecated"
|
|
10311
10328
|
},
|
|
10312
10329
|
"locationInModule": {
|
|
10313
|
-
"filename": "src/
|
|
10330
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/linux-components.ts",
|
|
10314
10331
|
"line": 74
|
|
10315
10332
|
},
|
|
10316
10333
|
"name": "githubCli",
|
|
@@ -10346,7 +10363,7 @@
|
|
|
10346
10363
|
"stability": "deprecated"
|
|
10347
10364
|
},
|
|
10348
10365
|
"locationInModule": {
|
|
10349
|
-
"filename": "src/
|
|
10366
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/linux-components.ts",
|
|
10350
10367
|
"line": 102
|
|
10351
10368
|
},
|
|
10352
10369
|
"name": "githubRunner",
|
|
@@ -10388,7 +10405,7 @@
|
|
|
10388
10405
|
"stability": "deprecated"
|
|
10389
10406
|
},
|
|
10390
10407
|
"locationInModule": {
|
|
10391
|
-
"filename": "src/
|
|
10408
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/linux-components.ts",
|
|
10392
10409
|
"line": 12
|
|
10393
10410
|
},
|
|
10394
10411
|
"name": "requiredPackages",
|
|
@@ -10424,7 +10441,7 @@
|
|
|
10424
10441
|
"stability": "deprecated"
|
|
10425
10442
|
},
|
|
10426
10443
|
"locationInModule": {
|
|
10427
|
-
"filename": "src/
|
|
10444
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/linux-components.ts",
|
|
10428
10445
|
"line": 37
|
|
10429
10446
|
},
|
|
10430
10447
|
"name": "runnerUser",
|
|
@@ -10457,7 +10474,7 @@
|
|
|
10457
10474
|
}
|
|
10458
10475
|
],
|
|
10459
10476
|
"name": "LinuxUbuntuComponents",
|
|
10460
|
-
"symbolId": "src/
|
|
10477
|
+
"symbolId": "src/image-builders/aws-image-builder/deprecated/linux-components:LinuxUbuntuComponents"
|
|
10461
10478
|
},
|
|
10462
10479
|
"@cloudsnorkel/cdk-github-runners.LogOptions": {
|
|
10463
10480
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
@@ -11029,7 +11046,7 @@
|
|
|
11029
11046
|
"fqn": "@cloudsnorkel/cdk-github-runners.RunnerImageAsset",
|
|
11030
11047
|
"kind": "interface",
|
|
11031
11048
|
"locationInModule": {
|
|
11032
|
-
"filename": "src/
|
|
11049
|
+
"filename": "src/image-builders/common.ts",
|
|
11033
11050
|
"line": 119
|
|
11034
11051
|
},
|
|
11035
11052
|
"name": "RunnerImageAsset",
|
|
@@ -11043,7 +11060,7 @@
|
|
|
11043
11060
|
},
|
|
11044
11061
|
"immutable": true,
|
|
11045
11062
|
"locationInModule": {
|
|
11046
|
-
"filename": "src/
|
|
11063
|
+
"filename": "src/image-builders/common.ts",
|
|
11047
11064
|
"line": 123
|
|
11048
11065
|
},
|
|
11049
11066
|
"name": "source",
|
|
@@ -11059,7 +11076,7 @@
|
|
|
11059
11076
|
},
|
|
11060
11077
|
"immutable": true,
|
|
11061
11078
|
"locationInModule": {
|
|
11062
|
-
"filename": "src/
|
|
11079
|
+
"filename": "src/image-builders/common.ts",
|
|
11063
11080
|
"line": 128
|
|
11064
11081
|
},
|
|
11065
11082
|
"name": "target",
|
|
@@ -11068,7 +11085,7 @@
|
|
|
11068
11085
|
}
|
|
11069
11086
|
}
|
|
11070
11087
|
],
|
|
11071
|
-
"symbolId": "src/
|
|
11088
|
+
"symbolId": "src/image-builders/common:RunnerImageAsset"
|
|
11072
11089
|
},
|
|
11073
11090
|
"@cloudsnorkel/cdk-github-runners.RunnerImageBuilder": {
|
|
11074
11091
|
"abstract": true,
|
|
@@ -11085,8 +11102,8 @@
|
|
|
11085
11102
|
"stability": "experimental"
|
|
11086
11103
|
},
|
|
11087
11104
|
"locationInModule": {
|
|
11088
|
-
"filename": "src/
|
|
11089
|
-
"line":
|
|
11105
|
+
"filename": "src/image-builders/common.ts",
|
|
11106
|
+
"line": 287
|
|
11090
11107
|
},
|
|
11091
11108
|
"parameters": [
|
|
11092
11109
|
{
|
|
@@ -11118,7 +11135,7 @@
|
|
|
11118
11135
|
],
|
|
11119
11136
|
"kind": "class",
|
|
11120
11137
|
"locationInModule": {
|
|
11121
|
-
"filename": "src/
|
|
11138
|
+
"filename": "src/image-builders/api.ts",
|
|
11122
11139
|
"line": 15
|
|
11123
11140
|
},
|
|
11124
11141
|
"methods": [
|
|
@@ -11129,7 +11146,7 @@
|
|
|
11129
11146
|
"summary": "Create a new image builder based on the provided properties."
|
|
11130
11147
|
},
|
|
11131
11148
|
"locationInModule": {
|
|
11132
|
-
"filename": "src/
|
|
11149
|
+
"filename": "src/image-builders/api.ts",
|
|
11133
11150
|
"line": 19
|
|
11134
11151
|
},
|
|
11135
11152
|
"name": "new",
|
|
@@ -11168,8 +11185,8 @@
|
|
|
11168
11185
|
"summary": "Add a component to the image builder."
|
|
11169
11186
|
},
|
|
11170
11187
|
"locationInModule": {
|
|
11171
|
-
"filename": "src/
|
|
11172
|
-
"line":
|
|
11188
|
+
"filename": "src/image-builders/common.ts",
|
|
11189
|
+
"line": 307
|
|
11173
11190
|
},
|
|
11174
11191
|
"name": "addComponent",
|
|
11175
11192
|
"parameters": [
|
|
@@ -11192,8 +11209,8 @@
|
|
|
11192
11209
|
"summary": "Build and return an AMI with GitHub Runner installed in it."
|
|
11193
11210
|
},
|
|
11194
11211
|
"locationInModule": {
|
|
11195
|
-
"filename": "src/
|
|
11196
|
-
"line":
|
|
11212
|
+
"filename": "src/image-builders/common.ts",
|
|
11213
|
+
"line": 297
|
|
11197
11214
|
},
|
|
11198
11215
|
"name": "bindAmi",
|
|
11199
11216
|
"overrides": "@cloudsnorkel/cdk-github-runners.IRunnerImageBuilder",
|
|
@@ -11211,8 +11228,8 @@
|
|
|
11211
11228
|
"summary": "Build and return a Docker image with GitHub Runner installed in it."
|
|
11212
11229
|
},
|
|
11213
11230
|
"locationInModule": {
|
|
11214
|
-
"filename": "src/
|
|
11215
|
-
"line":
|
|
11231
|
+
"filename": "src/image-builders/common.ts",
|
|
11232
|
+
"line": 295
|
|
11216
11233
|
},
|
|
11217
11234
|
"name": "bindDockerImage",
|
|
11218
11235
|
"overrides": "@cloudsnorkel/cdk-github-runners.IRunnerImageBuilder",
|
|
@@ -11229,8 +11246,8 @@
|
|
|
11229
11246
|
"summary": "Remove a component from the image builder."
|
|
11230
11247
|
},
|
|
11231
11248
|
"locationInModule": {
|
|
11232
|
-
"filename": "src/
|
|
11233
|
-
"line":
|
|
11249
|
+
"filename": "src/image-builders/common.ts",
|
|
11250
|
+
"line": 316
|
|
11234
11251
|
},
|
|
11235
11252
|
"name": "removeComponent",
|
|
11236
11253
|
"parameters": [
|
|
@@ -11256,8 +11273,8 @@
|
|
|
11256
11273
|
},
|
|
11257
11274
|
"immutable": true,
|
|
11258
11275
|
"locationInModule": {
|
|
11259
|
-
"filename": "src/
|
|
11260
|
-
"line":
|
|
11276
|
+
"filename": "src/image-builders/common.ts",
|
|
11277
|
+
"line": 299
|
|
11261
11278
|
},
|
|
11262
11279
|
"name": "connections",
|
|
11263
11280
|
"overrides": "aws-cdk-lib.aws_ec2.IConnectable",
|
|
@@ -11273,8 +11290,8 @@
|
|
|
11273
11290
|
},
|
|
11274
11291
|
"immutable": true,
|
|
11275
11292
|
"locationInModule": {
|
|
11276
|
-
"filename": "src/
|
|
11277
|
-
"line":
|
|
11293
|
+
"filename": "src/image-builders/common.ts",
|
|
11294
|
+
"line": 300
|
|
11278
11295
|
},
|
|
11279
11296
|
"name": "grantPrincipal",
|
|
11280
11297
|
"overrides": "aws-cdk-lib.aws_iam.IGrantable",
|
|
@@ -11287,8 +11304,8 @@
|
|
|
11287
11304
|
"stability": "experimental"
|
|
11288
11305
|
},
|
|
11289
11306
|
"locationInModule": {
|
|
11290
|
-
"filename": "src/
|
|
11291
|
-
"line":
|
|
11307
|
+
"filename": "src/image-builders/common.ts",
|
|
11308
|
+
"line": 285
|
|
11292
11309
|
},
|
|
11293
11310
|
"name": "components",
|
|
11294
11311
|
"protected": true,
|
|
@@ -11302,7 +11319,7 @@
|
|
|
11302
11319
|
}
|
|
11303
11320
|
}
|
|
11304
11321
|
],
|
|
11305
|
-
"symbolId": "src/
|
|
11322
|
+
"symbolId": "src/image-builders/api:RunnerImageBuilder"
|
|
11306
11323
|
},
|
|
11307
11324
|
"@cloudsnorkel/cdk-github-runners.RunnerImageBuilderProps": {
|
|
11308
11325
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
@@ -11313,7 +11330,7 @@
|
|
|
11313
11330
|
"fqn": "@cloudsnorkel/cdk-github-runners.RunnerImageBuilderProps",
|
|
11314
11331
|
"kind": "interface",
|
|
11315
11332
|
"locationInModule": {
|
|
11316
|
-
"filename": "src/
|
|
11333
|
+
"filename": "src/image-builders/common.ts",
|
|
11317
11334
|
"line": 131
|
|
11318
11335
|
},
|
|
11319
11336
|
"name": "RunnerImageBuilderProps",
|
|
@@ -11327,7 +11344,7 @@
|
|
|
11327
11344
|
},
|
|
11328
11345
|
"immutable": true,
|
|
11329
11346
|
"locationInModule": {
|
|
11330
|
-
"filename": "src/
|
|
11347
|
+
"filename": "src/image-builders/common.ts",
|
|
11331
11348
|
"line": 137
|
|
11332
11349
|
},
|
|
11333
11350
|
"name": "architecture",
|
|
@@ -11345,8 +11362,8 @@
|
|
|
11345
11362
|
},
|
|
11346
11363
|
"immutable": true,
|
|
11347
11364
|
"locationInModule": {
|
|
11348
|
-
"filename": "src/
|
|
11349
|
-
"line":
|
|
11365
|
+
"filename": "src/image-builders/common.ts",
|
|
11366
|
+
"line": 235
|
|
11350
11367
|
},
|
|
11351
11368
|
"name": "awsImageBuilderOptions",
|
|
11352
11369
|
"optional": true,
|
|
@@ -11357,14 +11374,15 @@
|
|
|
11357
11374
|
{
|
|
11358
11375
|
"abstract": true,
|
|
11359
11376
|
"docs": {
|
|
11360
|
-
"default": "latest Ubuntu
|
|
11377
|
+
"default": "latest Ubuntu 22.04 AMI for Os.LINUX_UBUNTU, latest Amazon Linux 2 AMI for Os.LINUX_AMAZON_2, latest Windows Server 2022 AMI for Os.WINDOWS",
|
|
11378
|
+
"remarks": "This can be an actual AMI or an AWS Image Builder ARN that points to the latest AMI. For example `arn:aws:imagebuilder:us-east-1:aws:image/ubuntu-server-22-lts-x86/x.x.x` would always use the latest version of Ubuntu 22.04 in each build. If you want a specific version, you can replace `x.x.x` with that version.",
|
|
11361
11379
|
"stability": "experimental",
|
|
11362
11380
|
"summary": "Base AMI from which runner AMIs will be built."
|
|
11363
11381
|
},
|
|
11364
11382
|
"immutable": true,
|
|
11365
11383
|
"locationInModule": {
|
|
11366
|
-
"filename": "src/
|
|
11367
|
-
"line":
|
|
11384
|
+
"filename": "src/image-builders/common.ts",
|
|
11385
|
+
"line": 160
|
|
11368
11386
|
},
|
|
11369
11387
|
"name": "baseAmi",
|
|
11370
11388
|
"optional": true,
|
|
@@ -11381,7 +11399,7 @@
|
|
|
11381
11399
|
},
|
|
11382
11400
|
"immutable": true,
|
|
11383
11401
|
"locationInModule": {
|
|
11384
|
-
"filename": "src/
|
|
11402
|
+
"filename": "src/image-builders/common.ts",
|
|
11385
11403
|
"line": 151
|
|
11386
11404
|
},
|
|
11387
11405
|
"name": "baseDockerImage",
|
|
@@ -11398,8 +11416,8 @@
|
|
|
11398
11416
|
},
|
|
11399
11417
|
"immutable": true,
|
|
11400
11418
|
"locationInModule": {
|
|
11401
|
-
"filename": "src/
|
|
11402
|
-
"line":
|
|
11419
|
+
"filename": "src/image-builders/common.ts",
|
|
11420
|
+
"line": 225
|
|
11403
11421
|
},
|
|
11404
11422
|
"name": "builderType",
|
|
11405
11423
|
"optional": true,
|
|
@@ -11416,8 +11434,8 @@
|
|
|
11416
11434
|
},
|
|
11417
11435
|
"immutable": true,
|
|
11418
11436
|
"locationInModule": {
|
|
11419
|
-
"filename": "src/
|
|
11420
|
-
"line":
|
|
11437
|
+
"filename": "src/image-builders/common.ts",
|
|
11438
|
+
"line": 230
|
|
11421
11439
|
},
|
|
11422
11440
|
"name": "codeBuildOptions",
|
|
11423
11441
|
"optional": true,
|
|
@@ -11434,8 +11452,8 @@
|
|
|
11434
11452
|
},
|
|
11435
11453
|
"immutable": true,
|
|
11436
11454
|
"locationInModule": {
|
|
11437
|
-
"filename": "src/
|
|
11438
|
-
"line":
|
|
11455
|
+
"filename": "src/image-builders/common.ts",
|
|
11456
|
+
"line": 174
|
|
11439
11457
|
},
|
|
11440
11458
|
"name": "components",
|
|
11441
11459
|
"optional": true,
|
|
@@ -11458,8 +11476,8 @@
|
|
|
11458
11476
|
},
|
|
11459
11477
|
"immutable": true,
|
|
11460
11478
|
"locationInModule": {
|
|
11461
|
-
"filename": "src/
|
|
11462
|
-
"line":
|
|
11479
|
+
"filename": "src/image-builders/common.ts",
|
|
11480
|
+
"line": 220
|
|
11463
11481
|
},
|
|
11464
11482
|
"name": "logRemovalPolicy",
|
|
11465
11483
|
"optional": true,
|
|
@@ -11477,8 +11495,8 @@
|
|
|
11477
11495
|
},
|
|
11478
11496
|
"immutable": true,
|
|
11479
11497
|
"locationInModule": {
|
|
11480
|
-
"filename": "src/
|
|
11481
|
-
"line":
|
|
11498
|
+
"filename": "src/image-builders/common.ts",
|
|
11499
|
+
"line": 211
|
|
11482
11500
|
},
|
|
11483
11501
|
"name": "logRetention",
|
|
11484
11502
|
"optional": true,
|
|
@@ -11489,13 +11507,13 @@
|
|
|
11489
11507
|
{
|
|
11490
11508
|
"abstract": true,
|
|
11491
11509
|
"docs": {
|
|
11492
|
-
"default": "OS.
|
|
11510
|
+
"default": "OS.LINUX_UBUNTU",
|
|
11493
11511
|
"stability": "experimental",
|
|
11494
11512
|
"summary": "Image OS."
|
|
11495
11513
|
},
|
|
11496
11514
|
"immutable": true,
|
|
11497
11515
|
"locationInModule": {
|
|
11498
|
-
"filename": "src/
|
|
11516
|
+
"filename": "src/image-builders/common.ts",
|
|
11499
11517
|
"line": 144
|
|
11500
11518
|
},
|
|
11501
11519
|
"name": "os",
|
|
@@ -11514,8 +11532,8 @@
|
|
|
11514
11532
|
},
|
|
11515
11533
|
"immutable": true,
|
|
11516
11534
|
"locationInModule": {
|
|
11517
|
-
"filename": "src/
|
|
11518
|
-
"line":
|
|
11535
|
+
"filename": "src/image-builders/common.ts",
|
|
11536
|
+
"line": 183
|
|
11519
11537
|
},
|
|
11520
11538
|
"name": "rebuildInterval",
|
|
11521
11539
|
"optional": true,
|
|
@@ -11532,8 +11550,8 @@
|
|
|
11532
11550
|
},
|
|
11533
11551
|
"immutable": true,
|
|
11534
11552
|
"locationInModule": {
|
|
11535
|
-
"filename": "src/
|
|
11536
|
-
"line":
|
|
11553
|
+
"filename": "src/image-builders/common.ts",
|
|
11554
|
+
"line": 167
|
|
11537
11555
|
},
|
|
11538
11556
|
"name": "runnerVersion",
|
|
11539
11557
|
"optional": true,
|
|
@@ -11549,8 +11567,8 @@
|
|
|
11549
11567
|
},
|
|
11550
11568
|
"immutable": true,
|
|
11551
11569
|
"locationInModule": {
|
|
11552
|
-
"filename": "src/
|
|
11553
|
-
"line":
|
|
11570
|
+
"filename": "src/image-builders/common.ts",
|
|
11571
|
+
"line": 195
|
|
11554
11572
|
},
|
|
11555
11573
|
"name": "securityGroups",
|
|
11556
11574
|
"optional": true,
|
|
@@ -11572,8 +11590,8 @@
|
|
|
11572
11590
|
},
|
|
11573
11591
|
"immutable": true,
|
|
11574
11592
|
"locationInModule": {
|
|
11575
|
-
"filename": "src/
|
|
11576
|
-
"line":
|
|
11593
|
+
"filename": "src/image-builders/common.ts",
|
|
11594
|
+
"line": 202
|
|
11577
11595
|
},
|
|
11578
11596
|
"name": "subnetSelection",
|
|
11579
11597
|
"optional": true,
|
|
@@ -11590,8 +11608,8 @@
|
|
|
11590
11608
|
},
|
|
11591
11609
|
"immutable": true,
|
|
11592
11610
|
"locationInModule": {
|
|
11593
|
-
"filename": "src/
|
|
11594
|
-
"line":
|
|
11611
|
+
"filename": "src/image-builders/common.ts",
|
|
11612
|
+
"line": 190
|
|
11595
11613
|
},
|
|
11596
11614
|
"name": "vpc",
|
|
11597
11615
|
"optional": true,
|
|
@@ -11600,7 +11618,7 @@
|
|
|
11600
11618
|
}
|
|
11601
11619
|
}
|
|
11602
11620
|
],
|
|
11603
|
-
"symbolId": "src/
|
|
11621
|
+
"symbolId": "src/image-builders/common:RunnerImageBuilderProps"
|
|
11604
11622
|
},
|
|
11605
11623
|
"@cloudsnorkel/cdk-github-runners.RunnerImageBuilderType": {
|
|
11606
11624
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
@@ -11610,8 +11628,8 @@
|
|
|
11610
11628
|
"fqn": "@cloudsnorkel/cdk-github-runners.RunnerImageBuilderType",
|
|
11611
11629
|
"kind": "enum",
|
|
11612
11630
|
"locationInModule": {
|
|
11613
|
-
"filename": "src/
|
|
11614
|
-
"line":
|
|
11631
|
+
"filename": "src/image-builders/common.ts",
|
|
11632
|
+
"line": 238
|
|
11615
11633
|
},
|
|
11616
11634
|
"members": [
|
|
11617
11635
|
{
|
|
@@ -11632,7 +11650,7 @@
|
|
|
11632
11650
|
}
|
|
11633
11651
|
],
|
|
11634
11652
|
"name": "RunnerImageBuilderType",
|
|
11635
|
-
"symbolId": "src/
|
|
11653
|
+
"symbolId": "src/image-builders/common:RunnerImageBuilderType"
|
|
11636
11654
|
},
|
|
11637
11655
|
"@cloudsnorkel/cdk-github-runners.RunnerImageComponent": {
|
|
11638
11656
|
"abstract": true,
|
|
@@ -11650,7 +11668,7 @@
|
|
|
11650
11668
|
},
|
|
11651
11669
|
"kind": "class",
|
|
11652
11670
|
"locationInModule": {
|
|
11653
|
-
"filename": "src/
|
|
11671
|
+
"filename": "src/image-builders/components.ts",
|
|
11654
11672
|
"line": 39
|
|
11655
11673
|
},
|
|
11656
11674
|
"methods": [
|
|
@@ -11660,8 +11678,8 @@
|
|
|
11660
11678
|
"summary": "A component to install the AWS CLI."
|
|
11661
11679
|
},
|
|
11662
11680
|
"locationInModule": {
|
|
11663
|
-
"filename": "src/
|
|
11664
|
-
"line":
|
|
11681
|
+
"filename": "src/image-builders/components.ts",
|
|
11682
|
+
"line": 149
|
|
11665
11683
|
},
|
|
11666
11684
|
"name": "awsCli",
|
|
11667
11685
|
"returns": {
|
|
@@ -11678,7 +11696,7 @@
|
|
|
11678
11696
|
"summary": "Define a custom component that can run commands in the image, copy files into the image, and run some Docker commands."
|
|
11679
11697
|
},
|
|
11680
11698
|
"locationInModule": {
|
|
11681
|
-
"filename": "src/
|
|
11699
|
+
"filename": "src/image-builders/components.ts",
|
|
11682
11700
|
"line": 49
|
|
11683
11701
|
},
|
|
11684
11702
|
"name": "custom",
|
|
@@ -11699,13 +11717,13 @@
|
|
|
11699
11717
|
},
|
|
11700
11718
|
{
|
|
11701
11719
|
"docs": {
|
|
11702
|
-
"remarks": "On Windows this
|
|
11720
|
+
"remarks": "On Windows this sets up dockerd for Windows containers without Docker Desktop. If you need Linux containers on Windows, you'll need to install Docker Desktop which doesn't seem to play well with servers (PRs welcome).",
|
|
11703
11721
|
"stability": "experimental",
|
|
11704
11722
|
"summary": "A component to install Docker."
|
|
11705
11723
|
},
|
|
11706
11724
|
"locationInModule": {
|
|
11707
|
-
"filename": "src/
|
|
11708
|
-
"line":
|
|
11725
|
+
"filename": "src/image-builders/components.ts",
|
|
11726
|
+
"line": 336
|
|
11709
11727
|
},
|
|
11710
11728
|
"name": "docker",
|
|
11711
11729
|
"returns": {
|
|
@@ -11721,8 +11739,8 @@
|
|
|
11721
11739
|
"summary": "A component to install Docker-in-Docker."
|
|
11722
11740
|
},
|
|
11723
11741
|
"locationInModule": {
|
|
11724
|
-
"filename": "src/
|
|
11725
|
-
"line":
|
|
11742
|
+
"filename": "src/image-builders/components.ts",
|
|
11743
|
+
"line": 398
|
|
11726
11744
|
},
|
|
11727
11745
|
"name": "dockerInDocker",
|
|
11728
11746
|
"returns": {
|
|
@@ -11739,8 +11757,8 @@
|
|
|
11739
11757
|
"summary": "A component to add a trusted certificate authority."
|
|
11740
11758
|
},
|
|
11741
11759
|
"locationInModule": {
|
|
11742
|
-
"filename": "src/
|
|
11743
|
-
"line":
|
|
11760
|
+
"filename": "src/image-builders/components.ts",
|
|
11761
|
+
"line": 447
|
|
11744
11762
|
},
|
|
11745
11763
|
"name": "extraCertificates",
|
|
11746
11764
|
"parameters": [
|
|
@@ -11776,8 +11794,8 @@
|
|
|
11776
11794
|
"summary": "A component to install the GitHub CLI."
|
|
11777
11795
|
},
|
|
11778
11796
|
"locationInModule": {
|
|
11779
|
-
"filename": "src/
|
|
11780
|
-
"line":
|
|
11797
|
+
"filename": "src/image-builders/components.ts",
|
|
11798
|
+
"line": 223
|
|
11781
11799
|
},
|
|
11782
11800
|
"name": "git",
|
|
11783
11801
|
"returns": {
|
|
@@ -11793,8 +11811,8 @@
|
|
|
11793
11811
|
"summary": "A component to install the GitHub CLI."
|
|
11794
11812
|
},
|
|
11795
11813
|
"locationInModule": {
|
|
11796
|
-
"filename": "src/
|
|
11797
|
-
"line":
|
|
11814
|
+
"filename": "src/image-builders/components.ts",
|
|
11815
|
+
"line": 185
|
|
11798
11816
|
},
|
|
11799
11817
|
"name": "githubCli",
|
|
11800
11818
|
"returns": {
|
|
@@ -11811,8 +11829,8 @@
|
|
|
11811
11829
|
"summary": "A component to install the GitHub Actions Runner."
|
|
11812
11830
|
},
|
|
11813
11831
|
"locationInModule": {
|
|
11814
|
-
"filename": "src/
|
|
11815
|
-
"line":
|
|
11832
|
+
"filename": "src/image-builders/components.ts",
|
|
11833
|
+
"line": 263
|
|
11816
11834
|
},
|
|
11817
11835
|
"name": "githubRunner",
|
|
11818
11836
|
"parameters": [
|
|
@@ -11840,8 +11858,8 @@
|
|
|
11840
11858
|
"summary": "A component to set up the required Lambda entrypoint for Lambda runners."
|
|
11841
11859
|
},
|
|
11842
11860
|
"locationInModule": {
|
|
11843
|
-
"filename": "src/
|
|
11844
|
-
"line":
|
|
11861
|
+
"filename": "src/image-builders/components.ts",
|
|
11862
|
+
"line": 497
|
|
11845
11863
|
},
|
|
11846
11864
|
"name": "lambdaEntrypoint",
|
|
11847
11865
|
"returns": {
|
|
@@ -11857,7 +11875,7 @@
|
|
|
11857
11875
|
"summary": "A component to install the required packages for the runner."
|
|
11858
11876
|
},
|
|
11859
11877
|
"locationInModule": {
|
|
11860
|
-
"filename": "src/
|
|
11878
|
+
"filename": "src/image-builders/components.ts",
|
|
11861
11879
|
"line": 74
|
|
11862
11880
|
},
|
|
11863
11881
|
"name": "requiredPackages",
|
|
@@ -11874,8 +11892,8 @@
|
|
|
11874
11892
|
"summary": "A component to prepare the required runner user."
|
|
11875
11893
|
},
|
|
11876
11894
|
"locationInModule": {
|
|
11877
|
-
"filename": "src/
|
|
11878
|
-
"line":
|
|
11895
|
+
"filename": "src/image-builders/components.ts",
|
|
11896
|
+
"line": 117
|
|
11879
11897
|
},
|
|
11880
11898
|
"name": "runnerUser",
|
|
11881
11899
|
"returns": {
|
|
@@ -11892,8 +11910,8 @@
|
|
|
11892
11910
|
"summary": "Returns assets to copy into the built image."
|
|
11893
11911
|
},
|
|
11894
11912
|
"locationInModule": {
|
|
11895
|
-
"filename": "src/
|
|
11896
|
-
"line":
|
|
11913
|
+
"filename": "src/image-builders/components.ts",
|
|
11914
|
+
"line": 546
|
|
11897
11915
|
},
|
|
11898
11916
|
"name": "getAssets",
|
|
11899
11917
|
"parameters": [
|
|
@@ -11929,8 +11947,8 @@
|
|
|
11929
11947
|
"summary": "Returns commands to run to in built image."
|
|
11930
11948
|
},
|
|
11931
11949
|
"locationInModule": {
|
|
11932
|
-
"filename": "src/
|
|
11933
|
-
"line":
|
|
11950
|
+
"filename": "src/image-builders/components.ts",
|
|
11951
|
+
"line": 541
|
|
11934
11952
|
},
|
|
11935
11953
|
"name": "getCommands",
|
|
11936
11954
|
"parameters": [
|
|
@@ -11965,8 +11983,8 @@
|
|
|
11965
11983
|
"summary": "Returns Docker commands to run to in built image."
|
|
11966
11984
|
},
|
|
11967
11985
|
"locationInModule": {
|
|
11968
|
-
"filename": "src/
|
|
11969
|
-
"line":
|
|
11986
|
+
"filename": "src/image-builders/components.ts",
|
|
11987
|
+
"line": 555
|
|
11970
11988
|
},
|
|
11971
11989
|
"name": "getDockerCommands",
|
|
11972
11990
|
"parameters": [
|
|
@@ -11993,6 +12011,36 @@
|
|
|
11993
12011
|
}
|
|
11994
12012
|
}
|
|
11995
12013
|
}
|
|
12014
|
+
},
|
|
12015
|
+
{
|
|
12016
|
+
"docs": {
|
|
12017
|
+
"stability": "experimental",
|
|
12018
|
+
"summary": "Returns true if the image builder should be rebooted after this component is installed."
|
|
12019
|
+
},
|
|
12020
|
+
"locationInModule": {
|
|
12021
|
+
"filename": "src/image-builders/components.ts",
|
|
12022
|
+
"line": 562
|
|
12023
|
+
},
|
|
12024
|
+
"name": "shouldReboot",
|
|
12025
|
+
"parameters": [
|
|
12026
|
+
{
|
|
12027
|
+
"name": "_os",
|
|
12028
|
+
"type": {
|
|
12029
|
+
"fqn": "@cloudsnorkel/cdk-github-runners.Os"
|
|
12030
|
+
}
|
|
12031
|
+
},
|
|
12032
|
+
{
|
|
12033
|
+
"name": "_architecture",
|
|
12034
|
+
"type": {
|
|
12035
|
+
"fqn": "@cloudsnorkel/cdk-github-runners.Architecture"
|
|
12036
|
+
}
|
|
12037
|
+
}
|
|
12038
|
+
],
|
|
12039
|
+
"returns": {
|
|
12040
|
+
"type": {
|
|
12041
|
+
"primitive": "boolean"
|
|
12042
|
+
}
|
|
12043
|
+
}
|
|
11996
12044
|
}
|
|
11997
12045
|
],
|
|
11998
12046
|
"name": "RunnerImageComponent",
|
|
@@ -12006,8 +12054,8 @@
|
|
|
12006
12054
|
},
|
|
12007
12055
|
"immutable": true,
|
|
12008
12056
|
"locationInModule": {
|
|
12009
|
-
"filename": "src/
|
|
12010
|
-
"line":
|
|
12057
|
+
"filename": "src/image-builders/components.ts",
|
|
12058
|
+
"line": 536
|
|
12011
12059
|
},
|
|
12012
12060
|
"name": "name",
|
|
12013
12061
|
"type": {
|
|
@@ -12015,7 +12063,7 @@
|
|
|
12015
12063
|
}
|
|
12016
12064
|
}
|
|
12017
12065
|
],
|
|
12018
|
-
"symbolId": "src/
|
|
12066
|
+
"symbolId": "src/image-builders/components:RunnerImageComponent"
|
|
12019
12067
|
},
|
|
12020
12068
|
"@cloudsnorkel/cdk-github-runners.RunnerImageComponentCustomProps": {
|
|
12021
12069
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
@@ -12026,7 +12074,7 @@
|
|
|
12026
12074
|
"fqn": "@cloudsnorkel/cdk-github-runners.RunnerImageComponentCustomProps",
|
|
12027
12075
|
"kind": "interface",
|
|
12028
12076
|
"locationInModule": {
|
|
12029
|
-
"filename": "src/
|
|
12077
|
+
"filename": "src/image-builders/components.ts",
|
|
12030
12078
|
"line": 8
|
|
12031
12079
|
},
|
|
12032
12080
|
"name": "RunnerImageComponentCustomProps",
|
|
@@ -12039,7 +12087,7 @@
|
|
|
12039
12087
|
},
|
|
12040
12088
|
"immutable": true,
|
|
12041
12089
|
"locationInModule": {
|
|
12042
|
-
"filename": "src/
|
|
12090
|
+
"filename": "src/image-builders/components.ts",
|
|
12043
12091
|
"line": 24
|
|
12044
12092
|
},
|
|
12045
12093
|
"name": "assets",
|
|
@@ -12061,7 +12109,7 @@
|
|
|
12061
12109
|
},
|
|
12062
12110
|
"immutable": true,
|
|
12063
12111
|
"locationInModule": {
|
|
12064
|
-
"filename": "src/
|
|
12112
|
+
"filename": "src/image-builders/components.ts",
|
|
12065
12113
|
"line": 19
|
|
12066
12114
|
},
|
|
12067
12115
|
"name": "commands",
|
|
@@ -12084,7 +12132,7 @@
|
|
|
12084
12132
|
},
|
|
12085
12133
|
"immutable": true,
|
|
12086
12134
|
"locationInModule": {
|
|
12087
|
-
"filename": "src/
|
|
12135
|
+
"filename": "src/image-builders/components.ts",
|
|
12088
12136
|
"line": 33
|
|
12089
12137
|
},
|
|
12090
12138
|
"name": "dockerCommands",
|
|
@@ -12107,7 +12155,7 @@
|
|
|
12107
12155
|
},
|
|
12108
12156
|
"immutable": true,
|
|
12109
12157
|
"locationInModule": {
|
|
12110
|
-
"filename": "src/
|
|
12158
|
+
"filename": "src/image-builders/components.ts",
|
|
12111
12159
|
"line": 14
|
|
12112
12160
|
},
|
|
12113
12161
|
"name": "name",
|
|
@@ -12117,7 +12165,7 @@
|
|
|
12117
12165
|
}
|
|
12118
12166
|
}
|
|
12119
12167
|
],
|
|
12120
|
-
"symbolId": "src/
|
|
12168
|
+
"symbolId": "src/image-builders/components:RunnerImageComponentCustomProps"
|
|
12121
12169
|
},
|
|
12122
12170
|
"@cloudsnorkel/cdk-github-runners.RunnerProviderProps": {
|
|
12123
12171
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
@@ -12517,7 +12565,7 @@
|
|
|
12517
12565
|
},
|
|
12518
12566
|
"kind": "class",
|
|
12519
12567
|
"locationInModule": {
|
|
12520
|
-
"filename": "src/
|
|
12568
|
+
"filename": "src/image-builders/static.ts",
|
|
12521
12569
|
"line": 10
|
|
12522
12570
|
},
|
|
12523
12571
|
"methods": [
|
|
@@ -12528,7 +12576,7 @@
|
|
|
12528
12576
|
"summary": "Create a builder from an existing Docker Hub image."
|
|
12529
12577
|
},
|
|
12530
12578
|
"locationInModule": {
|
|
12531
|
-
"filename": "src/
|
|
12579
|
+
"filename": "src/image-builders/static.ts",
|
|
12532
12580
|
"line": 48
|
|
12533
12581
|
},
|
|
12534
12582
|
"name": "fromDockerHub",
|
|
@@ -12589,7 +12637,7 @@
|
|
|
12589
12637
|
"summary": "Create a builder (that doesn't actually build anything) from an existing image in an existing repository."
|
|
12590
12638
|
},
|
|
12591
12639
|
"locationInModule": {
|
|
12592
|
-
"filename": "src/
|
|
12640
|
+
"filename": "src/image-builders/static.ts",
|
|
12593
12641
|
"line": 19
|
|
12594
12642
|
},
|
|
12595
12643
|
"name": "fromEcrRepository",
|
|
@@ -12643,7 +12691,7 @@
|
|
|
12643
12691
|
}
|
|
12644
12692
|
],
|
|
12645
12693
|
"name": "StaticRunnerImage",
|
|
12646
|
-
"symbolId": "src/
|
|
12694
|
+
"symbolId": "src/image-builders/static:StaticRunnerImage"
|
|
12647
12695
|
},
|
|
12648
12696
|
"@cloudsnorkel/cdk-github-runners.WindowsComponents": {
|
|
12649
12697
|
"assembly": "@cloudsnorkel/cdk-github-runners",
|
|
@@ -12661,8 +12709,8 @@
|
|
|
12661
12709
|
},
|
|
12662
12710
|
"kind": "class",
|
|
12663
12711
|
"locationInModule": {
|
|
12664
|
-
"filename": "src/
|
|
12665
|
-
"line":
|
|
12712
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/windows-components.ts",
|
|
12713
|
+
"line": 12
|
|
12666
12714
|
},
|
|
12667
12715
|
"methods": [
|
|
12668
12716
|
{
|
|
@@ -12670,8 +12718,8 @@
|
|
|
12670
12718
|
"stability": "deprecated"
|
|
12671
12719
|
},
|
|
12672
12720
|
"locationInModule": {
|
|
12673
|
-
"filename": "src/
|
|
12674
|
-
"line":
|
|
12721
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/windows-components.ts",
|
|
12722
|
+
"line": 25
|
|
12675
12723
|
},
|
|
12676
12724
|
"name": "awsCli",
|
|
12677
12725
|
"parameters": [
|
|
@@ -12700,8 +12748,8 @@
|
|
|
12700
12748
|
"stability": "deprecated"
|
|
12701
12749
|
},
|
|
12702
12750
|
"locationInModule": {
|
|
12703
|
-
"filename": "src/
|
|
12704
|
-
"line":
|
|
12751
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/windows-components.ts",
|
|
12752
|
+
"line": 13
|
|
12705
12753
|
},
|
|
12706
12754
|
"name": "cloudwatchAgent",
|
|
12707
12755
|
"parameters": [
|
|
@@ -12730,8 +12778,8 @@
|
|
|
12730
12778
|
"stability": "deprecated"
|
|
12731
12779
|
},
|
|
12732
12780
|
"locationInModule": {
|
|
12733
|
-
"filename": "src/
|
|
12734
|
-
"line":
|
|
12781
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/windows-components.ts",
|
|
12782
|
+
"line": 99
|
|
12735
12783
|
},
|
|
12736
12784
|
"name": "docker",
|
|
12737
12785
|
"parameters": [
|
|
@@ -12760,8 +12808,8 @@
|
|
|
12760
12808
|
"stability": "deprecated"
|
|
12761
12809
|
},
|
|
12762
12810
|
"locationInModule": {
|
|
12763
|
-
"filename": "src/
|
|
12764
|
-
"line":
|
|
12811
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/windows-components.ts",
|
|
12812
|
+
"line": 109
|
|
12765
12813
|
},
|
|
12766
12814
|
"name": "extraCertificates",
|
|
12767
12815
|
"parameters": [
|
|
@@ -12796,8 +12844,8 @@
|
|
|
12796
12844
|
"stability": "deprecated"
|
|
12797
12845
|
},
|
|
12798
12846
|
"locationInModule": {
|
|
12799
|
-
"filename": "src/
|
|
12800
|
-
"line":
|
|
12847
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/windows-components.ts",
|
|
12848
|
+
"line": 54
|
|
12801
12849
|
},
|
|
12802
12850
|
"name": "git",
|
|
12803
12851
|
"parameters": [
|
|
@@ -12826,8 +12874,8 @@
|
|
|
12826
12874
|
"stability": "deprecated"
|
|
12827
12875
|
},
|
|
12828
12876
|
"locationInModule": {
|
|
12829
|
-
"filename": "src/
|
|
12830
|
-
"line":
|
|
12877
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/windows-components.ts",
|
|
12878
|
+
"line": 37
|
|
12831
12879
|
},
|
|
12832
12880
|
"name": "githubCli",
|
|
12833
12881
|
"parameters": [
|
|
@@ -12856,8 +12904,8 @@
|
|
|
12856
12904
|
"stability": "deprecated"
|
|
12857
12905
|
},
|
|
12858
12906
|
"locationInModule": {
|
|
12859
|
-
"filename": "src/
|
|
12860
|
-
"line":
|
|
12907
|
+
"filename": "src/image-builders/aws-image-builder/deprecated/windows-components.ts",
|
|
12908
|
+
"line": 74
|
|
12861
12909
|
},
|
|
12862
12910
|
"name": "githubRunner",
|
|
12863
12911
|
"parameters": [
|
|
@@ -12889,9 +12937,9 @@
|
|
|
12889
12937
|
}
|
|
12890
12938
|
],
|
|
12891
12939
|
"name": "WindowsComponents",
|
|
12892
|
-
"symbolId": "src/
|
|
12940
|
+
"symbolId": "src/image-builders/aws-image-builder/deprecated/windows-components:WindowsComponents"
|
|
12893
12941
|
}
|
|
12894
12942
|
},
|
|
12895
|
-
"version": "0.9.
|
|
12896
|
-
"fingerprint": "
|
|
12943
|
+
"version": "0.9.6",
|
|
12944
|
+
"fingerprint": "dXLB8R7bVjXz9NvFFt0Yd2eBeyqrjen4wC9L+uovCr0="
|
|
12897
12945
|
}
|