Skip to content

Commit de524fc

Browse files
dimikotdimikot
committed
v2.13.1: Add volumeRoot* options, add tailing of /var/log/* to a CloudWatch LogGroup per instance id; fix aws lambda invoke; speed up runner updates; pin docker versions; fix sysbox download url and add pre-built sysbox deb packages just in case they disappear again from the official site; remove rsync-tmpfs-volume-from-old-instance; upgrade typedoc
1 parent 8722172 commit de524fc

30 files changed

+8817
-5968
lines changed

‎.eslintrc.base.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,7 @@ module.exports = (projectRoot, extraRules = {}) => ({
385385
},
386386
},
387387
],
388+
"import/no-useless-path-segments": ["error", { noUselessIndex: true }],
388389
"unused-imports/no-unused-imports": "error",
389390
"no-restricted-imports": [
390391
"error",

‎.github/workflows/semgrep.yml‎

Lines changed: 0 additions & 36 deletions
This file was deleted.

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ dist
22

33
# Common in both .gitignore and .npmignore
44
node_modules
5-
package-lock.json
65
yarn.lock
6+
pnpm-lock.yaml
77
.DS_Store
88
*.log
99
*.tmp

‎.npmignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
dist/__tests__
22
dist/**/__tests__
3-
dist/tsconfig.tsbuildinfo
3+
dist/*.tsbuildinfo
44
.npmrc
55

66
# Common in both .gitignore and .npmignore
77
node_modules
88
package-lock.json
99
yarn.lock
10+
pnpm-lock.yaml
1011
.DS_Store
1112
*.log
1213
*.tmp

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
![CI run](https://github.com/clickup/ci-storage-cdk/actions/workflows/ci.yml/badge.svg?branch=main)
44

55
See also:
6-
- [full API documentation](https://github.com/clickup/ci-storage-cdk/blob/master/docs/modules.md)
6+
- [full API documentation](https://github.com/clickup/ci-storage-cdk/blob/main/docs/modules.md)
77
- [ci-storage tool documentation](https://github.com/dimikot/ci-storage)

‎docs/.nojekyll‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
@clickup/ci-storage-cdk / [Exports](modules.md)
1+
**@clickup/ci-storage-cdk**
2+
3+
***
24

35
# ci-storage-cdk: A CDK construct to deploy ci-storage infrastructure
46

57
![CI run](https://github.com/clickup/ci-storage-cdk/actions/workflows/ci.yml/badge.svg?branch=main)
68

79
See also:
8-
- [full API documentation](https://github.com/clickup/ci-storage-cdk/blob/master/docs/modules.md)
10+
- [full API documentation](https://github.com/clickup/ci-storage-cdk/blob/main/docs/modules.md)
911
- [ci-storage tool documentation](https://github.com/dimikot/ci-storage)

‎docs/classes/CiStorage.md‎

Lines changed: 36 additions & 155 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1-
[@clickup/ci-storage-cdk](../README.md) / [Exports](../modules.md) / CiStorage
1+
[**@clickup/ci-storage-cdk**](../README.md)
2+
3+
***
4+
5+
[@clickup/ci-storage-cdk](../globals.md) / CiStorage
26

37
# Class: CiStorage
48

9+
Defined in: [src/CiStorage.ts:188](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L188)
10+
511
A reusable Construct to launch ci-storage infra in some other stack. This
612
class is meant to be put in a public domain and then used in any project.
713

@@ -11,7 +17,7 @@ class is meant to be put in a public domain and then used in any project.
1117
sparse checkout), and then, `docker compose` is run. There is no need to
1218
pre-build any images or publish them anywhere, it's all done on the fly.
1319

14-
Why vanilla EC2 instances + docker-compose and not ECS or Fargate?
20+
Why vanilla EC2 instances + docker compose and not ECS or Fargate?
1521

1622
1. For ECS and Fargate, in 2 minutes after the termination warning, we only
1723
have more 2 minutes to shutdown the OS (it's documented, i.e. 4 minutes in
@@ -25,22 +31,22 @@ Why vanilla EC2 instances + docker-compose and not ECS or Fargate?
2531
3. Tests often times need to run "Docker in Docker", which is problematic in
2632
ECS and Fargate environment.
2733

28-
## Hierarchy
34+
## Extends
2935

3036
- `Construct`
3137

32-
↳ **`CiStorage`**
33-
3438
## Constructors
3539

36-
### constructor
40+
### new CiStorage()
41+
42+
> **new CiStorage**(`scope`, `key`, `props`): [`CiStorage`](CiStorage.md)
3743
38-
• **new CiStorage**(`scope`, `key`, `props`): [`CiStorage`](CiStorage.md)
44+
Defined in: [src/CiStorage.ts:206](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L206)
3945

4046
#### Parameters
4147

42-
| Name | Type |
43-
| :------ | :------ |
48+
| Parameter | Type |
49+
| ------ | ------ |
4450
| `scope` | `Construct` |
4551
| `key` | `string` |
4652
| `props` | [`CiStorageProps`](../interfaces/CiStorageProps.md) |
@@ -51,152 +57,27 @@ Why vanilla EC2 instances + docker-compose and not ECS or Fargate?
5157

5258
#### Overrides
5359

54-
Construct.constructor
55-
56-
#### Defined in
57-
58-
[src/CiStorage.ts:203](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L203)
60+
`Construct.constructor`
5961

6062
## Properties
6163

62-
### vpc
63-
64-
• `Readonly` **vpc**: `IVpc`
65-
66-
#### Defined in
67-
68-
[src/CiStorage.ts:186](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L186)
69-
70-
___
71-
72-
### hostedZone
73-
74-
• `Optional` `Readonly` **hostedZone**: `IHostedZone`
75-
76-
#### Defined in
77-
78-
[src/CiStorage.ts:187](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L187)
79-
80-
___
81-
82-
### keyPair
83-
84-
• `Readonly` **keyPair**: `IKeyPair`
85-
86-
#### Defined in
87-
88-
[src/CiStorage.ts:188](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L188)
89-
90-
___
91-
92-
### keyPairPrivateKeySecretName
93-
94-
• `Readonly` **keyPairPrivateKeySecretName**: `string`
95-
96-
#### Defined in
97-
98-
[src/CiStorage.ts:189](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L189)
99-
100-
___
101-
102-
### roles
103-
104-
• `Readonly` **roles**: `Object`
105-
106-
#### Type declaration
107-
108-
| Name | Type |
109-
| :------ | :------ |
110-
| `runner` | `Role` |
111-
| `host` | `Role` |
112-
113-
#### Defined in
114-
115-
[src/CiStorage.ts:190](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L190)
116-
117-
___
118-
119-
### securityGroup
120-
121-
• `Readonly` **securityGroup**: `SecurityGroup`
122-
123-
#### Defined in
124-
125-
[src/CiStorage.ts:191](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L191)
126-
127-
___
128-
129-
### vpcLink
130-
131-
• `Readonly` **vpcLink**: `VpcLink`
132-
133-
#### Defined in
134-
135-
[src/CiStorage.ts:192](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L192)
136-
137-
___
138-
139-
### host
140-
141-
• `Readonly` **host**: `Object`
142-
143-
#### Type declaration
144-
145-
| Name | Type |
146-
| :------ | :------ |
147-
| `fqdn` | `undefined` \| `string` |
148-
| `instance` | `CfnInstance` |
149-
150-
#### Defined in
151-
152-
[src/CiStorage.ts:193](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L193)
153-
154-
___
155-
156-
### autoScalingGroups
157-
158-
• `Readonly` **autoScalingGroups**: \{ `autoScalingGroup`: `AutoScalingGroup` ; `launchTemplate`: `LaunchTemplate` }[] = `[]`
159-
160-
#### Defined in
161-
162-
[src/CiStorage.ts:197](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L197)
163-
164-
___
165-
166-
### instanceToAmi
167-
168-
• `Readonly` **instanceToAmi**: `InstanceToAmi`
169-
170-
#### Defined in
171-
172-
[src/CiStorage.ts:201](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L201)
173-
174-
___
175-
176-
### scope
177-
178-
• `Readonly` **scope**: `Construct`
179-
180-
#### Defined in
181-
182-
[src/CiStorage.ts:204](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L204)
183-
184-
___
185-
186-
### key
187-
188-
• `Readonly` **key**: `string`
189-
190-
#### Defined in
191-
192-
[src/CiStorage.ts:205](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L205)
193-
194-
___
195-
196-
### props
197-
198-
• `Readonly` **props**: [`CiStorageProps`](../interfaces/CiStorageProps.md)
199-
200-
#### Defined in
201-
202-
[src/CiStorage.ts:206](https://github.com/clickup/ci-storage-cdk/blob/master/src/CiStorage.ts#L206)
64+
| Property | Type | Default value |
65+
| ------ | ------ | ------ |
66+
| <a id="vpc"></a> `vpc` | `IVpc` | `undefined` |
67+
| <a id="hostedzone"></a> `hostedZone?` | `IHostedZone` | `undefined` |
68+
| <a id="keypair"></a> `keyPair` | `IKeyPair` | `undefined` |
69+
| <a id="keypairprivatekeysecretname"></a> `keyPairPrivateKeySecretName` | `string` | `undefined` |
70+
| <a id="roles"></a> `roles` | `object` | `undefined` |
71+
| `roles.runner` | `Role` | `undefined` |
72+
| `roles.host` | `Role` | `undefined` |
73+
| <a id="securitygroup"></a> `securityGroup` | `SecurityGroup` | `undefined` |
74+
| <a id="vpclink"></a> `vpcLink` | `VpcLink` | `undefined` |
75+
| <a id="host"></a> `host` | `object` | `undefined` |
76+
| `host.fqdn` | `undefined` \| `string` | `undefined` |
77+
| `host.instance` | `CfnInstance` | `undefined` |
78+
| <a id="autoscalinggroups"></a> `autoScalingGroups` | `object`[] | `[]` |
79+
| <a id="instancetoami"></a> `instanceToAmi` | `InstanceToAmi` | `undefined` |
80+
| <a id="loggroupname"></a> `logGroupName` | `string` | `undefined` |
81+
| <a id="scope-1"></a> `scope` | `Construct` | `undefined` |
82+
| <a id="key-1"></a> `key` | `string` | `undefined` |
83+
| <a id="props-1"></a> `props` | [`CiStorageProps`](../interfaces/CiStorageProps.md) | `undefined` |

docs/modules.md renamed to docs/globals.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
[@clickup/ci-storage-cdk](README.md) / Exports
1+
[**@clickup/ci-storage-cdk**](README.md)
2+
3+
***
24

35
# @clickup/ci-storage-cdk
46

0 commit comments

Comments
 (0)