cdk-github-microvm-runners 0.1.3__tar.gz → 0.1.5__tar.gz

{cdk_github_microvm_runners-0.1.3/src/cdk_github_microvm_runners.egg-info → cdk_github_microvm_runners-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cdk-github-microvm-runners
-Version: 0.1.3
+Version: 0.1.5
 Summary: CDK construct for running GitHub Actions jobs on AWS Lambda MicroVMs, with one ephemeral runner per job.
 Home-page: https://runnerset.dev
 Author: Court Schuett

{cdk_github_microvm_runners-0.1.3 → cdk_github_microvm_runners-0.1.5}/setup.py

@@ -5,7 +5,7 @@ kwargs = json.loads(
     """
 {
     "name": "cdk-github-microvm-runners",
-    "version": "0.1.3",
+    "version": "0.1.5",
     "description": "CDK construct for running GitHub Actions jobs on AWS Lambda MicroVMs, with one ephemeral runner per job.",
     "license": "Apache-2.0",
     "url": "https://runnerset.dev",
@@ -26,7 +26,7 @@ kwargs = json.loads(
     ],
     "package_data": {
         "cdk_github_microvm_runners._jsii": [
-            "cdk-github-microvm-runners@0.1.3.jsii.tgz"
+            "cdk-github-microvm-runners@0.1.5.jsii.tgz"
         ],
         "cdk_github_microvm_runners": [
             "py.typed"

{cdk_github_microvm_runners-0.1.3 → cdk_github_microvm_runners-0.1.5}/src/cdk_github_microvm_runners/__init__.py

@@ -860,7 +860,7 @@ class GithubMicrovmRunners(
         :param network: How launched MicroVMs and image builds reach the network. Default: RunnerNetwork.internetEgress()
         :param permissions_boundary: Permissions boundary applied to every IAM role this construct creates: the handler execution roles, the per-class image build roles, and the network-connector operator role. It is applied once at construct scope, so roles created later also carry it — the warm-pool handler's role, and the build role of any runner class registered after construction. Default: undefined (no boundary)
         :param point_in_time_recovery: Turn on DynamoDB point-in-time recovery for the runner table. Default: false
-        :param recover_stuck_launches: Recover launches that dead-lettered while GitHub Actions was down. Each janitor sweep re-drives dead-lettered launch messages back onto the job queue, but only for jobs GitHub still reports as queued; a launch whose job has since completed or been cancelled is discarded rather than booting a VM for work nobody is waiting on. Recovery happens once an outage ends, since GitHub dispatches no jobs while it is down. The janitor counts each recovered launch under the ``stuckLaunchesRecovered`` metric, which reports when ``emitMetrics`` is on. Default: false
+        :param recover_stuck_launches: Re-launch jobs that are still waiting for a runner they never got. This is the floor under an event-driven plane, and it is on by default. GitHub announces a job once. If the launch that announcement triggered doesn't end with the job being served, nothing else ever asks again, and the job waits for as long as the workflow allows with no error anywhere — the plane looks healthy because by its own bookkeeping it did its work. Each janitor sweep closes that hole from two directions: it re-drives dead-lettered launch messages back onto the job queue, and it re-launches claims whose VM is gone while the job is still queued. Both check with GitHub first, so a job that has since completed or been cancelled is discarded rather than booting a VM for work nobody is waiting on. Turn it off only if you want a job that slips through to stay stuck. The cost of leaving it on is one extra GitHub read per sweep per candidate, bounded per sweep so it cannot exhaust the installation's rate limit. The janitor counts recoveries under the ``stuckLaunchesRecovered`` and ``stuckClaimsRelaunched`` metrics, which report when ``emitMetrics`` is on. A count that stays high means launches are failing for some ongoing reason and the recovery is masking it — alarm on it rather than ignoring it. Default: true
         :param removal_policy: Removal policy for this runner set's stateful resources: the runner table and any log group the construct creates. The table holds correlation data for VMs that are currently running, all of which the janitor can rebuild from the MicroVM and GitHub APIs. Default: RemovalPolicy.DESTROY
         :param vm_execution_role: An AWS identity for this runner set's runner VMs. By default the VMs carry no AWS identity at all: the runner agent talks outbound to GitHub, the just-in-time registration is pushed to the VM over a platform-authenticated channel, and a job that needs AWS assumes its own role through GitHub OIDC. With a role attached, the MicroVM's instance metadata service serves that role's credentials to arbitrary job code, so every job running on this runner set can do whatever the role can do. ``consoleLogs`` requires a role, because the platform writes a VM's console output using it. Default: undefined (the VMs carry no AWS identity)
         :param warm_pool_interval: How often the warm-pool sweep refills pre-booted VMs. It applies only to runner classes that set ``RunnerClassProps.warmPoolSize``, and the warm-pool handler and its schedule are only created once such a class is registered. A runner set with no warm class never runs this sweep, and never reads this value. Default: Duration.minutes(2)
@@ -1403,8 +1403,17 @@ class GithubMicrovmRunnersMetrics(
 
         A value that stays above zero means the runner set is
         failing to reconcile — VMs left running, runners left unreaped — even
-        though each sweep completes. It fires on one error over a single 5-minute
-        period; pass ``RunnerAlarmOptions`` to change that.
+        though each sweep completes. It fires on one error in each of three
+        consecutive 5-minute periods; pass ``RunnerAlarmOptions`` to change that.
+
+        The three periods are the point. A single sweep error is usually a
+        transient fault the next sweep sails past — a GitHub API call that lost
+        its connection, a throttled describe — and the sweep is convergent, so
+        the work is retried five minutes later either way. Alarming on one such
+        blip pages an operator for something already fixed by the time they
+        read it. A genuine reconciliation failure (expired credentials, a broken
+        table, a revoked App installation) fails every sweep, so it still
+        announces itself within fifteen minutes.
 
         Requires ``GithubMicrovmRunnersProps.emitMetrics``, and throws at synth
         without it.
@@ -1414,7 +1423,7 @@ class GithubMicrovmRunnersMetrics(
         :param period: Aggregation period for the metric. Default: Duration.minutes(5)
         :param threshold: Value at or above which the alarm fires. Default: 1
 
-        :default: threshold 1, 1 evaluation period, 5-minute period
+        :default: threshold 1, 3 evaluation periods, 5-minute period
         '''
         if __debug__:
             type_hints = cached_type_hints(_typecheckingstub__971f59e7dc4d5b4245765d41b7dcc4075c4dd91870a15df6b9f345ee393cdc61)
@@ -1559,7 +1568,7 @@ class GithubMicrovmRunnersProps:
         :param network: How launched MicroVMs and image builds reach the network. Default: RunnerNetwork.internetEgress()
         :param permissions_boundary: Permissions boundary applied to every IAM role this construct creates: the handler execution roles, the per-class image build roles, and the network-connector operator role. It is applied once at construct scope, so roles created later also carry it — the warm-pool handler's role, and the build role of any runner class registered after construction. Default: undefined (no boundary)
         :param point_in_time_recovery: Turn on DynamoDB point-in-time recovery for the runner table. Default: false
-        :param recover_stuck_launches: Recover launches that dead-lettered while GitHub Actions was down. Each janitor sweep re-drives dead-lettered launch messages back onto the job queue, but only for jobs GitHub still reports as queued; a launch whose job has since completed or been cancelled is discarded rather than booting a VM for work nobody is waiting on. Recovery happens once an outage ends, since GitHub dispatches no jobs while it is down. The janitor counts each recovered launch under the ``stuckLaunchesRecovered`` metric, which reports when ``emitMetrics`` is on. Default: false
+        :param recover_stuck_launches: Re-launch jobs that are still waiting for a runner they never got. This is the floor under an event-driven plane, and it is on by default. GitHub announces a job once. If the launch that announcement triggered doesn't end with the job being served, nothing else ever asks again, and the job waits for as long as the workflow allows with no error anywhere — the plane looks healthy because by its own bookkeeping it did its work. Each janitor sweep closes that hole from two directions: it re-drives dead-lettered launch messages back onto the job queue, and it re-launches claims whose VM is gone while the job is still queued. Both check with GitHub first, so a job that has since completed or been cancelled is discarded rather than booting a VM for work nobody is waiting on. Turn it off only if you want a job that slips through to stay stuck. The cost of leaving it on is one extra GitHub read per sweep per candidate, bounded per sweep so it cannot exhaust the installation's rate limit. The janitor counts recoveries under the ``stuckLaunchesRecovered`` and ``stuckClaimsRelaunched`` metrics, which report when ``emitMetrics`` is on. A count that stays high means launches are failing for some ongoing reason and the recovery is masking it — alarm on it rather than ignoring it. Default: true
         :param removal_policy: Removal policy for this runner set's stateful resources: the runner table and any log group the construct creates. The table holds correlation data for VMs that are currently running, all of which the janitor can rebuild from the MicroVM and GitHub APIs. Default: RemovalPolicy.DESTROY
         :param vm_execution_role: An AWS identity for this runner set's runner VMs. By default the VMs carry no AWS identity at all: the runner agent talks outbound to GitHub, the just-in-time registration is pushed to the VM over a platform-authenticated channel, and a job that needs AWS assumes its own role through GitHub OIDC. With a role attached, the MicroVM's instance metadata service serves that role's credentials to arbitrary job code, so every job running on this runner set can do whatever the role can do. ``consoleLogs`` requires a role, because the platform writes a VM's console output using it. Default: undefined (the VMs carry no AWS identity)
         :param warm_pool_interval: How often the warm-pool sweep refills pre-booted VMs. It applies only to runner classes that set ``RunnerClassProps.warmPoolSize``, and the warm-pool handler and its schedule are only created once such a class is registered. A runner set with no warm class never runs this sweep, and never reads this value. Default: Duration.minutes(2)
@@ -1883,18 +1892,31 @@ class GithubMicrovmRunnersProps:
 
     @builtins.property
     def recover_stuck_launches(self) -> typing.Optional[builtins.bool]:
-        '''Recover launches that dead-lettered while GitHub Actions was down.
-
-        Each
-        janitor sweep re-drives dead-lettered launch messages back onto the job
-        queue, but only for jobs GitHub still reports as queued; a launch whose job
-        has since completed or been cancelled is discarded rather than booting a
-        VM for work nobody is waiting on. Recovery happens once an outage ends,
-        since GitHub dispatches no jobs while it is down. The janitor counts each
-        recovered launch under the ``stuckLaunchesRecovered`` metric, which reports
-        when ``emitMetrics`` is on.
-
-        :default: false
+        '''Re-launch jobs that are still waiting for a runner they never got.
+
+        This is
+        the floor under an event-driven plane, and it is on by default.
+
+        GitHub announces a job once. If the launch that announcement triggered
+        doesn't end with the job being served, nothing else ever asks again, and
+        the job waits for as long as the workflow allows with no error anywhere —
+        the plane looks healthy because by its own bookkeeping it did its work.
+        Each janitor sweep closes that hole from two directions: it re-drives
+        dead-lettered launch messages back onto the job queue, and it re-launches
+        claims whose VM is gone while the job is still queued. Both check with
+        GitHub first, so a job that has since completed or been cancelled is
+        discarded rather than booting a VM for work nobody is waiting on.
+
+        Turn it off only if you want a job that slips through to stay stuck. The
+        cost of leaving it on is one extra GitHub read per sweep per candidate,
+        bounded per sweep so it cannot exhaust the installation's rate limit.
+
+        The janitor counts recoveries under the ``stuckLaunchesRecovered`` and
+        ``stuckClaimsRelaunched`` metrics, which report when ``emitMetrics`` is on. A
+        count that stays high means launches are failing for some ongoing reason
+        and the recovery is masking it — alarm on it rather than ignoring it.
+
+        :default: true
         '''
         result = self._values.get("recover_stuck_launches")
         return typing.cast(typing.Optional[builtins.bool], result)

{cdk_github_microvm_runners-0.1.3 → cdk_github_microvm_runners-0.1.5}/src/cdk_github_microvm_runners/_jsii/__init__.py

@@ -19,9 +19,9 @@ import constructs._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
     "cdk-github-microvm-runners",
-    "0.1.3",
+    "0.1.5",
     __name__[0:-6],
-    "cdk-github-microvm-runners@0.1.3.jsii.tgz",
+    "cdk-github-microvm-runners@0.1.5.jsii.tgz",
 )
 
 __all__ = [

{cdk_github_microvm_runners-0.1.3 → cdk_github_microvm_runners-0.1.5}/src/cdk_github_microvm_runners/_jsii/bin/cdk-github-microvm-runners

@@ -9,9 +9,9 @@ if "JSII_RUNTIME_PACKAGE_CACHE" not in os.environ:
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
     "cdk-github-microvm-runners",
-    "0.1.3",
+    "0.1.5",
     "cdk_github_microvm_runners",
-    "cdk-github-microvm-runners@0.1.3.jsii.tgz",
+    "cdk-github-microvm-runners@0.1.5.jsii.tgz",
 )
 
 exit_code = __jsii_assembly__.invokeBinScript(

{cdk_github_microvm_runners-0.1.3 → cdk_github_microvm_runners-0.1.5/src/cdk_github_microvm_runners.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cdk-github-microvm-runners
-Version: 0.1.3
+Version: 0.1.5
 Summary: CDK construct for running GitHub Actions jobs on AWS Lambda MicroVMs, with one ephemeral runner per job.
 Home-page: https://runnerset.dev
 Author: Court Schuett

{cdk_github_microvm_runners-0.1.3 → cdk_github_microvm_runners-0.1.5}/src/cdk_github_microvm_runners.egg-info/SOURCES.txt

@@ -11,5 +11,5 @@ src/cdk_github_microvm_runners.egg-info/dependency_links.txt
 src/cdk_github_microvm_runners.egg-info/requires.txt
 src/cdk_github_microvm_runners.egg-info/top_level.txt
 src/cdk_github_microvm_runners/_jsii/__init__.py
-src/cdk_github_microvm_runners/_jsii/cdk-github-microvm-runners@0.1.3.jsii.tgz
+src/cdk_github_microvm_runners/_jsii/cdk-github-microvm-runners@0.1.5.jsii.tgz
 src/cdk_github_microvm_runners/_jsii/bin/cdk-github-microvm-runners