cloudsnorkel.cdk-github-runners 0.13.3__py3-none-any.whl → 0.14.0__py3-none-any.whl

cloudsnorkel/cdk_github_runners/__init__.py

@@ -11,11 +11,11 @@
 
 Use this CDK construct to create ephemeral [self-hosted GitHub runners](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) on-demand inside your AWS account.
 
-* Easy to configure GitHub integration with a web-based interface
-* Customizable runners with decent defaults
-* Multiple runner configurations controlled by labels
-* Everything fully hosted in your account
-* Automatically updated build environment with latest runner version
+* 🧩 Easy to configure GitHub integration with a web-based interface
+* 🧠 Customizable runners with decent defaults
+* 🏃🏻 Multiple runner configurations controlled by labels
+* 🔐 Everything fully hosted in your account
+* 🔃 Automatically updated build environment with latest runner version
 
 Self-hosted runners in AWS are useful when:
 
@@ -323,6 +323,20 @@ Other useful metrics to track:
 1. Use `GitHubRunners.metricJobCompleted()` to get a metric for the number of completed jobs broken down by labels and job success.
 2. Use `GitHubRunners.metricTime()` to get a metric for the total time a runner is running. This includes the overhead of starting the runner.
 
+## Contributing
+
+If you use and love this project, please consider contributing.
+
+1. 🪳 If you see something, say something. [Issues](https://github.com/CloudSnorkel/cdk-github-runners/issues) help improve the quality of the project.
+
+   * Include relevant logs and package versions for bugs.
+   * When possible, describe the use-case behind feature requests.
+2. 🛠️ [Pull requests](https://github.com/CloudSnorkel/cdk-github-runners/pulls) are welcome.
+
+   * Run `npm run build` before submitting to make sure all tests pass.
+   * Allow edits from maintainers so small adjustments can be made easily.
+3. 💵 Consider [sponsoring](https://github.com/sponsors/CloudSnorkel) the project to show your support and optionally get your name listed below.
+
 ## Other Options
 
 1. [philips-labs/terraform-aws-github-runner](https://github.com/philips-labs/terraform-aws-github-runner) if you're using Terraform
@@ -401,7 +415,7 @@ class AmiBuilderProps:
 
         :param architecture: (experimental) Image architecture. Default: Architecture.X86_64
         :param install_docker: (experimental) Install Docker inside the image, so it can be used by the runner. Default: true
-        :param instance_type: (experimental) The instance type used to build the image. Default: m5.large
+        :param instance_type: (experimental) The instance type used to build the image. Default: m6i.large
         :param log_removal_policy: (experimental) Removal policy for logs of image builds. If deployment fails on the custom resource, try setting this to ``RemovalPolicy.RETAIN``. This way the logs can still be viewed, and you can see why the build failed. We try to not leave anything behind when removed. But sometimes a log staying behind is useful. Default: RemovalPolicy.DESTROY
         :param log_retention: (experimental) The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to ``INFINITE``. Default: logs.RetentionDays.ONE_MONTH
         :param os: (experimental) Image OS. Default: OS.LINUX
@@ -482,7 +496,7 @@ class AmiBuilderProps:
     def instance_type(self) -> typing.Optional[_aws_cdk_aws_ec2_ceddda9d.InstanceType]:
         '''(experimental) The instance type used to build the image.
 
-        :default: m5.large
+        :default: m6i.large
 
         :stability: experimental
         '''
@@ -826,7 +840,7 @@ class AwsImageBuilderRunnerImageBuilderProps:
     ) -> None:
         '''
         :param fast_launch_options: (experimental) Options for fast launch. This is only supported for Windows AMIs. Default: disabled
-        :param instance_type: (experimental) The instance type used to build the image. Default: m5.large
+        :param instance_type: (experimental) The instance type used to build the image. Default: m6i.large
 
         :stability: experimental
         '''
@@ -859,7 +873,7 @@ class AwsImageBuilderRunnerImageBuilderProps:
     def instance_type(self) -> typing.Optional[_aws_cdk_aws_ec2_ceddda9d.InstanceType]:
         '''(experimental) The instance type used to build the image.
 
-        :default: m5.large
+        :default: m6i.large
 
         :stability: experimental
         '''
@@ -1298,7 +1312,7 @@ class ContainerImageBuilderProps:
         '''(experimental) Properties for ContainerImageBuilder construct.
 
         :param architecture: (experimental) Image architecture. Default: Architecture.X86_64
-        :param instance_type: (experimental) The instance type used to build the image. Default: m5.large
+        :param instance_type: (experimental) The instance type used to build the image. Default: m6i.large
         :param log_removal_policy: (experimental) Removal policy for logs of image builds. If deployment fails on the custom resource, try setting this to ``RemovalPolicy.RETAIN``. This way the CodeBuild logs can still be viewed, and you can see why the build failed. We try to not leave anything behind when removed. But sometimes a log staying behind is useful. Default: RemovalPolicy.DESTROY
         :param log_retention: (experimental) The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to ``INFINITE``. Default: logs.RetentionDays.ONE_MONTH
         :param os: (experimental) Image OS. Default: OS.LINUX
@@ -1369,7 +1383,7 @@ class ContainerImageBuilderProps:
     def instance_type(self) -> typing.Optional[_aws_cdk_aws_ec2_ceddda9d.InstanceType]:
         '''(experimental) The instance type used to build the image.
 
-        :default: m5.large
+        :default: m6i.large
 
         :stability: experimental
         '''
@@ -3478,7 +3492,7 @@ class LambdaRunnerProvider(
 
         You can add components to the image builder by calling ``imageBuilder.addComponent()``.
 
-        The default OS is Amazon Linux 2 running on x64 architecture.
+        The default OS is Amazon Linux 2023 running on x64 architecture.
 
         Included components:
 
@@ -3490,8 +3504,6 @@ class LambdaRunnerProvider(
         - ``RunnerImageComponent.githubRunner()``
         - ``RunnerImageComponent.lambdaEntrypoint()``
 
-        Base Docker image: ``public.ecr.aws/lambda/nodejs:20-x86_64`` or ``public.ecr.aws/lambda/nodejs:20-arm64``
-
         :param scope: -
         :param id: -
         :param architecture: (experimental) Image architecture. Default: Architecture.X86_64
@@ -5947,7 +5959,7 @@ class AmiBuilder(
         :param id: -
         :param architecture: (experimental) Image architecture. Default: Architecture.X86_64
         :param install_docker: (experimental) Install Docker inside the image, so it can be used by the runner. Default: true
-        :param instance_type: (experimental) The instance type used to build the image. Default: m5.large
+        :param instance_type: (experimental) The instance type used to build the image. Default: m6i.large
         :param log_removal_policy: (experimental) Removal policy for logs of image builds. If deployment fails on the custom resource, try setting this to ``RemovalPolicy.RETAIN``. This way the logs can still be viewed, and you can see why the build failed. We try to not leave anything behind when removed. But sometimes a log staying behind is useful. Default: RemovalPolicy.DESTROY
         :param log_retention: (experimental) The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to ``INFINITE``. Default: logs.RetentionDays.ONE_MONTH
         :param os: (experimental) Image OS. Default: OS.LINUX
@@ -7104,7 +7116,7 @@ class ContainerImageBuilder(
         :param scope: -
         :param id: -
         :param architecture: (experimental) Image architecture. Default: Architecture.X86_64
-        :param instance_type: (experimental) The instance type used to build the image. Default: m5.large
+        :param instance_type: (experimental) The instance type used to build the image. Default: m6i.large
         :param log_removal_policy: (experimental) Removal policy for logs of image builds. If deployment fails on the custom resource, try setting this to ``RemovalPolicy.RETAIN``. This way the CodeBuild logs can still be viewed, and you can see why the build failed. We try to not leave anything behind when removed. But sometimes a log staying behind is useful. Default: RemovalPolicy.DESTROY
         :param log_retention: (experimental) The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to ``INFINITE``. Default: logs.RetentionDays.ONE_MONTH
         :param os: (experimental) Image OS. Default: OS.LINUX
@@ -7397,7 +7409,7 @@ class Ec2RunnerProvider(
         :param id: -
         :param ami_builder: 
         :param image_builder: (experimental) Runner image builder used to build AMI containing GitHub Runner and all requirements. The image builder determines the OS and architecture of the runner. Default: Ec2RunnerProvider.imageBuilder()
-        :param instance_type: (experimental) Instance type for launched runner instances. Default: m5.large
+        :param instance_type: (experimental) Instance type for launched runner instances. Default: m6i.large
         :param labels: (experimental) GitHub Actions labels used for this provider. These labels are used to identify which provider should spawn a new on-demand runner. Every job sends a webhook with the labels it's looking for based on runs-on. We match the labels from the webhook with the labels specified here. If all the labels specified here are present in the job's labels, this provider will be chosen and spawn a new runner. Default: ['ec2']
         :param security_group: (deprecated) Security Group to assign to launched runner instances. Default: a new security group
         :param security_groups: (experimental) Security groups to assign to launched runner instances. Default: a new security group
@@ -7712,7 +7724,7 @@ class Ec2RunnerProviderProps(RunnerProviderProps):
         :param retry_options: 
         :param ami_builder: 
         :param image_builder: (experimental) Runner image builder used to build AMI containing GitHub Runner and all requirements. The image builder determines the OS and architecture of the runner. Default: Ec2RunnerProvider.imageBuilder()
-        :param instance_type: (experimental) Instance type for launched runner instances. Default: m5.large
+        :param instance_type: (experimental) Instance type for launched runner instances. Default: m6i.large
         :param labels: (experimental) GitHub Actions labels used for this provider. These labels are used to identify which provider should spawn a new on-demand runner. Every job sends a webhook with the labels it's looking for based on runs-on. We match the labels from the webhook with the labels specified here. If all the labels specified here are present in the job's labels, this provider will be chosen and spawn a new runner. Default: ['ec2']
         :param security_group: (deprecated) Security Group to assign to launched runner instances. Default: a new security group
         :param security_groups: (experimental) Security groups to assign to launched runner instances. Default: a new security group
@@ -7829,7 +7841,7 @@ class Ec2RunnerProviderProps(RunnerProviderProps):
     def instance_type(self) -> typing.Optional[_aws_cdk_aws_ec2_ceddda9d.InstanceType]:
         '''(experimental) Instance type for launched runner instances.
 
-        :default: m5.large
+        :default: m6i.large
 
         :stability: experimental
         '''
@@ -8019,7 +8031,7 @@ class EcsRunnerProvider(
         :param cpu: (experimental) The number of cpu units used by the task. 1024 units is 1 vCPU. Fractions of a vCPU are supported. Default: 1024
         :param docker_in_docker: (experimental) Support building and running Docker images by enabling Docker-in-Docker (dind) and the required CodeBuild privileged mode. Disabling this can speed up provisioning of CodeBuild runners. If you don't intend on running or building Docker images, disable this for faster start-up times. Default: true
         :param image_builder: (experimental) Runner image builder used to build Docker images containing GitHub Runner and all requirements. The image builder determines the OS and architecture of the runner. Default: EcsRunnerProvider.imageBuilder()
-        :param instance_type: (experimental) Instance type of ECS cluster instances. Only used when creating a new cluster. Default: m5.large or m6g.large
+        :param instance_type: (experimental) Instance type of ECS cluster instances. Only used when creating a new cluster. Default: m6i.large or m6g.large
         :param labels: (experimental) GitHub Actions labels used for this provider. These labels are used to identify which provider should spawn a new on-demand runner. Every job sends a webhook with the labels it's looking for based on runs-on. We match the labels from the webhook with the labels specified here. If all the labels specified here are present in the job's labels, this provider will be chosen and spawn a new runner. Default: ['ecs']
         :param max_instances: (experimental) The maximum number of instances to run in the cluster. Only used when creating a new cluster. Default: 5
         :param memory_limit_mib: (experimental) The amount (in MiB) of memory used by the task. Default: 3500, unless ``memoryReservationMiB`` is used and then it's undefined
@@ -8355,7 +8367,7 @@ class EcsRunnerProviderProps(RunnerProviderProps):
         :param cpu: (experimental) The number of cpu units used by the task. 1024 units is 1 vCPU. Fractions of a vCPU are supported. Default: 1024
         :param docker_in_docker: (experimental) Support building and running Docker images by enabling Docker-in-Docker (dind) and the required CodeBuild privileged mode. Disabling this can speed up provisioning of CodeBuild runners. If you don't intend on running or building Docker images, disable this for faster start-up times. Default: true
         :param image_builder: (experimental) Runner image builder used to build Docker images containing GitHub Runner and all requirements. The image builder determines the OS and architecture of the runner. Default: EcsRunnerProvider.imageBuilder()
-        :param instance_type: (experimental) Instance type of ECS cluster instances. Only used when creating a new cluster. Default: m5.large or m6g.large
+        :param instance_type: (experimental) Instance type of ECS cluster instances. Only used when creating a new cluster. Default: m6i.large or m6g.large
         :param labels: (experimental) GitHub Actions labels used for this provider. These labels are used to identify which provider should spawn a new on-demand runner. Every job sends a webhook with the labels it's looking for based on runs-on. We match the labels from the webhook with the labels specified here. If all the labels specified here are present in the job's labels, this provider will be chosen and spawn a new runner. Default: ['ecs']
         :param max_instances: (experimental) The maximum number of instances to run in the cluster. Only used when creating a new cluster. Default: 5
         :param memory_limit_mib: (experimental) The amount (in MiB) of memory used by the task. Default: 3500, unless ``memoryReservationMiB`` is used and then it's undefined
@@ -8550,7 +8562,7 @@ class EcsRunnerProviderProps(RunnerProviderProps):
 
         Only used when creating a new cluster.
 
-        :default: m5.large or m6g.large
+        :default: m6i.large or m6g.large
 
         :stability: experimental
         '''
@@ -10316,7 +10328,7 @@ class Ec2Runner(
         :param id: -
         :param ami_builder: 
         :param image_builder: (experimental) Runner image builder used to build AMI containing GitHub Runner and all requirements. The image builder determines the OS and architecture of the runner. Default: Ec2RunnerProvider.imageBuilder()
-        :param instance_type: (experimental) Instance type for launched runner instances. Default: m5.large
+        :param instance_type: (experimental) Instance type for launched runner instances. Default: m6i.large
         :param labels: (experimental) GitHub Actions labels used for this provider. These labels are used to identify which provider should spawn a new on-demand runner. Every job sends a webhook with the labels it's looking for based on runs-on. We match the labels from the webhook with the labels specified here. If all the labels specified here are present in the job's labels, this provider will be chosen and spawn a new runner. Default: ['ec2']
         :param security_group: (deprecated) Security Group to assign to launched runner instances. Default: a new security group
         :param security_groups: (experimental) Security groups to assign to launched runner instances. Default: a new security group

cloudsnorkel/cdk_github_runners/_jsii/__init__.py

@@ -18,9 +18,9 @@ import constructs._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
     "@cloudsnorkel/cdk-github-runners",
-    "0.13.3",
+    "0.14.0",
     __name__[0:-6],
-    "cdk-github-runners@0.13.3.jsii.tgz",
+    "cdk-github-runners@0.14.0.jsii.tgz",
 )
 
 __all__ = [

{cloudsnorkel.cdk_github_runners-0.13.3.dist-info → cloudsnorkel.cdk_github_runners-0.14.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cloudsnorkel.cdk-github-runners
-Version: 0.13.3
+Version: 0.14.0
 Summary: CDK construct to create GitHub Actions self-hosted runners. A webhook listens to events and creates ephemeral runners on the fly.
 Home-page: https://github.com/CloudSnorkel/cdk-github-runners.git
 Author: Amir Szekely<amir@cloudsnorkel.com>
@@ -38,11 +38,11 @@ Requires-Dist: typeguard ~=2.13.3
 
 Use this CDK construct to create ephemeral [self-hosted GitHub runners](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) on-demand inside your AWS account.
 
-* Easy to configure GitHub integration with a web-based interface
-* Customizable runners with decent defaults
-* Multiple runner configurations controlled by labels
-* Everything fully hosted in your account
-* Automatically updated build environment with latest runner version
+* 🧩 Easy to configure GitHub integration with a web-based interface
+* 🧠 Customizable runners with decent defaults
+* 🏃🏻 Multiple runner configurations controlled by labels
+* 🔐 Everything fully hosted in your account
+* 🔃 Automatically updated build environment with latest runner version
 
 Self-hosted runners in AWS are useful when:
 
@@ -350,6 +350,20 @@ Other useful metrics to track:
 1. Use `GitHubRunners.metricJobCompleted()` to get a metric for the number of completed jobs broken down by labels and job success.
 2. Use `GitHubRunners.metricTime()` to get a metric for the total time a runner is running. This includes the overhead of starting the runner.
 
+## Contributing
+
+If you use and love this project, please consider contributing.
+
+1. 🪳 If you see something, say something. [Issues](https://github.com/CloudSnorkel/cdk-github-runners/issues) help improve the quality of the project.
+
+   * Include relevant logs and package versions for bugs.
+   * When possible, describe the use-case behind feature requests.
+2. 🛠️ [Pull requests](https://github.com/CloudSnorkel/cdk-github-runners/pulls) are welcome.
+
+   * Run `npm run build` before submitting to make sure all tests pass.
+   * Allow edits from maintainers so small adjustments can be made easily.
+3. 💵 Consider [sponsoring](https://github.com/sponsors/CloudSnorkel) the project to show your support and optionally get your name listed below.
+
 ## Other Options
 
 1. [philips-labs/terraform-aws-github-runner](https://github.com/philips-labs/terraform-aws-github-runner) if you're using Terraform

cloudsnorkel.cdk_github_runners-0.14.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+cloudsnorkel/cdk_github_runners/__init__.py,sha256=6whEOjco3SRb1o4zqarcwjlMOP-8qCea6zRiPjM-LXI,603073
+cloudsnorkel/cdk_github_runners/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+cloudsnorkel/cdk_github_runners/_jsii/__init__.py,sha256=ybGTips70JpXvdycduH85-0aqPjleMHG7hQjDlr8KG4,508
+cloudsnorkel/cdk_github_runners/_jsii/cdk-github-runners@0.14.0.jsii.tgz,sha256=kQo2SzrU0_Ef5YDvEKh0J8IRwkAC96gQiZRgvpwilYM,1438814
+cloudsnorkel.cdk_github_runners-0.14.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+cloudsnorkel.cdk_github_runners-0.14.0.dist-info/METADATA,sha256=XwbXG8Aq-1H_3NF4rxeXHtJ0Vzc7R-ny44x8DCB1Pdg,16467
+cloudsnorkel.cdk_github_runners-0.14.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+cloudsnorkel.cdk_github_runners-0.14.0.dist-info/top_level.txt,sha256=6vUrT-dcGOiRMT4Q6gEQPznoyS7nHOJ269MHpo4DEd8,13
+cloudsnorkel.cdk_github_runners-0.14.0.dist-info/RECORD,,

cloudsnorkel.cdk_github_runners-0.13.3.dist-info/RECORD

@@ -1,9 +0,0 @@
-cloudsnorkel/cdk_github_runners/__init__.py,sha256=ujO9tqWBYZP7a3dgjsmy6QWYBY5bGMH5WLmRA9pDg8Q,602385
-cloudsnorkel/cdk_github_runners/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-cloudsnorkel/cdk_github_runners/_jsii/__init__.py,sha256=t78xFxuof8Y48ayy0qCw_sFWZu6hYERk-ZBOVQVJIFY,508
-cloudsnorkel/cdk_github_runners/_jsii/cdk-github-runners@0.13.3.jsii.tgz,sha256=VCbnCYwMGts_SVXHu30tcZYTIOoFDX33nN9mn48s_KI,1437512
-cloudsnorkel.cdk_github_runners-0.13.3.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-cloudsnorkel.cdk_github_runners-0.13.3.dist-info/METADATA,sha256=nYlr8Oyr44ZvmnRechkAkgHrsXm9Jzs5QfRhRV4pF0s,15681
-cloudsnorkel.cdk_github_runners-0.13.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-cloudsnorkel.cdk_github_runners-0.13.3.dist-info/top_level.txt,sha256=6vUrT-dcGOiRMT4Q6gEQPznoyS7nHOJ269MHpo4DEd8,13
-cloudsnorkel.cdk_github_runners-0.13.3.dist-info/RECORD,,