@rio-cloud/cdk-v2-constructs 6.2.1 → 6.3.0

package/.jsii

@@ -6128,6 +6128,302 @@
       "name": "Framework",
       "symbolId": "src/fargate/rio-fargate-service:Framework"
     },
+    "@rio-cloud/cdk-v2-constructs.GitLabRunnerProps": {
+      "assembly": "@rio-cloud/cdk-v2-constructs",
+      "datatype": true,
+      "docs": {
+        "remarks": "By default, a T3 Micro instance will be used.\nFor larger workloads and very active teams it is recommended to use T3 Small for the manager instead.",
+        "stability": "stable",
+        "summary": "The GitLabRunnerProps require the VPC ID, a defined environment of account and region, optional runner configuration and optionally the GitLab Runner Manager instance type."
+      },
+      "fqn": "@rio-cloud/cdk-v2-constructs.GitLabRunnerProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+        "line": 20
+      },
+      "name": "GitLabRunnerProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+            "line": 24
+          },
+          "name": "cache",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_s3.IBucket"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+            "line": 21
+          },
+          "name": "env",
+          "type": {
+            "fqn": "aws-cdk-lib.Environment"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+            "line": 23
+          },
+          "name": "managerInstanceType",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.InstanceType"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+            "line": 22
+          },
+          "name": "runnersWorkerProps",
+          "optional": true,
+          "type": {
+            "fqn": "@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps"
+          }
+        }
+      ],
+      "symbolId": "src/contributions/smart-route/gitlab-runner/autoscaling-runner:GitLabRunnerProps"
+    },
+    "@rio-cloud/cdk-v2-constructs.GitlabRunner": {
+      "assembly": "@rio-cloud/cdk-v2-constructs",
+      "base": "constructs.Construct",
+      "docs": {
+        "remarks": "By default, the construct will create a Runner with a manager T3 Micro instance which will be enabled to spawn T3 Large Runner\nworker spot instance. The default runner Role has only the permissions to upload and download from the S3 runner cache.\n\nminimal configuration with runner spot instance:\n```ts\nnew SpotServiceLinkedRole(stack, 'SpotLinkedRole');\nconst myBucket = new Bucket(stack, 'MyShareRunnerCache', {\n    enforceSSL: true,\n    publicReadAccess: false,\n    encryption: BucketEncryption.S3_MANAGED,\n    lifecycleRules: [\n      {\n        enabled: true,\n        expiration: Duration.days(30),\n      },\n    ],\n  });\nnew GitlabRunner(stack, 'GitLabRunner', {\n env: {account: '123456789012', region: 'eu-west-1'},\n cache: myBucket // use a S3 bucket without public access and a retention defined, use one cache bucket for all you runners\n});\n```\nrecommended:\n```ts\nnew SpotServiceLinkedRole(stack, 'SpotLinkedRole');\nconst runnerRoles = new RunnerRoles(stack, 'RunnerRoles', {env: {account: '123456789012', region: 'eu-west-1'}});\nconst myBucket = new Bucket(stack, 'MyShareRunnerCache', {\n    enforceSSL: true,\n    publicReadAccess: false,\n    encryption: BucketEncryption.S3_MANAGED,\n    lifecycleRules: [\n      {\n        enabled: true,\n        expiration: Duration.days(30),\n      },\n    ],\n  });\nnew GitlabRunner(stack, 'GitLabRunner', {\n env: {account: '123456789012', region: 'eu-west-1'},\n cache: myBucket // // use a S3 bucket without public access and a retention defined, use one cache bucket for all you runners\n runnersWorkerProps: {\n   token: myTokenForTaggedRunner1, // with this runner we only want to run jobs that require more power\n   gitInstanceUrl: 'https://gitlab.cicd.man', // or the Traton GitLab\n   instanceType: InstanceType.of(InstanceClass.M7I_FLEX, InstanceSize.XLARGE), // exemplary larger runner\n   spotPrice: 0.2, // exemplary spot price\n   requestSpotPrice: true,\n   defaultWorkerRole: runnerRoles.runnerBaseRole, // use the base role\n },\n});\n```",
+        "stability": "stable",
+        "summary": "The construct create the GitLabRunner Manager instance which will autoscale Runner instances based on the configuration."
+      },
+      "fqn": "@rio-cloud/cdk-v2-constructs.GitlabRunner",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+          "line": 116
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "aws-cdk-lib.Stack"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@rio-cloud/cdk-v2-constructs.GitLabRunnerProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+        "line": 111
+      },
+      "name": "GitlabRunner",
+      "symbolId": "src/contributions/smart-route/gitlab-runner/autoscaling-runner:GitlabRunner"
+    },
+    "@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps": {
+      "assembly": "@rio-cloud/cdk-v2-constructs",
+      "datatype": true,
+      "docs": {
+        "remarks": "It is recommended to use the RunnerRoles construct, and it's exposed default runner role.",
+        "stability": "stable",
+        "summary": "The GitlabRunnerWorkerProps interface provides a simplified GitLab Runner worker configuration requiring a token as an SSM parameter, one of the valid gitlab URLs, instance of you choice, the desired max spot price, whether to use spot instance or not and a default role."
+      },
+      "fqn": "@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+        "line": 33
+      },
+      "name": "GitlabRunnerWorkerProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The default role for the runner worker when spawned."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+            "line": 45
+          },
+          "name": "defaultWorkerRole",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_iam.IRole"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The GitLab instance URL, either https://gitlab.cicd.man or https://gitlab.collaborationlayer-traton.com."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+            "line": 37
+          },
+          "name": "gitInstanceUrl",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The instance type for the runner worker."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+            "line": 39
+          },
+          "name": "instanceType",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.InstanceType"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "Whether to use spot instance or not, Requires ServiceLinked Role for EC2 Spot to be deployed in the account."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+            "line": 43
+          },
+          "name": "requestSpotPrice",
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The desired max spot price."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+            "line": 41
+          },
+          "name": "spotPrice",
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The SSM StringParameter with the registered runner token."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+            "line": 35
+          },
+          "name": "token",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ssm.IStringParameter"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Default 10",
+            "stability": "stable",
+            "summary": "The maximum number of builds for an instance before it has to be decommissioned."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+            "line": 47
+          },
+          "name": "maxBuilds",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Default 5",
+            "stability": "stable",
+            "summary": "The maximum number of instances to keep idle for new incoming jobs."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+            "line": 49
+          },
+          "name": "maxIdleInstance",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Default 900 seconds",
+            "stability": "stable",
+            "summary": "The maximum idle time seconds for an instance."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/smart-route/gitlab-runner/autoscaling-runner.ts",
+            "line": 51
+          },
+          "name": "maxIdleTime",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        }
+      ],
+      "symbolId": "src/contributions/smart-route/gitlab-runner/autoscaling-runner:GitlabRunnerWorkerProps"
+    },
     "@rio-cloud/cdk-v2-constructs.IAppStackFactory": {
       "assembly": "@rio-cloud/cdk-v2-constructs",
       "docs": {
@@ -9498,6 +9794,100 @@
       ],
       "symbolId": "src/pipeline/rio-backup-secrets-restore-stage:RioSecretsDeployStepProps"
     },
+    "@rio-cloud/cdk-v2-constructs.RunnerRoleProps": {
+      "assembly": "@rio-cloud/cdk-v2-constructs",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@rio-cloud/cdk-v2-constructs.RunnerRoleProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/contributions/smart-route/gitlab-runner/runner-roles.ts",
+        "line": 16
+      },
+      "name": "RunnerRoleProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/smart-route/gitlab-runner/runner-roles.ts",
+            "line": 17
+          },
+          "name": "env",
+          "type": {
+            "fqn": "aws-cdk-lib.Environment"
+          }
+        }
+      ],
+      "symbolId": "src/contributions/smart-route/gitlab-runner/runner-roles:RunnerRoleProps"
+    },
+    "@rio-cloud/cdk-v2-constructs.RunnerRoles": {
+      "assembly": "@rio-cloud/cdk-v2-constructs",
+      "base": "constructs.Construct",
+      "docs": {
+        "remarks": "The roles need to be assumed during job runtime to perform more permissive actions, such as creating certificates to\nauthenticate towards the RIO MSK, pushing docker images to ECR, performing a secrets backup, deploying stacks,\nor to publish an SPA to a S3 bucket. Do not assume the deployment role unless needed.\nThe base role can be the default role attached to GitLab runners.\nThe role allows to read various basic parameters such as the NIST data mirror, the OSS license bucket, DataDog keys\nand to pull ECR images form public Gallery or the specified account in the environment.\nThe Role ARNs are export using CFNOutputs. Use the outputs to configure environment variables in your GitLab group.",
+        "stability": "stable",
+        "summary": "This construct provides a set of base roles for gitlab runners in order to build, test, validate and deploy applications on RIO."
+      },
+      "fqn": "@rio-cloud/cdk-v2-constructs.RunnerRoles",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/contributions/smart-route/gitlab-runner/runner-roles.ts",
+          "line": 32
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "aws-cdk-lib.Stack"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@rio-cloud/cdk-v2-constructs.RunnerRoleProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/contributions/smart-route/gitlab-runner/runner-roles.ts",
+        "line": 30
+      },
+      "name": "RunnerRoles",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/smart-route/gitlab-runner/runner-roles.ts",
+            "line": 31
+          },
+          "name": "runnerBaseRole",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_iam.Role"
+          }
+        }
+      ],
+      "symbolId": "src/contributions/smart-route/gitlab-runner/runner-roles:RunnerRoles"
+    },
     "@rio-cloud/cdk-v2-constructs.ShouldOverrideThresholdProps": {
       "assembly": "@rio-cloud/cdk-v2-constructs",
       "datatype": true,
@@ -9593,6 +9983,45 @@
       ],
       "symbolId": "src/watchful/watchful:ShouldOverrideThresholdReturnProps"
     },
+    "@rio-cloud/cdk-v2-constructs.SpotServiceLinkedRole": {
+      "assembly": "@rio-cloud/cdk-v2-constructs",
+      "base": "constructs.Construct",
+      "docs": {
+        "stability": "stable",
+        "summary": "The construct creates a service linked role required to run GitLab Runners using Spot EC2 instances."
+      },
+      "fqn": "@rio-cloud/cdk-v2-constructs.SpotServiceLinkedRole",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/contributions/smart-route/gitlab-runner/spot-role.ts",
+          "line": 9
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/contributions/smart-route/gitlab-runner/spot-role.ts",
+        "line": 8
+      },
+      "name": "SpotServiceLinkedRole",
+      "symbolId": "src/contributions/smart-route/gitlab-runner/spot-role:SpotServiceLinkedRole"
+    },
     "@rio-cloud/cdk-v2-constructs.TriggerKey": {
       "assembly": "@rio-cloud/cdk-v2-constructs",
       "docs": {
@@ -16309,5 +16738,5 @@
     }
   },
   "version": "0.0.0",
-  "fingerprint": "vpDlySGr5n//8kkjLy5zFrJZUFzANznNblVJs8b3bl0="
+  "fingerprint": "vkv0ByaY8bMTd8OsR9NHooh1ytKdvwQivH2W8ggVLS4="
 }

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [6.3.0](https://bitbucket.collaboration-man.com/projects/RIODEV/repos/cdk-v2-constructs/compare/commits?targetBranch=refs%2Ftags%2Fv6.2.2&sourceBranch=refs%2Ftags%2Fv6.3.0) (2024-07-23)
+
+
+### Features
+
+* adjust gitlab runner construct to handle new registration process and change worker props since now one manager can only handle one runner group ([f744213](https://bitbucket.collaboration-man.com/projects/RIODEV/repos/cdk-v2-constructs/commits/f74421342e21729a4b8732e4913ad31d93f0d818))
+
+## [6.2.2](https://bitbucket.collaboration-man.com/projects/RIODEV/repos/cdk-v2-constructs/compare/commits?targetBranch=refs%2Ftags%2Fv6.2.1&sourceBranch=refs%2Ftags%2Fv6.2.2) (2024-07-19)
+
 ## [6.2.1](https://bitbucket.collaboration-man.com/projects/RIODEV/repos/cdk-v2-constructs/compare/commits?targetBranch=refs%2Ftags%2Fv6.2.0&sourceBranch=refs%2Ftags%2Fv6.2.1) (2024-07-19)