@cloudsnorkel/cdk-github-runners 0.9.2 → 0.9.3

package/.jsii

@@ -6651,6 +6651,660 @@
       ],
       "symbolId": "src/providers/ec2:Ec2RunnerProviderProps"
     },
+    "@cloudsnorkel/cdk-github-runners.EcsRunnerProvider": {
+      "assembly": "@cloudsnorkel/cdk-github-runners",
+      "base": "constructs.Construct",
+      "docs": {
+        "remarks": "ECS can be useful when you want more control of the infrastructure running the GitHub Actions Docker containers. You can control the autoscaling\ngroup to scale down to zero during the night and scale up during work hours. This way you can still save money, but have to wait less for\ninfrastructure to spin up.\n\nThis construct is not meant to be used by itself. It should be passed in the providers property for GitHubRunners.",
+        "stability": "experimental",
+        "summary": "GitHub Actions runner provider using ECS on EC2 to execute jobs."
+      },
+      "fqn": "@cloudsnorkel/cdk-github-runners.EcsRunnerProvider",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/providers/ecs.ts",
+          "line": 296
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "optional": true,
+            "type": {
+              "fqn": "@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "@cloudsnorkel/cdk-github-runners.IRunnerProvider"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/providers/ecs.ts",
+        "line": 194
+      },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "Included components:\n * `RunnerImageComponent.requiredPackages()`\n * `RunnerImageComponent.runnerUser()`\n * `RunnerImageComponent.git()`\n * `RunnerImageComponent.githubCli()`\n * `RunnerImageComponent.awsCli()`\n * `RunnerImageComponent.dockerInDocker()`\n * `RunnerImageComponent.githubRunner()`",
+            "stability": "experimental",
+            "summary": "Create new image builder that builds ECS specific runner images using Ubuntu."
+          },
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 207
+          },
+          "name": "imageBuilder",
+          "parameters": [
+            {
+              "name": "scope",
+              "type": {
+                "fqn": "constructs.Construct"
+              }
+            },
+            {
+              "name": "id",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "props",
+              "optional": true,
+              "type": {
+                "fqn": "@cloudsnorkel/cdk-github-runners.RunnerImageBuilderProps"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@cloudsnorkel/cdk-github-runners.RunnerImageBuilder"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/providers/common.ts",
+            "line": 467
+          },
+          "name": "addRetry",
+          "parameters": [
+            {
+              "name": "task",
+              "type": {
+                "union": {
+                  "types": [
+                    {
+                      "fqn": "aws-cdk-lib.aws_stepfunctions.TaskStateBase"
+                    },
+                    {
+                      "fqn": "aws-cdk-lib.aws_stepfunctions.Parallel"
+                    }
+                  ]
+                }
+              }
+            },
+            {
+              "name": "errors",
+              "type": {
+                "collection": {
+                  "elementtype": {
+                    "primitive": "string"
+                  },
+                  "kind": "array"
+                }
+              }
+            }
+          ],
+          "protected": true
+        },
+        {
+          "docs": {
+            "remarks": "Called by GithubRunners and shouldn't be called manually.",
+            "stability": "experimental",
+            "summary": "Generate step function task(s) to start a new runner."
+          },
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 449
+          },
+          "name": "getStepFunctionTask",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "workflow job details."
+              },
+              "name": "parameters",
+              "type": {
+                "fqn": "@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "aws-cdk-lib.aws_stepfunctions.IChainable"
+            }
+          }
+        },
+        {
+          "docs": {
+            "remarks": "This can be used to add additional policy\nstatements to the state machine role that are not automatically added by the task returned from {@link getStepFunctionTask}.",
+            "stability": "experimental",
+            "summary": "An optional method that modifies the role of the state machine after all the tasks have been generated."
+          },
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 498
+          },
+          "name": "grantStateMachine",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "parameters": [
+            {
+              "name": "_",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_iam.IGrantable"
+              }
+            }
+          ]
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/providers/common.ts",
+            "line": 453
+          },
+          "name": "labelsFromProperties",
+          "parameters": [
+            {
+              "name": "defaultLabel",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "propsLabel",
+              "optional": true,
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "propsLabels",
+              "optional": true,
+              "type": {
+                "collection": {
+                  "elementtype": {
+                    "primitive": "string"
+                  },
+                  "kind": "array"
+                }
+              }
+            }
+          ],
+          "protected": true,
+          "returns": {
+            "type": {
+              "collection": {
+                "elementtype": {
+                  "primitive": "string"
+                },
+                "kind": "array"
+              }
+            }
+          }
+        },
+        {
+          "docs": {
+            "remarks": "Also gives the status function any needed permissions to query the Docker image or AMI.",
+            "stability": "experimental",
+            "summary": "Return status of the runner provider to be used in the main status function."
+          },
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 501
+          },
+          "name": "status",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "parameters": [
+            {
+              "name": "statusFunctionRole",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_iam.IGrantable"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus"
+            }
+          }
+        }
+      ],
+      "name": "EcsRunnerProvider",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "The network connections associated with this resource."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 272
+          },
+          "name": "connections",
+          "overrides": "aws-cdk-lib.aws_ec2.IConnectable",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.Connections"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Grant principal used to add permissions to the runner role."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 267
+          },
+          "name": "grantPrincipal",
+          "overrides": "aws-cdk-lib.aws_iam.IGrantable",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_iam.IPrincipal"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Labels associated with this provider."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 247
+          },
+          "name": "labels",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "docs": {
+            "remarks": "Note that this is not the job log, but the runner itself. It will not contain output from the GitHub Action but only metadata on its execution.",
+            "stability": "experimental",
+            "summary": "Log group where provided runners will save their logs."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 284
+          },
+          "name": "logGroup",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_logs.ILogGroup"
+          }
+        }
+      ],
+      "symbolId": "src/providers/ecs:EcsRunnerProvider"
+    },
+    "@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps": {
+      "assembly": "@cloudsnorkel/cdk-github-runners",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Properties for EcsRunnerProvider."
+      },
+      "fqn": "@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps",
+      "interfaces": [
+        "@cloudsnorkel/cdk-github-runners.RunnerProviderProps"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/providers/ecs.ts",
+        "line": 34
+      },
+      "name": "EcsRunnerProviderProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "remarks": "Make sure the task will have access to GitHub. A public IP might be required unless you have NAT gateway.",
+            "stability": "experimental",
+            "summary": "Assign public IP to the runner task."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 97
+          },
+          "name": "assignPublicIp",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "new capacity provider",
+            "stability": "experimental",
+            "summary": "Existing capacity provider to use."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 88
+          },
+          "name": "capacityProvider",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ecs.AsgCapacityProvider"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "a new cluster",
+            "stability": "experimental",
+            "summary": "Existing ECS cluster to use."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 81
+          },
+          "name": "cluster",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ecs.Cluster"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "1024",
+            "remarks": "1024 units is 1 vCPU. Fractions of a vCPU are supported.",
+            "stability": "experimental",
+            "summary": "The number of cpu units used by the task."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 104
+          },
+          "name": "cpu",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "remarks": "Disabling this can\nspeed up provisioning of CodeBuild runners. If you don't intend on running or building Docker images, disable this for faster start-up times.",
+            "stability": "experimental",
+            "summary": "Support building and running Docker images by enabling Docker-in-Docker (dind) and the required CodeBuild privileged mode."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 149
+          },
+          "name": "dockerInDocker",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "EcsRunnerProvider.imageBuilder()",
+            "remarks": "The image builder determines the OS and architecture of the runner.",
+            "stability": "experimental",
+            "summary": "Runner image builder used to build Docker images containing GitHub Runner and all requirements."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 42
+          },
+          "name": "imageBuilder",
+          "optional": true,
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.IRunnerImageBuilder"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "m5.large or m6g.large",
+            "remarks": "Only used when creating a new cluster.",
+            "stability": "experimental",
+            "summary": "Instance type of ECS cluster instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 118
+          },
+          "name": "instanceType",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.InstanceType"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "['ecs']",
+            "remarks": "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\nbased 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\njob's labels, this provider will be chosen and spawn a new runner.",
+            "stability": "experimental",
+            "summary": "GitHub Actions labels used for this provider."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 53
+          },
+          "name": "labels",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "5",
+            "remarks": "Only used when creating a new cluster.",
+            "stability": "experimental",
+            "summary": "The maximum number of instances to run in the cluster."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 132
+          },
+          "name": "maxInstances",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "3500",
+            "stability": "experimental",
+            "summary": "The amount (in MiB) of memory used by the task."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 111
+          },
+          "name": "memoryLimitMiB",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "0",
+            "remarks": "Only used when creating a new cluster.",
+            "stability": "experimental",
+            "summary": "The minimum number of instances to run in the cluster."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 125
+          },
+          "name": "minInstances",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "a new security group",
+            "stability": "experimental",
+            "summary": "Security groups to assign to the task."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 74
+          },
+          "name": "securityGroups",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "no spot capacity",
+            "stability": "experimental",
+            "summary": "Use spot capacity and set a maximum price for spot instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 156
+          },
+          "name": "spotMaxPrice",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "default size for AMI (usually 30GB for Linux and 50GB for Windows)",
+            "remarks": "This modifies the boot volume size and doesn't add any additional volumes.\n\nEach instance can be used by multiple runners, so make sure there is enough space for all of them.",
+            "stability": "experimental",
+            "summary": "Size of volume available for launched cluster instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 141
+          },
+          "name": "storageSize",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.Size"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "ECS default",
+            "stability": "experimental",
+            "summary": "Subnets to run the runners in."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 67
+          },
+          "name": "subnetSelection",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.SubnetSelection"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "default account VPC",
+            "stability": "experimental",
+            "summary": "VPC to launch the runners in."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 60
+          },
+          "name": "vpc",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.IVpc"
+          }
+        }
+      ],
+      "symbolId": "src/providers/ecs:EcsRunnerProviderProps"
+    },
     "@cloudsnorkel/cdk-github-runners.FargateRunner": {
       "assembly": "@cloudsnorkel/cdk-github-runners",
       "base": "@cloudsnorkel/cdk-github-runners.FargateRunnerProvider",
@@ -12221,6 +12875,6 @@
       "symbolId": "src/providers/image-builders/aws-image-builder/deprecated/windows-components:WindowsComponents"
     }
   },
-  "version": "0.9.2",
-  "fingerprint": "zmHG8ogvxM4UnuobG3q57zcoNzxuIu+sExYrdG2uOo8="
+  "version": "0.9.3",
+  "fingerprint": "wm90SjuWDjOEdZ2XvCRnYQeU6aZ0JZPKovmkSiB3B2I="
 }