cloudsnorkel.cdk-github-runners 0.15.4__tar.gz → 0.16.0__tar.gz
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.
- {cloudsnorkel_cdk_github_runners-0.15.4/src/cloudsnorkel.cdk_github_runners.egg-info → cloudsnorkel_cdk_github_runners-0.16.0}/PKG-INFO +3 -2
- {cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0}/README.md +1 -0
- {cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0}/setup.py +3 -3
- {cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0}/src/cloudsnorkel/cdk_github_runners/__init__.py +109 -25
- {cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0}/src/cloudsnorkel/cdk_github_runners/_jsii/__init__.py +2 -2
- cloudsnorkel_cdk_github_runners-0.16.0/src/cloudsnorkel/cdk_github_runners/_jsii/cdk-github-runners@0.16.0.jsii.tgz +0 -0
- {cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0/src/cloudsnorkel.cdk_github_runners.egg-info}/PKG-INFO +3 -2
- {cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0}/src/cloudsnorkel.cdk_github_runners.egg-info/SOURCES.txt +1 -1
- {cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0}/src/cloudsnorkel.cdk_github_runners.egg-info/requires.txt +1 -1
- cloudsnorkel_cdk_github_runners-0.15.4/src/cloudsnorkel/cdk_github_runners/_jsii/cdk-github-runners@0.15.4.jsii.tgz +0 -0
- {cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0}/LICENSE +0 -0
- {cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0}/MANIFEST.in +0 -0
- {cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0}/pyproject.toml +0 -0
- {cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0}/setup.cfg +0 -0
- {cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0}/src/cloudsnorkel/cdk_github_runners/py.typed +0 -0
- {cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0}/src/cloudsnorkel.cdk_github_runners.egg-info/dependency_links.txt +0 -0
- {cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0}/src/cloudsnorkel.cdk_github_runners.egg-info/top_level.txt +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: cloudsnorkel.cdk-github-runners
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.16.0
|
|
4
4
|
Summary: CDK construct to create GitHub Actions self-hosted runners. Creates ephemeral runners on demand. Easy to deploy and highly customizable.
|
|
5
5
|
Home-page: https://github.com/CloudSnorkel/cdk-github-runners.git
|
|
6
6
|
Author: Amir Szekely<amir@cloudsnorkel.com>
|
|
@@ -23,7 +23,7 @@ Description-Content-Type: text/markdown
|
|
|
23
23
|
License-File: LICENSE
|
|
24
24
|
Requires-Dist: aws-cdk-lib<3.0.0,>=2.239.0
|
|
25
25
|
Requires-Dist: constructs<11.0.0,>=10.5.1
|
|
26
|
-
Requires-Dist: jsii<2.0.0,>=1.
|
|
26
|
+
Requires-Dist: jsii<2.0.0,>=1.139.0
|
|
27
27
|
Requires-Dist: publication>=0.0.3
|
|
28
28
|
|
|
29
29
|
# GitHub Self-Hosted Runners CDK Constructs
|
|
@@ -659,6 +659,7 @@ Other useful metrics to track:
|
|
|
659
659
|
|
|
660
660
|
1. Use `GitHubRunners.metricJobCompleted()` to get a metric for the number of completed jobs broken down by labels and job success.
|
|
661
661
|
2. Use `GitHubRunners.metricTime()` to get a metric for the total time a runner is running. This includes the overhead of starting the runner.
|
|
662
|
+
3. Use `GitHubRunners.metricStolenRunners()` to get a metric for number of runners detected as stolen by another job. Anything over zero can indicate a misconfiguration or GitHub webhook issues.
|
|
662
663
|
|
|
663
664
|
## Known Issues
|
|
664
665
|
|
|
@@ -631,6 +631,7 @@ Other useful metrics to track:
|
|
|
631
631
|
|
|
632
632
|
1. Use `GitHubRunners.metricJobCompleted()` to get a metric for the number of completed jobs broken down by labels and job success.
|
|
633
633
|
2. Use `GitHubRunners.metricTime()` to get a metric for the total time a runner is running. This includes the overhead of starting the runner.
|
|
634
|
+
3. Use `GitHubRunners.metricStolenRunners()` to get a metric for number of runners detected as stolen by another job. Anything over zero can indicate a misconfiguration or GitHub webhook issues.
|
|
634
635
|
|
|
635
636
|
## Known Issues
|
|
636
637
|
|
|
@@ -5,7 +5,7 @@ kwargs = json.loads(
|
|
|
5
5
|
"""
|
|
6
6
|
{
|
|
7
7
|
"name": "cloudsnorkel.cdk-github-runners",
|
|
8
|
-
"version": "0.
|
|
8
|
+
"version": "0.16.0",
|
|
9
9
|
"description": "CDK construct to create GitHub Actions self-hosted runners. Creates ephemeral runners on demand. Easy to deploy and highly customizable.",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"url": "https://github.com/CloudSnorkel/cdk-github-runners.git",
|
|
@@ -26,7 +26,7 @@ kwargs = json.loads(
|
|
|
26
26
|
],
|
|
27
27
|
"package_data": {
|
|
28
28
|
"cloudsnorkel.cdk_github_runners._jsii": [
|
|
29
|
-
"cdk-github-runners@0.
|
|
29
|
+
"cdk-github-runners@0.16.0.jsii.tgz"
|
|
30
30
|
],
|
|
31
31
|
"cloudsnorkel.cdk_github_runners": [
|
|
32
32
|
"py.typed"
|
|
@@ -36,7 +36,7 @@ kwargs = json.loads(
|
|
|
36
36
|
"install_requires": [
|
|
37
37
|
"aws-cdk-lib>=2.239.0, <3.0.0",
|
|
38
38
|
"constructs>=10.5.1, <11.0.0",
|
|
39
|
-
"jsii>=1.
|
|
39
|
+
"jsii>=1.139.0, <2.0.0",
|
|
40
40
|
"publication>=0.0.3"
|
|
41
41
|
],
|
|
42
42
|
"classifiers": [
|
|
@@ -632,6 +632,7 @@ Other useful metrics to track:
|
|
|
632
632
|
|
|
633
633
|
1. Use `GitHubRunners.metricJobCompleted()` to get a metric for the number of completed jobs broken down by labels and job success.
|
|
634
634
|
2. Use `GitHubRunners.metricTime()` to get a metric for the total time a runner is running. This includes the overhead of starting the runner.
|
|
635
|
+
3. Use `GitHubRunners.metricStolenRunners()` to get a metric for number of runners detected as stolen by another job. Anything over zero can indicate a misconfiguration or GitHub webhook issues.
|
|
635
636
|
|
|
636
637
|
## Known Issues
|
|
637
638
|
|
|
@@ -793,8 +794,7 @@ class AlwaysOnWarmRunner(
|
|
|
793
794
|
|
|
794
795
|
https://github.com/CloudSnorkel/cdk-github-runners/blob/main/SETUP_GITHUB.md
|
|
795
796
|
|
|
796
|
-
|
|
797
|
-
Limitations
|
|
797
|
+
**Limitations**
|
|
798
798
|
|
|
799
799
|
- Jobs will still trigger provisioning of on-demand runners, even if a warm runner ends up being used.
|
|
800
800
|
- You may briefly see more than ``count`` runners when changing config or at rotation.
|
|
@@ -1443,6 +1443,7 @@ class Architecture(
|
|
|
1443
1443
|
jsii_type="@cloudsnorkel/cdk-github-runners.AwsImageBuilderRunnerImageBuilderProps",
|
|
1444
1444
|
jsii_struct_bases=[],
|
|
1445
1445
|
name_mapping={
|
|
1446
|
+
"ami_tags": "amiTags",
|
|
1446
1447
|
"fast_launch_options": "fastLaunchOptions",
|
|
1447
1448
|
"instance_type": "instanceType",
|
|
1448
1449
|
"storage_size": "storageSize",
|
|
@@ -1452,11 +1453,13 @@ class AwsImageBuilderRunnerImageBuilderProps:
|
|
|
1452
1453
|
def __init__(
|
|
1453
1454
|
self,
|
|
1454
1455
|
*,
|
|
1456
|
+
ami_tags: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
1455
1457
|
fast_launch_options: typing.Optional[typing.Union["FastLaunchOptions", typing.Dict[builtins.str, typing.Any]]] = None,
|
|
1456
1458
|
instance_type: typing.Optional["_aws_cdk_aws_ec2_ceddda9d.InstanceType"] = None,
|
|
1457
1459
|
storage_size: typing.Optional["_aws_cdk_ceddda9d.Size"] = None,
|
|
1458
1460
|
) -> None:
|
|
1459
1461
|
'''
|
|
1462
|
+
:param ami_tags: (experimental) Additional tags to apply to the AMI built by this builder. These additional tags are set on top of ``Name``, ``GitHubRunners:Stack``, and ``GitHubRunners:Builder``. You may override the built-in tags. Default: no additional tags
|
|
1460
1463
|
:param fast_launch_options: (experimental) Options for fast launch. This is only supported for Windows AMIs. Default: disabled
|
|
1461
1464
|
:param instance_type: (experimental) The instance type used to build the image. Default: m6i.large
|
|
1462
1465
|
:param storage_size: (experimental) Size of volume available for builder instances. This modifies the boot volume size and doesn't add any additional volumes. Use this if you're building images with big components and need more space. Default: default size for AMI (usually 30GB for Linux and 50GB for Windows)
|
|
@@ -1467,10 +1470,13 @@ class AwsImageBuilderRunnerImageBuilderProps:
|
|
|
1467
1470
|
fast_launch_options = FastLaunchOptions(**fast_launch_options)
|
|
1468
1471
|
if __debug__:
|
|
1469
1472
|
type_hints = cached_type_hints(_typecheckingstub__fe17585d38b67015c3f03db2aefab095f171e0e0900c9a4564679bbc5a29fd07)
|
|
1473
|
+
check_type(argname="argument ami_tags", value=ami_tags, expected_type=type_hints["ami_tags"])
|
|
1470
1474
|
check_type(argname="argument fast_launch_options", value=fast_launch_options, expected_type=type_hints["fast_launch_options"])
|
|
1471
1475
|
check_type(argname="argument instance_type", value=instance_type, expected_type=type_hints["instance_type"])
|
|
1472
1476
|
check_type(argname="argument storage_size", value=storage_size, expected_type=type_hints["storage_size"])
|
|
1473
1477
|
self._values: typing.Dict[builtins.str, typing.Any] = {}
|
|
1478
|
+
if ami_tags is not None:
|
|
1479
|
+
self._values["ami_tags"] = ami_tags
|
|
1474
1480
|
if fast_launch_options is not None:
|
|
1475
1481
|
self._values["fast_launch_options"] = fast_launch_options
|
|
1476
1482
|
if instance_type is not None:
|
|
@@ -1478,6 +1484,20 @@ class AwsImageBuilderRunnerImageBuilderProps:
|
|
|
1478
1484
|
if storage_size is not None:
|
|
1479
1485
|
self._values["storage_size"] = storage_size
|
|
1480
1486
|
|
|
1487
|
+
@builtins.property
|
|
1488
|
+
def ami_tags(self) -> typing.Optional[typing.Mapping[builtins.str, builtins.str]]:
|
|
1489
|
+
'''(experimental) Additional tags to apply to the AMI built by this builder.
|
|
1490
|
+
|
|
1491
|
+
These additional tags are set on top of ``Name``, ``GitHubRunners:Stack``, and ``GitHubRunners:Builder``.
|
|
1492
|
+
You may override the built-in tags.
|
|
1493
|
+
|
|
1494
|
+
:default: no additional tags
|
|
1495
|
+
|
|
1496
|
+
:stability: experimental
|
|
1497
|
+
'''
|
|
1498
|
+
result = self._values.get("ami_tags")
|
|
1499
|
+
return typing.cast(typing.Optional[typing.Mapping[builtins.str, builtins.str]], result)
|
|
1500
|
+
|
|
1481
1501
|
@builtins.property
|
|
1482
1502
|
def fast_launch_options(self) -> typing.Optional["FastLaunchOptions"]:
|
|
1483
1503
|
'''(experimental) Options for fast launch.
|
|
@@ -2909,6 +2929,70 @@ class GitHubRunners(
|
|
|
2909
2929
|
|
|
2910
2930
|
return typing.cast("_aws_cdk_aws_cloudwatch_ceddda9d.Metric", jsii.invoke(self, "metricJobCompleted", [props]))
|
|
2911
2931
|
|
|
2932
|
+
@jsii.member(jsii_name="metricStolenRunners")
|
|
2933
|
+
def metric_stolen_runners(
|
|
2934
|
+
self,
|
|
2935
|
+
*,
|
|
2936
|
+
account: typing.Optional[builtins.str] = None,
|
|
2937
|
+
color: typing.Optional[builtins.str] = None,
|
|
2938
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
2939
|
+
id: typing.Optional[builtins.str] = None,
|
|
2940
|
+
label: typing.Optional[builtins.str] = None,
|
|
2941
|
+
period: typing.Optional["_aws_cdk_ceddda9d.Duration"] = None,
|
|
2942
|
+
region: typing.Optional[builtins.str] = None,
|
|
2943
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
2944
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
2945
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
2946
|
+
unit: typing.Optional["_aws_cdk_aws_cloudwatch_ceddda9d.Unit"] = None,
|
|
2947
|
+
visible: typing.Optional[builtins.bool] = None,
|
|
2948
|
+
) -> "_aws_cdk_aws_cloudwatch_ceddda9d.Metric":
|
|
2949
|
+
'''(experimental) Metric for the number of runners that were stolen by a job that shouldn't have been assigned to them.
|
|
2950
|
+
|
|
2951
|
+
A high number here means your runners are shared with jobs you didn't mean to serve. Use the "Stolen runners"
|
|
2952
|
+
CloudWatch Logs Insights query created by {@link createLogsInsightsQueries} to see which repositories and jobs
|
|
2953
|
+
are taking them.
|
|
2954
|
+
|
|
2955
|
+
This metric has two dimensions:
|
|
2956
|
+
|
|
2957
|
+
1. ``Replaced`` which is "true" or "false" indicating whether the stolen runner was replaced. A runner may not be replaced if it was stolen too
|
|
2958
|
+
many times in a row. The current limit is 3. When this is false, there is probably a bug in our detection or something misconfigured.
|
|
2959
|
+
2. ``Provider`` is the provider construct path of the runner that was stolen. You can check your code to see which labels it has that may cause
|
|
2960
|
+
it to be stolen. The logs insights queries can provide even more information about the stolen runners.
|
|
2961
|
+
|
|
2962
|
+
**WARNING:** this method creates a metric filter. This resource may incur cost.
|
|
2963
|
+
|
|
2964
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
2965
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
2966
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
2967
|
+
:param id: Unique identifier for this metric when used in dashboard widgets. The id can be used as a variable to represent this metric in math expressions. Valid characters are letters, numbers, and underscore. The first character must be a lowercase letter. Default: - No ID
|
|
2968
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
2969
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
2970
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
2971
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
2972
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
2973
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
2974
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
2975
|
+
:param visible: Whether this metric should be visible in dashboard graphs. Setting this to false is useful when you want to hide raw metrics that are used in math expressions, and show only the expression results. Default: true
|
|
2976
|
+
|
|
2977
|
+
:stability: experimental
|
|
2978
|
+
'''
|
|
2979
|
+
props = _aws_cdk_aws_cloudwatch_ceddda9d.MetricOptions(
|
|
2980
|
+
account=account,
|
|
2981
|
+
color=color,
|
|
2982
|
+
dimensions_map=dimensions_map,
|
|
2983
|
+
id=id,
|
|
2984
|
+
label=label,
|
|
2985
|
+
period=period,
|
|
2986
|
+
region=region,
|
|
2987
|
+
stack_account=stack_account,
|
|
2988
|
+
stack_region=stack_region,
|
|
2989
|
+
statistic=statistic,
|
|
2990
|
+
unit=unit,
|
|
2991
|
+
visible=visible,
|
|
2992
|
+
)
|
|
2993
|
+
|
|
2994
|
+
return typing.cast("_aws_cdk_aws_cloudwatch_ceddda9d.Metric", jsii.invoke(self, "metricStolenRunners", [props]))
|
|
2995
|
+
|
|
2912
2996
|
@jsii.member(jsii_name="metricSucceeded")
|
|
2913
2997
|
def metric_succeeded(
|
|
2914
2998
|
self,
|
|
@@ -4950,7 +5034,7 @@ class LambdaRunnerProvider(
|
|
|
4950
5034
|
:param scope: -
|
|
4951
5035
|
:param id: -
|
|
4952
5036
|
:param ephemeral_storage_size: (experimental) The size of the function’s /tmp directory in MiB. Default: 10 GiB
|
|
4953
|
-
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
5037
|
+
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account and organization level runner registration. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
4954
5038
|
:param image_builder: (experimental) Runner image builder used to build Docker images containing GitHub Runner and all requirements. The image builder must contain the {@link RunnerImageComponent.lambdaEntrypoint} component. The image builder determines the OS and architecture of the runner. Default: LambdaRunnerProvider.imageBuilder()
|
|
4955
5039
|
:param label: (deprecated) GitHub Actions label used for this provider. Default: undefined
|
|
4956
5040
|
: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: ['lambda']
|
|
@@ -6878,7 +6962,7 @@ class RunnerImageComponent(
|
|
|
6878
6962
|
'''(experimental) A component that runs a script after every job the runner executes.
|
|
6879
6963
|
|
|
6880
6964
|
Point this at a local script file. It is copied into the image, made executable, and the runner is
|
|
6881
|
-
configured to run it after each job
|
|
6965
|
+
configured to run it after each job through the
|
|
6882
6966
|
```ACTIONS_RUNNER_HOOK_JOB_COMPLETED`` <https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/run-scripts>`_
|
|
6883
6967
|
environment variable. GitHub passes job context to the script as environment variables such as ``GITHUB_REPOSITORY`` and ``GITHUB_RUN_ID``.
|
|
6884
6968
|
|
|
@@ -6899,7 +6983,7 @@ class RunnerImageComponent(
|
|
|
6899
6983
|
'''(experimental) A component that runs a script before every job the runner executes.
|
|
6900
6984
|
|
|
6901
6985
|
Point this at a local script file. It is copied into the image, made executable, and the runner is
|
|
6902
|
-
configured to run it before each job
|
|
6986
|
+
configured to run it before each job through the
|
|
6903
6987
|
```ACTIONS_RUNNER_HOOK_JOB_STARTED`` <https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/run-scripts>`_
|
|
6904
6988
|
environment variable. GitHub passes job context to the script as environment variables such as ``GITHUB_REPOSITORY`` and ``GITHUB_RUN_ID``.
|
|
6905
6989
|
|
|
@@ -7338,8 +7422,7 @@ class ScheduledWarmRunner(
|
|
|
7338
7422
|
|
|
7339
7423
|
https://github.com/CloudSnorkel/cdk-github-runners/blob/main/SETUP_GITHUB.md
|
|
7340
7424
|
|
|
7341
|
-
|
|
7342
|
-
Limitations
|
|
7425
|
+
**Limitations**
|
|
7343
7426
|
|
|
7344
7427
|
- **No deployment-fill**: Unlike ``AlwaysOnWarmRunner``, scheduled warm runners do not get an initial
|
|
7345
7428
|
fill on deploy. The first fill happens at the next schedule occurrence. If you deploy at 1pm for
|
|
@@ -8622,7 +8705,7 @@ class CodeBuildRunnerProvider(
|
|
|
8622
8705
|
:param compute_type: (experimental) The type of compute to use for this build. See the {@link ComputeType} enum for the possible values. The compute type determines CPU, memory, and disk space: - SMALL: 2 vCPU, 3 GB RAM, 64 GB disk - MEDIUM: 4 vCPU, 7 GB RAM, 128 GB disk - LARGE: 8 vCPU, 15 GB RAM, 128 GB disk - X2_LARGE: 72 vCPU, 145 GB RAM, 256 GB disk (Linux) or 824 GB disk (Windows) Use a larger compute type when you need more disk space for building larger Docker images. For more details, see https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment.types Default: {@link ComputeType#SMALL }
|
|
8623
8706
|
: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
|
|
8624
8707
|
:param gpu: (experimental) Use GPU compute for builds. When enabled, the default compute type is BUILD_GENERAL1_SMALL (4 vCPU, 16 GB RAM, 1 NVIDIA A10G GPU). You can override the compute type using the ``computeType`` property (for example, to use BUILD_GENERAL1_LARGE for more resources), subject to the supported GPU compute types. When using GPU compute, ensure your runner image includes any required GPU libraries (for example, CUDA) either by using a base image that has them preinstalled (such as an appropriate nvidia/cuda image) or by adding image components that install them. The default image builder does not automatically switch to a CUDA-enabled base image when GPU is enabled. GPU compute is only available for Linux x64 images. Not supported on Windows or ARM. Default: false
|
|
8625
|
-
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
8708
|
+
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account and organization level runner registration. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
8626
8709
|
:param image_builder: (experimental) Runner image builder used to build Docker images containing GitHub Runner and all requirements. The image builder must contain the {@link RunnerImageComponent.docker} component unless ``dockerInDocker`` is set to false. The image builder determines the OS and architecture of the runner. Default: CodeBuildRunnerProvider.imageBuilder()
|
|
8627
8710
|
:param label: (deprecated) GitHub Actions label used for this provider. Default: undefined
|
|
8628
8711
|
: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: ['codebuild']
|
|
@@ -8995,7 +9078,7 @@ class CodeBuildRunnerProviderProps(RunnerProviderProps):
|
|
|
8995
9078
|
:param compute_type: (experimental) The type of compute to use for this build. See the {@link ComputeType} enum for the possible values. The compute type determines CPU, memory, and disk space: - SMALL: 2 vCPU, 3 GB RAM, 64 GB disk - MEDIUM: 4 vCPU, 7 GB RAM, 128 GB disk - LARGE: 8 vCPU, 15 GB RAM, 128 GB disk - X2_LARGE: 72 vCPU, 145 GB RAM, 256 GB disk (Linux) or 824 GB disk (Windows) Use a larger compute type when you need more disk space for building larger Docker images. For more details, see https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment.types Default: {@link ComputeType#SMALL }
|
|
8996
9079
|
: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
|
|
8997
9080
|
:param gpu: (experimental) Use GPU compute for builds. When enabled, the default compute type is BUILD_GENERAL1_SMALL (4 vCPU, 16 GB RAM, 1 NVIDIA A10G GPU). You can override the compute type using the ``computeType`` property (for example, to use BUILD_GENERAL1_LARGE for more resources), subject to the supported GPU compute types. When using GPU compute, ensure your runner image includes any required GPU libraries (for example, CUDA) either by using a base image that has them preinstalled (such as an appropriate nvidia/cuda image) or by adding image components that install them. The default image builder does not automatically switch to a CUDA-enabled base image when GPU is enabled. GPU compute is only available for Linux x64 images. Not supported on Windows or ARM. Default: false
|
|
8998
|
-
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
9081
|
+
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account and organization level runner registration. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
8999
9082
|
:param image_builder: (experimental) Runner image builder used to build Docker images containing GitHub Runner and all requirements. The image builder must contain the {@link RunnerImageComponent.docker} component unless ``dockerInDocker`` is set to false. The image builder determines the OS and architecture of the runner. Default: CodeBuildRunnerProvider.imageBuilder()
|
|
9000
9083
|
:param label: (deprecated) GitHub Actions label used for this provider. Default: undefined
|
|
9001
9084
|
: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: ['codebuild']
|
|
@@ -9166,7 +9249,7 @@ class CodeBuildRunnerProviderProps(RunnerProviderProps):
|
|
|
9166
9249
|
'''(experimental) GitHub Actions runner group name.
|
|
9167
9250
|
|
|
9168
9251
|
If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It
|
|
9169
|
-
requires a paid GitHub account.
|
|
9252
|
+
requires a paid GitHub account and organization level runner registration.
|
|
9170
9253
|
|
|
9171
9254
|
The group must exist or the runner will not start.
|
|
9172
9255
|
|
|
@@ -9650,7 +9733,7 @@ class Ec2RunnerProvider(
|
|
|
9650
9733
|
:param scope: -
|
|
9651
9734
|
:param id: -
|
|
9652
9735
|
:param ami_builder:
|
|
9653
|
-
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
9736
|
+
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account and organization level runner registration. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
9654
9737
|
: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()
|
|
9655
9738
|
:param instance_type: (experimental) Instance type for launched runner instances. For GPU instance types (g4dn, g5, p3, etc.), we automatically use a GPU base image (AWS Deep Learning AMI) with NVIDIA drivers pre-installed. If you provide your own image builder, use ``baseAmi: BaseImage.fromGpuBase(os, architecture)`` or another image preloaded with NVIDIA drivers, or use an image component to install NVIDIA drivers. Default: m6i.large
|
|
9656
9739
|
: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']
|
|
@@ -9974,7 +10057,7 @@ class Ec2RunnerProviderProps(RunnerProviderProps):
|
|
|
9974
10057
|
: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
|
|
9975
10058
|
:param retry_options:
|
|
9976
10059
|
:param ami_builder:
|
|
9977
|
-
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
10060
|
+
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account and organization level runner registration. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
9978
10061
|
: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()
|
|
9979
10062
|
:param instance_type: (experimental) Instance type for launched runner instances. For GPU instance types (g4dn, g5, p3, etc.), we automatically use a GPU base image (AWS Deep Learning AMI) with NVIDIA drivers pre-installed. If you provide your own image builder, use ``baseAmi: BaseImage.fromGpuBase(os, architecture)`` or another image preloaded with NVIDIA drivers, or use an image component to install NVIDIA drivers. Default: m6i.large
|
|
9980
10063
|
: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']
|
|
@@ -10110,7 +10193,7 @@ class Ec2RunnerProviderProps(RunnerProviderProps):
|
|
|
10110
10193
|
'''(experimental) GitHub Actions runner group name.
|
|
10111
10194
|
|
|
10112
10195
|
If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It
|
|
10113
|
-
requires a paid GitHub account.
|
|
10196
|
+
requires a paid GitHub account and organization level runner registration.
|
|
10114
10197
|
|
|
10115
10198
|
The group must exist or the runner will not start.
|
|
10116
10199
|
|
|
@@ -10366,7 +10449,7 @@ class EcsRunnerProvider(
|
|
|
10366
10449
|
: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
|
|
10367
10450
|
: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
|
|
10368
10451
|
:param gpu: (experimental) Number of GPUs to request for the runner task. When set, the task will be scheduled on GPU-capable instances. Requires a GPU-capable instance type (e.g., g4dn.xlarge for 1 GPU, g4dn.12xlarge for 4 GPUs) and GPU AMI. When creating a new cluster, instanceType defaults to g4dn.xlarge and the ECS Optimized GPU AMI is used. You must ensure that the task's container image includes the CUDA runtime. Provide a CUDA-enabled base image via ``baseDockerImage``, use an image builder that starts from a GPU-capable image (such as nvidia/cuda), or add an image component that installs the CUDA runtime into the image. Default: undefined (no GPU)
|
|
10369
|
-
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
10452
|
+
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account and organization level runner registration. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
10370
10453
|
: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()
|
|
10371
10454
|
:param instance_type: (experimental) Instance type of ECS cluster instances. Only used when creating a new cluster. Default: m6i.large or m6g.large
|
|
10372
10455
|
: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']
|
|
@@ -10729,7 +10812,7 @@ class EcsRunnerProviderProps(RunnerProviderProps):
|
|
|
10729
10812
|
: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
|
|
10730
10813
|
: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
|
|
10731
10814
|
:param gpu: (experimental) Number of GPUs to request for the runner task. When set, the task will be scheduled on GPU-capable instances. Requires a GPU-capable instance type (e.g., g4dn.xlarge for 1 GPU, g4dn.12xlarge for 4 GPUs) and GPU AMI. When creating a new cluster, instanceType defaults to g4dn.xlarge and the ECS Optimized GPU AMI is used. You must ensure that the task's container image includes the CUDA runtime. Provide a CUDA-enabled base image via ``baseDockerImage``, use an image builder that starts from a GPU-capable image (such as nvidia/cuda), or add an image component that installs the CUDA runtime into the image. Default: undefined (no GPU)
|
|
10732
|
-
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
10815
|
+
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account and organization level runner registration. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
10733
10816
|
: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()
|
|
10734
10817
|
:param instance_type: (experimental) Instance type of ECS cluster instances. Only used when creating a new cluster. Default: m6i.large or m6g.large
|
|
10735
10818
|
: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']
|
|
@@ -10966,7 +11049,7 @@ class EcsRunnerProviderProps(RunnerProviderProps):
|
|
|
10966
11049
|
'''(experimental) GitHub Actions runner group name.
|
|
10967
11050
|
|
|
10968
11051
|
If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It
|
|
10969
|
-
requires a paid GitHub account.
|
|
11052
|
+
requires a paid GitHub account and organization level runner registration.
|
|
10970
11053
|
|
|
10971
11054
|
The group must exist or the runner will not start.
|
|
10972
11055
|
|
|
@@ -11238,7 +11321,7 @@ class FargateRunnerProvider(
|
|
|
11238
11321
|
:param cluster: (experimental) Existing Fargate cluster to use. Default: a new cluster
|
|
11239
11322
|
:param cpu: (experimental) The number of cpu units used by the task. For tasks using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter: 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) Default: 1024
|
|
11240
11323
|
:param ephemeral_storage_gib: (experimental) The amount (in GiB) of ephemeral storage to be allocated to the task. The maximum supported value is 200 GiB. NOTE: This parameter is only supported for tasks hosted on AWS Fargate using platform version 1.4.0 or later. Default: 20
|
|
11241
|
-
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
11324
|
+
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account and organization level runner registration. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
11242
11325
|
: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: FargateRunnerProvider.imageBuilder()
|
|
11243
11326
|
:param label: (deprecated) GitHub Actions label used for this provider. Default: undefined
|
|
11244
11327
|
: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: ['fargate']
|
|
@@ -11679,7 +11762,7 @@ class FargateRunnerProviderProps(RunnerProviderProps):
|
|
|
11679
11762
|
:param cluster: (experimental) Existing Fargate cluster to use. Default: a new cluster
|
|
11680
11763
|
:param cpu: (experimental) The number of cpu units used by the task. For tasks using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter: 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) Default: 1024
|
|
11681
11764
|
:param ephemeral_storage_gib: (experimental) The amount (in GiB) of ephemeral storage to be allocated to the task. The maximum supported value is 200 GiB. NOTE: This parameter is only supported for tasks hosted on AWS Fargate using platform version 1.4.0 or later. Default: 20
|
|
11682
|
-
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
11765
|
+
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account and organization level runner registration. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
11683
11766
|
: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: FargateRunnerProvider.imageBuilder()
|
|
11684
11767
|
:param label: (deprecated) GitHub Actions label used for this provider. Default: undefined
|
|
11685
11768
|
: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: ['fargate']
|
|
@@ -11860,7 +11943,7 @@ class FargateRunnerProviderProps(RunnerProviderProps):
|
|
|
11860
11943
|
'''(experimental) GitHub Actions runner group name.
|
|
11861
11944
|
|
|
11862
11945
|
If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It
|
|
11863
|
-
requires a paid GitHub account.
|
|
11946
|
+
requires a paid GitHub account and organization level runner registration.
|
|
11864
11947
|
|
|
11865
11948
|
The group must exist or the runner will not start.
|
|
11866
11949
|
|
|
@@ -12144,7 +12227,7 @@ class LambdaRunner(
|
|
|
12144
12227
|
:param scope: -
|
|
12145
12228
|
:param id: -
|
|
12146
12229
|
:param ephemeral_storage_size: (experimental) The size of the function’s /tmp directory in MiB. Default: 10 GiB
|
|
12147
|
-
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
12230
|
+
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account and organization level runner registration. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
12148
12231
|
:param image_builder: (experimental) Runner image builder used to build Docker images containing GitHub Runner and all requirements. The image builder must contain the {@link RunnerImageComponent.lambdaEntrypoint} component. The image builder determines the OS and architecture of the runner. Default: LambdaRunnerProvider.imageBuilder()
|
|
12149
12232
|
:param label: (deprecated) GitHub Actions label used for this provider. Default: undefined
|
|
12150
12233
|
: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: ['lambda']
|
|
@@ -12228,7 +12311,7 @@ class LambdaRunnerProviderProps(RunnerProviderProps):
|
|
|
12228
12311
|
: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
|
|
12229
12312
|
:param retry_options:
|
|
12230
12313
|
:param ephemeral_storage_size: (experimental) The size of the function’s /tmp directory in MiB. Default: 10 GiB
|
|
12231
|
-
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
12314
|
+
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account and organization level runner registration. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
12232
12315
|
:param image_builder: (experimental) Runner image builder used to build Docker images containing GitHub Runner and all requirements. The image builder must contain the {@link RunnerImageComponent.lambdaEntrypoint} component. The image builder determines the OS and architecture of the runner. Default: LambdaRunnerProvider.imageBuilder()
|
|
12233
12316
|
:param label: (deprecated) GitHub Actions label used for this provider. Default: undefined
|
|
12234
12317
|
: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: ['lambda']
|
|
@@ -12347,7 +12430,7 @@ class LambdaRunnerProviderProps(RunnerProviderProps):
|
|
|
12347
12430
|
'''(experimental) GitHub Actions runner group name.
|
|
12348
12431
|
|
|
12349
12432
|
If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It
|
|
12350
|
-
requires a paid GitHub account.
|
|
12433
|
+
requires a paid GitHub account and organization level runner registration.
|
|
12351
12434
|
|
|
12352
12435
|
The group must exist or the runner will not start.
|
|
12353
12436
|
|
|
@@ -12841,7 +12924,7 @@ class CodeBuildRunner(
|
|
|
12841
12924
|
:param compute_type: (experimental) The type of compute to use for this build. See the {@link ComputeType} enum for the possible values. The compute type determines CPU, memory, and disk space: - SMALL: 2 vCPU, 3 GB RAM, 64 GB disk - MEDIUM: 4 vCPU, 7 GB RAM, 128 GB disk - LARGE: 8 vCPU, 15 GB RAM, 128 GB disk - X2_LARGE: 72 vCPU, 145 GB RAM, 256 GB disk (Linux) or 824 GB disk (Windows) Use a larger compute type when you need more disk space for building larger Docker images. For more details, see https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment.types Default: {@link ComputeType#SMALL }
|
|
12842
12925
|
: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
|
|
12843
12926
|
:param gpu: (experimental) Use GPU compute for builds. When enabled, the default compute type is BUILD_GENERAL1_SMALL (4 vCPU, 16 GB RAM, 1 NVIDIA A10G GPU). You can override the compute type using the ``computeType`` property (for example, to use BUILD_GENERAL1_LARGE for more resources), subject to the supported GPU compute types. When using GPU compute, ensure your runner image includes any required GPU libraries (for example, CUDA) either by using a base image that has them preinstalled (such as an appropriate nvidia/cuda image) or by adding image components that install them. The default image builder does not automatically switch to a CUDA-enabled base image when GPU is enabled. GPU compute is only available for Linux x64 images. Not supported on Windows or ARM. Default: false
|
|
12844
|
-
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
12927
|
+
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account and organization level runner registration. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
12845
12928
|
:param image_builder: (experimental) Runner image builder used to build Docker images containing GitHub Runner and all requirements. The image builder must contain the {@link RunnerImageComponent.docker} component unless ``dockerInDocker`` is set to false. The image builder determines the OS and architecture of the runner. Default: CodeBuildRunnerProvider.imageBuilder()
|
|
12846
12929
|
:param label: (deprecated) GitHub Actions label used for this provider. Default: undefined
|
|
12847
12930
|
: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: ['codebuild']
|
|
@@ -12920,7 +13003,7 @@ class Ec2Runner(
|
|
|
12920
13003
|
:param scope: -
|
|
12921
13004
|
:param id: -
|
|
12922
13005
|
:param ami_builder:
|
|
12923
|
-
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
13006
|
+
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account and organization level runner registration. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
12924
13007
|
: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()
|
|
12925
13008
|
:param instance_type: (experimental) Instance type for launched runner instances. For GPU instance types (g4dn, g5, p3, etc.), we automatically use a GPU base image (AWS Deep Learning AMI) with NVIDIA drivers pre-installed. If you provide your own image builder, use ``baseAmi: BaseImage.fromGpuBase(os, architecture)`` or another image preloaded with NVIDIA drivers, or use an image component to install NVIDIA drivers. Default: m6i.large
|
|
12926
13009
|
: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']
|
|
@@ -13009,7 +13092,7 @@ class FargateRunner(
|
|
|
13009
13092
|
:param cluster: (experimental) Existing Fargate cluster to use. Default: a new cluster
|
|
13010
13093
|
:param cpu: (experimental) The number of cpu units used by the task. For tasks using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter: 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) Default: 1024
|
|
13011
13094
|
:param ephemeral_storage_gib: (experimental) The amount (in GiB) of ephemeral storage to be allocated to the task. The maximum supported value is 200 GiB. NOTE: This parameter is only supported for tasks hosted on AWS Fargate using platform version 1.4.0 or later. Default: 20
|
|
13012
|
-
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
13095
|
+
:param group: (experimental) GitHub Actions runner group name. If specified, the runner will be registered with this group name. Setting a runner group can help managing access to self-hosted runners. It requires a paid GitHub account and organization level runner registration. The group must exist or the runner will not start. Users will still be able to trigger this runner with the correct labels. But the runner will only be able to run jobs from repos allowed to use the group. Default: undefined
|
|
13013
13096
|
: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: FargateRunnerProvider.imageBuilder()
|
|
13014
13097
|
:param label: (deprecated) GitHub Actions label used for this provider. Default: undefined
|
|
13015
13098
|
: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: ['fargate']
|
|
@@ -13198,6 +13281,7 @@ def _typecheckingstub__41cf6bb0c2118d6cb7d082b7e678fba3dae1f5b8812776005eef7b14e
|
|
|
13198
13281
|
|
|
13199
13282
|
def _typecheckingstub__fe17585d38b67015c3f03db2aefab095f171e0e0900c9a4564679bbc5a29fd07(
|
|
13200
13283
|
*,
|
|
13284
|
+
ami_tags: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
13201
13285
|
fast_launch_options: typing.Optional[typing.Union[FastLaunchOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
13202
13286
|
instance_type: typing.Optional[_aws_cdk_aws_ec2_ceddda9d.InstanceType] = None,
|
|
13203
13287
|
storage_size: typing.Optional[_aws_cdk_ceddda9d.Size] = None,
|
|
@@ -19,9 +19,9 @@ import constructs._jsii
|
|
|
19
19
|
|
|
20
20
|
__jsii_assembly__ = jsii.JSIIAssembly.load(
|
|
21
21
|
"@cloudsnorkel/cdk-github-runners",
|
|
22
|
-
"0.
|
|
22
|
+
"0.16.0",
|
|
23
23
|
__name__[0:-6],
|
|
24
|
-
"cdk-github-runners@0.
|
|
24
|
+
"cdk-github-runners@0.16.0.jsii.tgz",
|
|
25
25
|
)
|
|
26
26
|
|
|
27
27
|
__all__ = [
|
|
Binary file
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: cloudsnorkel.cdk-github-runners
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.16.0
|
|
4
4
|
Summary: CDK construct to create GitHub Actions self-hosted runners. Creates ephemeral runners on demand. Easy to deploy and highly customizable.
|
|
5
5
|
Home-page: https://github.com/CloudSnorkel/cdk-github-runners.git
|
|
6
6
|
Author: Amir Szekely<amir@cloudsnorkel.com>
|
|
@@ -23,7 +23,7 @@ Description-Content-Type: text/markdown
|
|
|
23
23
|
License-File: LICENSE
|
|
24
24
|
Requires-Dist: aws-cdk-lib<3.0.0,>=2.239.0
|
|
25
25
|
Requires-Dist: constructs<11.0.0,>=10.5.1
|
|
26
|
-
Requires-Dist: jsii<2.0.0,>=1.
|
|
26
|
+
Requires-Dist: jsii<2.0.0,>=1.139.0
|
|
27
27
|
Requires-Dist: publication>=0.0.3
|
|
28
28
|
|
|
29
29
|
# GitHub Self-Hosted Runners CDK Constructs
|
|
@@ -659,6 +659,7 @@ Other useful metrics to track:
|
|
|
659
659
|
|
|
660
660
|
1. Use `GitHubRunners.metricJobCompleted()` to get a metric for the number of completed jobs broken down by labels and job success.
|
|
661
661
|
2. Use `GitHubRunners.metricTime()` to get a metric for the total time a runner is running. This includes the overhead of starting the runner.
|
|
662
|
+
3. Use `GitHubRunners.metricStolenRunners()` to get a metric for number of runners detected as stolen by another job. Anything over zero can indicate a misconfiguration or GitHub webhook issues.
|
|
662
663
|
|
|
663
664
|
## Known Issues
|
|
664
665
|
|
|
@@ -11,4 +11,4 @@ src/cloudsnorkel.cdk_github_runners.egg-info/top_level.txt
|
|
|
11
11
|
src/cloudsnorkel/cdk_github_runners/__init__.py
|
|
12
12
|
src/cloudsnorkel/cdk_github_runners/py.typed
|
|
13
13
|
src/cloudsnorkel/cdk_github_runners/_jsii/__init__.py
|
|
14
|
-
src/cloudsnorkel/cdk_github_runners/_jsii/cdk-github-runners@0.
|
|
14
|
+
src/cloudsnorkel/cdk_github_runners/_jsii/cdk-github-runners@0.16.0.jsii.tgz
|
|
Binary file
|
|
File without changes
|
{cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0}/MANIFEST.in
RENAMED
|
File without changes
|
{cloudsnorkel_cdk_github_runners-0.15.4 → cloudsnorkel_cdk_github_runners-0.16.0}/pyproject.toml
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|