@cloudsnorkel/cdk-github-runners 0.6.0 → 0.6.1

package/.jsii

@@ -4915,6 +4915,443 @@
       ],
       "symbolId": "src/providers/image-builders/container:ContainerImageBuilderProps"
     },
+    "@cloudsnorkel/cdk-github-runners.Ec2Runner": {
+      "assembly": "@cloudsnorkel/cdk-github-runners",
+      "base": "constructs.Construct",
+      "docs": {
+        "remarks": "This 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 EC2 to execute jobs."
+      },
+      "fqn": "@cloudsnorkel/cdk-github-runners.Ec2Runner",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/providers/ec2.ts",
+          "line": 222
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@cloudsnorkel/cdk-github-runners.Ec2RunnerProps"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "@cloudsnorkel/cdk-github-runners.IRunnerProvider"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/providers/ec2.ts",
+        "line": 193
+      },
+      "methods": [
+        {
+          "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/ec2.ts",
+            "line": 269
+          },
+          "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/ec2.ts",
+            "line": 345
+          },
+          "name": "grantStateMachine",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "parameters": [
+            {
+              "name": "stateMachineRole",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_iam.IGrantable"
+              }
+            }
+          ]
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/providers/common.ts",
+            "line": 426
+          },
+          "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/ec2.ts",
+            "line": 365
+          },
+          "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": "Ec2Runner",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "The network connections associated with this resource."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 386
+          },
+          "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/ec2.ts",
+            "line": 212
+          },
+          "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/ec2.ts",
+            "line": 197
+          },
+          "name": "labels",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Security group attached to launched instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 207
+          },
+          "name": "securityGroup",
+          "optional": true,
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "VPC subnet used for hosting launched instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 202
+          },
+          "name": "subnet",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.ISubnet"
+          }
+        }
+      ],
+      "symbolId": "src/providers/ec2:Ec2Runner"
+    },
+    "@cloudsnorkel/cdk-github-runners.Ec2RunnerProps": {
+      "assembly": "@cloudsnorkel/cdk-github-runners",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Properties for {@link Ec2Runner} construct."
+      },
+      "fqn": "@cloudsnorkel/cdk-github-runners.Ec2RunnerProps",
+      "interfaces": [
+        "@cloudsnorkel/cdk-github-runners.RunnerProviderProps"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/providers/ec2.ts",
+        "line": 126
+      },
+      "name": "Ec2RunnerProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "AMI builder for Ubuntu Linux",
+            "remarks": "On Linux, a user named `runner` is expected to exist with access to Docker.",
+            "stability": "experimental",
+            "summary": "AMI builder that creates AMIs with GitHub runner pre-configured."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 132
+          },
+          "name": "amiBuilder",
+          "optional": true,
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.IAmiBuilder"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "m5.large",
+            "stability": "experimental",
+            "summary": "Instance type for launched runner instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 150
+          },
+          "name": "instanceType",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.InstanceType"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "['ec2']",
+            "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/ec2.ts",
+            "line": 143
+          },
+          "name": "labels",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "account's default security group",
+            "stability": "experimental",
+            "summary": "Security Group to assign to launched runner instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 164
+          },
+          "name": "securityGroup",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "remarks": "Spot instances are cheaper but not always available and can be stopped prematurely.",
+            "stability": "experimental",
+            "summary": "Use spot instances to save money."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 178
+          },
+          "name": "spot",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "no max price (you will pay current spot price)",
+            "stability": "experimental",
+            "summary": "Set a maximum price for spot instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 185
+          },
+          "name": "spotMaxPrice",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "30GB",
+            "remarks": "This modifies the boot volume size and doesn't add any additional volumes.",
+            "stability": "experimental",
+            "summary": "Size of volume available for launched runner instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 157
+          },
+          "name": "storageSize",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.Size"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "default subnet of account's default VPC",
+            "stability": "experimental",
+            "summary": "Subnet where the runner instances will be launched."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 171
+          },
+          "name": "subnet",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.ISubnet"
+          }
+        }
+      ],
+      "symbolId": "src/providers/ec2:Ec2RunnerProps"
+    },
     "@cloudsnorkel/cdk-github-runners.FargateRunner": {
       "assembly": "@cloudsnorkel/cdk-github-runners",
       "base": "constructs.Construct",
@@ -5808,6 +6245,43 @@
       ],
       "symbolId": "src/runner:GitHubRunnersProps"
     },
+    "@cloudsnorkel/cdk-github-runners.IAmiBuilder": {
+      "assembly": "@cloudsnorkel/cdk-github-runners",
+      "docs": {
+        "remarks": "Anything that ends up with a launch template pointing to an AMI that runs GitHub self-hosted runners can be used. A simple implementation could even point to an existing AMI and nothing else.\n\nThe AMI can be further updated over time manually or using a schedule as long as it is always written to the same launch template.",
+        "stability": "experimental",
+        "summary": "Interface for constructs that build an AMI that can be used in {@link IRunnerProvider}."
+      },
+      "fqn": "@cloudsnorkel/cdk-github-runners.IAmiBuilder",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/providers/common.ts",
+        "line": 236
+      },
+      "methods": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "This method can be called multiple times if the image is bound to multiple providers. Make sure you cache the image when implementing or return an error if this builder doesn't support reusing images.",
+            "returns": "ami",
+            "stability": "experimental",
+            "summary": "Finalize and return all required information about the AMI built by this builder."
+          },
+          "locationInModule": {
+            "filename": "src/providers/common.ts",
+            "line": 244
+          },
+          "name": "bind",
+          "returns": {
+            "type": {
+              "fqn": "@cloudsnorkel/cdk-github-runners.RunnerAmi"
+            }
+          }
+        }
+      ],
+      "name": "IAmiBuilder",
+      "symbolId": "src/providers/common:IAmiBuilder"
+    },
     "@cloudsnorkel/cdk-github-runners.IImageBuilder": {
       "assembly": "@cloudsnorkel/cdk-github-runners",
       "docs": {
@@ -7489,6 +7963,105 @@
       ],
       "symbolId": "src/providers/common:Os"
     },
+    "@cloudsnorkel/cdk-github-runners.RunnerAmi": {
+      "assembly": "@cloudsnorkel/cdk-github-runners",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Description of a AMI built by {@link IAmiBuilder}."
+      },
+      "fqn": "@cloudsnorkel/cdk-github-runners.RunnerAmi",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/providers/common.ts",
+        "line": 202
+      },
+      "name": "RunnerAmi",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Architecture of the image."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/common.ts",
+            "line": 211
+          },
+          "name": "architecture",
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.Architecture"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Launch template pointing to the latest AMI."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/common.ts",
+            "line": 206
+          },
+          "name": "launchTemplate",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.ILaunchTemplate"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "OS type of the image."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/common.ts",
+            "line": 216
+          },
+          "name": "os",
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.Os"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Installed runner version."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/common.ts",
+            "line": 226
+          },
+          "name": "runnerVersion",
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.RunnerVersion"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Log group where image builds are logged."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/common.ts",
+            "line": 221
+          },
+          "name": "logGroup",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_logs.LogGroup"
+          }
+        }
+      ],
+      "symbolId": "src/providers/common:RunnerAmi"
+    },
     "@cloudsnorkel/cdk-github-runners.RunnerImage": {
       "assembly": "@cloudsnorkel/cdk-github-runners",
       "datatype": true,
@@ -8322,6 +8895,6 @@
       "symbolId": "src/providers/image-builders/windows-components:WindowsComponents"
     }
   },
-  "version": "0.6.0",
-  "fingerprint": "hscwjQdZoW1Xlx10opRG51XHwCVQr0oA3/mq4GIIRJU="
+  "version": "0.6.1",
+  "fingerprint": "06rx1yqOjlpbO4/j7k8pveUDpwq2iKNbGv006geBzxs="
 }