@cloudsnorkel/cdk-github-runners 0.7.1 → 0.7.2

package/.jsii

@@ -3169,6 +3169,629 @@
     }
   },
   "types": {
+    "@cloudsnorkel/cdk-github-runners.AmiBuilder": {
+      "assembly": "@cloudsnorkel/cdk-github-runners",
+      "base": "constructs.Construct",
+      "docs": {
+        "remarks": "Builders can be used with {@link Ec2Runner}.\n\nEach builder re-runs automatically at a set interval to make sure the AMIs contain the latest versions of everything.\n\nYou can create an instance of this construct to customize the AMI used to spin-up runners. Some runner providers may require custom components. Check the runner provider documentation.\n\nFor example, to set a specific runner version, rebuild the image every 2 weeks, and add a few packages for the EC2 provider, use:\n\n```\nconst builder = new AmiBuilder(this, 'Builder', {\n     runnerVersion: RunnerVersion.specific('2.293.0'),\n     rebuildInterval: Duration.days(14),\n});\nbuilder.addComponent(new ImageBuilderComponent(scope, id, {\n   platform: 'Linux',\n   displayName: 'p7zip',\n   description: 'Install some more packages',\n   commands: [\n     'set -ex',\n     'apt-get install p7zip',\n   ],\n}));\nnew Ec2Runner(this, 'EC2 provider', {\n     label: 'custom-ec2',\n     amiBuilder: builder,\n});\n```",
+        "stability": "experimental",
+        "summary": "An AMI builder that uses AWS Image Builder to build AMIs pre-baked with all the GitHub Actions runner requirements."
+      },
+      "fqn": "@cloudsnorkel/cdk-github-runners.AmiBuilder",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/providers/image-builders/ami.ts",
+          "line": 223
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "optional": true,
+            "type": {
+              "fqn": "@cloudsnorkel/cdk-github-runners.AmiBuilderProps"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "@cloudsnorkel/cdk-github-runners.IAmiBuilder",
+        "aws-cdk-lib.aws_ec2.IConnectable"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/providers/image-builders/ami.ts",
+        "line": 220
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Add a component to be installed."
+          },
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 285
+          },
+          "name": "addComponent",
+          "parameters": [
+            {
+              "name": "component",
+              "type": {
+                "fqn": "@cloudsnorkel/cdk-github-runners.ImageBuilderComponent"
+              }
+            }
+          ]
+        },
+        {
+          "docs": {
+            "remarks": "This helps deal with self-signed certificates for GitHub Enterprise Server.",
+            "stability": "experimental",
+            "summary": "Add extra trusted certificates."
+          },
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 300
+          },
+          "name": "addExtraCertificates",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "path to directory containing a file called certs.pem containing all the required certificates."
+              },
+              "name": "path",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ]
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Called by IRunnerProvider to finalize settings and create the AMI builder."
+          },
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 313
+          },
+          "name": "bind",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IAmiBuilder",
+          "returns": {
+            "type": {
+              "fqn": "@cloudsnorkel/cdk-github-runners.RunnerAmi"
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/providers/image-builders/common.ts",
+            "line": 452
+          },
+          "name": "createImage",
+          "parameters": [
+            {
+              "name": "infra",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_imagebuilder.CfnInfrastructureConfiguration"
+              }
+            },
+            {
+              "name": "dist",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_imagebuilder.CfnDistributionConfiguration"
+              }
+            },
+            {
+              "name": "log",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_logs.LogGroup"
+              }
+            },
+            {
+              "name": "imageRecipeArn",
+              "optional": true,
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "containerRecipeArn",
+              "optional": true,
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "protected": true,
+          "returns": {
+            "type": {
+              "fqn": "aws-cdk-lib.aws_imagebuilder.CfnImage"
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/providers/image-builders/common.ts",
+            "line": 428
+          },
+          "name": "createInfrastructure",
+          "parameters": [
+            {
+              "name": "managedPolicies",
+              "type": {
+                "collection": {
+                  "elementtype": {
+                    "fqn": "aws-cdk-lib.aws_iam.IManagedPolicy"
+                  },
+                  "kind": "array"
+                }
+              }
+            }
+          ],
+          "protected": true,
+          "returns": {
+            "type": {
+              "fqn": "aws-cdk-lib.aws_imagebuilder.CfnInfrastructureConfiguration"
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/providers/image-builders/common.ts",
+            "line": 420
+          },
+          "name": "createLog",
+          "parameters": [
+            {
+              "name": "recipeName",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "protected": true,
+          "returns": {
+            "type": {
+              "fqn": "aws-cdk-lib.aws_logs.LogGroup"
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/providers/image-builders/common.ts",
+            "line": 469
+          },
+          "name": "createPipeline",
+          "parameters": [
+            {
+              "name": "infra",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_imagebuilder.CfnInfrastructureConfiguration"
+              }
+            },
+            {
+              "name": "dist",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_imagebuilder.CfnDistributionConfiguration"
+              }
+            },
+            {
+              "name": "log",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_logs.LogGroup"
+              }
+            },
+            {
+              "name": "imageRecipeArn",
+              "optional": true,
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "containerRecipeArn",
+              "optional": true,
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "protected": true,
+          "returns": {
+            "type": {
+              "fqn": "aws-cdk-lib.aws_imagebuilder.CfnImagePipeline"
+            }
+          }
+        },
+        {
+          "docs": {
+            "remarks": "Useful for required system settings like certificates or proxy settings.",
+            "stability": "experimental",
+            "summary": "Add a component to be installed before any other components."
+          },
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 271
+          },
+          "name": "prependComponent",
+          "parameters": [
+            {
+              "name": "component",
+              "type": {
+                "fqn": "@cloudsnorkel/cdk-github-runners.ImageBuilderComponent"
+              }
+            }
+          ]
+        }
+      ],
+      "name": "AmiBuilder",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/common.ts",
+            "line": 343
+          },
+          "name": "architecture",
+          "protected": true,
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.Architecture"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "The network connections associated with this resource."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/common.ts",
+            "line": 499
+          },
+          "name": "connections",
+          "overrides": "aws-cdk-lib.aws_ec2.IConnectable",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.Connections"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/common.ts",
+            "line": 347
+          },
+          "name": "description",
+          "protected": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/common.ts",
+            "line": 344
+          },
+          "name": "os",
+          "protected": true,
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.Os"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/common.ts",
+            "line": 345
+          },
+          "name": "platform",
+          "protected": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/common.ts",
+            "line": 349
+          },
+          "name": "runnerVersion",
+          "protected": true,
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.RunnerVersion"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/providers/image-builders/common.ts",
+            "line": 351
+          },
+          "name": "components",
+          "protected": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "@cloudsnorkel/cdk-github-runners.ImageBuilderComponent"
+              },
+              "kind": "array"
+            }
+          }
+        }
+      ],
+      "symbolId": "src/providers/image-builders/ami:AmiBuilder"
+    },
+    "@cloudsnorkel/cdk-github-runners.AmiBuilderProps": {
+      "assembly": "@cloudsnorkel/cdk-github-runners",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Properties for {@link AmiBuilder} construct."
+      },
+      "fqn": "@cloudsnorkel/cdk-github-runners.AmiBuilderProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/providers/image-builders/ami.ts",
+        "line": 24
+      },
+      "name": "AmiBuilderProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "Architecture.X86_64",
+            "stability": "experimental",
+            "summary": "Image architecture."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 30
+          },
+          "name": "architecture",
+          "optional": true,
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.Architecture"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "m5.large",
+            "stability": "experimental",
+            "summary": "The instance type used to build the image."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 90
+          },
+          "name": "instanceType",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.InstanceType"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "RemovalPolicy.DESTROY",
+            "remarks": "If deployment fails on the custom resource, try setting this to `RemovalPolicy.RETAIN`. This way the logs can still be viewed, and you can see why the build failed.\n\nWe try to not leave anything behind when removed. But sometimes a log staying behind is useful.",
+            "stability": "experimental",
+            "summary": "Removal policy for logs of image builds."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 108
+          },
+          "name": "logRemovalPolicy",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.RemovalPolicy"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "logs.RetentionDays.ONE_MONTH",
+            "remarks": "When updating\nthis property, unsetting it doesn't remove the log retention policy. To\nremove the retention policy, set the value to `INFINITE`.",
+            "stability": "experimental",
+            "summary": "The number of days log events are kept in CloudWatch Logs."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 99
+          },
+          "name": "logRetention",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_logs.RetentionDays"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "OS.LINUX",
+            "stability": "experimental",
+            "summary": "Image OS."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 37
+          },
+          "name": "os",
+          "optional": true,
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.Os"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "Duration.days(7)",
+            "remarks": "Useful for keeping the AMI up-do-date with the latest GitHub runner version and latest OS updates.\n\nSet to zero to disable.",
+            "stability": "experimental",
+            "summary": "Schedule the AMI to be rebuilt every given interval."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 53
+          },
+          "name": "rebuildInterval",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.Duration"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "latest version available",
+            "stability": "experimental",
+            "summary": "Version of GitHub Runners to install."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 44
+          },
+          "name": "runnerVersion",
+          "optional": true,
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.RunnerVersion"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "new security group",
+            "deprecated": "use {@link securityGroups}",
+            "stability": "deprecated",
+            "summary": "Security group to assign to launched builder instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 69
+          },
+          "name": "securityGroup",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "new security group",
+            "stability": "experimental",
+            "summary": "Security groups to assign to launched builder instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 76
+          },
+          "name": "securityGroups",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "default VPC subnet",
+            "remarks": "Only the first matched subnet will be used.",
+            "stability": "experimental",
+            "summary": "Where to place the network interfaces within the VPC."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 83
+          },
+          "name": "subnetSelection",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.SubnetSelection"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "default account VPC",
+            "stability": "experimental",
+            "summary": "VPC where builder instances will be launched."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 60
+          },
+          "name": "vpc",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.IVpc"
+          }
+        }
+      ],
+      "symbolId": "src/providers/image-builders/ami:AmiBuilderProps"
+    },
     "@cloudsnorkel/cdk-github-runners.Architecture": {
       "assembly": "@cloudsnorkel/cdk-github-runners",
       "docs": {
@@ -9013,6 +9636,6 @@
       "symbolId": "src/providers/image-builders/windows-components:WindowsComponents"
     }
   },
-  "version": "0.7.1",
-  "fingerprint": "nV06UyftJlEK3eahLrUS/kkWduUHm+k6O9W1v2jTDX4="
+  "version": "0.7.2",
+  "fingerprint": "4HxP5z3vyA+XMrHiQPYYCxZms8CLpqg1YeSfxwpEKtk="
 }