Split into more files; add support for persistent volume in host inst…

…ances
clickup · Mar 19, 2024 · e6f5167 · e6f5167
1 parent eb8db7a
commit e6f5167
Show file tree

Hide file tree

Showing 11 changed files with 870 additions and 311 deletions.
diff --git a/docs/classes/CiStorage.md b/docs/classes/CiStorage.md
@@ -53,7 +53,7 @@ Construct.constructor
 
 #### Defined in
 
-[src/CiStorage.ts:306](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L306)
+[src/CiStorage.ts:161](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L161)
 
 ## Properties
 
@@ -63,7 +63,7 @@ Construct.constructor
 
 #### Defined in
 
-[src/CiStorage.ts:296](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L296)
+[src/CiStorage.ts:150](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L150)
 
 ___
 
@@ -73,7 +73,7 @@ ___
 
 #### Defined in
 
-[src/CiStorage.ts:297](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L297)
+[src/CiStorage.ts:151](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L151)
 
 ___
 
@@ -83,7 +83,7 @@ ___
 
 #### Defined in
 
-[src/CiStorage.ts:298](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L298)
+[src/CiStorage.ts:152](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L152)
 
 ___
 
@@ -93,17 +93,24 @@ ___
 
 #### Defined in
 
-[src/CiStorage.ts:299](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L299)
+[src/CiStorage.ts:153](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L153)
 
 ___
 
-### role
+### roles
 
-• `Readonly` **role**: `Role`
+• `Readonly` **roles**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `runner` | `Role` |
+| `host` | `Role` |
 
 #### Defined in
 
-[src/CiStorage.ts:300](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L300)
+[src/CiStorage.ts:154](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L154)
 
 ___
 
@@ -113,7 +120,7 @@ ___
 
 #### Defined in
 
-[src/CiStorage.ts:301](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L301)
+[src/CiStorage.ts:155](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L155)
 
 ___
 
@@ -123,7 +130,7 @@ ___
 
 #### Defined in
 
-[src/CiStorage.ts:302](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L302)
+[src/CiStorage.ts:156](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L156)
 
 ___
 
@@ -133,7 +140,7 @@ ___
 
 #### Defined in
 
-[src/CiStorage.ts:303](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L303)
+[src/CiStorage.ts:157](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L157)
 
 ___
 
@@ -143,7 +150,17 @@ ___
 
 #### Defined in
 
-[src/CiStorage.ts:304](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L304)
+[src/CiStorage.ts:158](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L158)
+
+___
+
+### hostVolumes
+
+• `Readonly` **hostVolumes**: `CfnVolume`[] = `[]`
+
+#### Defined in
+
+[src/CiStorage.ts:159](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L159)
 
 ___
 
@@ -153,7 +170,7 @@ ___
 
 #### Defined in
 
-[src/CiStorage.ts:307](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L307)
+[src/CiStorage.ts:162](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L162)
 
 ___
 
@@ -163,7 +180,7 @@ ___
 
 #### Defined in
 
-[src/CiStorage.ts:308](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L308)
+[src/CiStorage.ts:163](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L163)
 
 ___
 
@@ -173,4 +190,4 @@ ___
 
 #### Defined in
 
-[src/CiStorage.ts:309](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L309)
+[src/CiStorage.ts:164](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L164)
diff --git a/docs/interfaces/CiStorageProps.md b/docs/interfaces/CiStorageProps.md
@@ -17,7 +17,7 @@ VPC to use by this construct.
 
 #### Defined in
 
-[src/CiStorage.ts:48](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L48)
+[src/CiStorage.ts:52](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L52)
 
 ___
 
@@ -30,7 +30,7 @@ instances.
 
 #### Defined in
 
-[src/CiStorage.ts:51](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L51)
+[src/CiStorage.ts:55](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L55)
 
 ___
 
@@ -42,7 +42,7 @@ Id of the Security Group to set for the created instances.
 
 #### Defined in
 
-[src/CiStorage.ts:53](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L53)
+[src/CiStorage.ts:57](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L57)
 
 ___
 
@@ -61,7 +61,7 @@ A Hosted Zone to register the host instances in.
 
 #### Defined in
 
-[src/CiStorage.ts:55](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L55)
+[src/CiStorage.ts:59](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L59)
 
 ___
 
@@ -74,7 +74,7 @@ must pre-exist.
 
 #### Defined in
 
-[src/CiStorage.ts:63](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L63)
+[src/CiStorage.ts:67](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L67)
 
 ___
 
@@ -102,7 +102,7 @@ Configuration for self-hosted runner instances in the pool.
 
 #### Defined in
 
-[src/CiStorage.ts:65](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L65)
+[src/CiStorage.ts:69](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L69)
 
 ___
 
@@ -120,10 +120,12 @@ runner has its localhost ports redirected to that instance.
 | :------ | :------ | :------ |
 | `ghDockerComposeDirectoryUrl` | `string` | URL of docker-compose.yml (or compose.yml) directory. The tool will sparse-checkout that directory. The format is Dockerfile-compatible: https://github.com/owner/repo[#[branch]:/directory/with/compose/] |
 | `imageSsmName` | `string` | SSM parameter name which holds the reference to an instance image. |
-| `volumeGb` | `number` | Size of the root volume. |
+| `volumeIops` | `number` | IOPS of the docker volume. |
+| `volumeThroughput` | `number` | Throughput of the docker volume in MiB/s. |
+| `volumeGb` | `number` | Size of the docker volume. |
 | `instanceType` | `string` | Full name of the Instance type. |
 | `machines` | `number` | Number of instances to create. |
 
 #### Defined in
 
-[src/CiStorage.ts:103](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L103)
+[src/CiStorage.ts:107](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L107)
diff --git a/docs/modules.md b/docs/modules.md
@@ -9,25 +9,3 @@
 ## Interfaces
 
 - [CiStorageProps](interfaces/CiStorageProps.md)
-
-## Functions
-
-### dedent
-
-▸ **dedent**(`text`): `string`
-
-Removes leading indentation from all lines of the text.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `text` | `string` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/CiStorage.ts:561](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L561)
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@clickup/ci-storage-cdk",
   "description": "A CDK construct to deploy ci-storage infrastructure",
-  "version": "2.10.291",
+  "version": "2.10.292",
   "license": "MIT",
   "keywords": [
     "cdk",