Skip to content

Commit 3a71411

Browse files
author
iru
authored
chore: require apitoken (#62)
* doc: contribute * chore: require apitoken
1 parent 039b4b6 commit 3a71411

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,53 @@ This repository contains the CloudFormation templates to deploy the Sysdig
44
CloudVision suite in an AWS Account.
55

66
[Deploy latest version!](https://console.aws.amazon.com/cloudformation/home#/stacks/quickCreate?stackName=Sysdig-CloudVision&templateURL=https://cf-templates-cloudvision-ci.s3-eu-west-1.amazonaws.com/master/entry-point.yaml)
7+
8+
9+
## Contribute
10+
11+
12+
### Release
13+
14+
- Template is [uploaded on the CI release cycle](https://github.com/sysdiglabs/aws-cloudvision-templates/blob/main/.github/workflows/release.yaml#L63) to `cf-templates-cloudvision-ci` on Sysdig `draios-demo` account
15+
16+
Leading to the latest entry-point, which will be used on the Sysdig Secure > Getting Started > AWS Cloudformation
17+
<br/>`https://cf-templates-cloudvision-ci.s3-eu-west-1.amazonaws.com/master/entry-point.yaml`
18+
19+
20+
### Pull Request
21+
22+
When the PR is drafter a new template will be available for testing at
23+
<br/>`https://cf-templates-cloudvision-ci.s3-eu-west-1.amazonaws.com/pr/<PR_NAME>/entry-point.yaml`
24+
25+
26+
### Testing
27+
28+
see [Makefile](./templates/Makefile)
29+
30+
- Validation
31+
32+
```bash
33+
$ aws cloudformation validate-template --template-body file://./templates/CloudVision.yaml
34+
```
35+
36+
- Launch Template
37+
38+
full cycle
39+
40+
```
41+
-- test
42+
$ aws cloudformation delete-stack --stack-name test ; \
43+
sleep 10 ; \
44+
aws cloudformation deploy --template-file templates/CloudVision.yaml --stack-name test ; \
45+
aws cloudformation describe-stack-events --stack-name test
46+
```
47+
48+
- Test Template wizard (UI)
49+
```
50+
Aws console > cloudformation > create new stack (template, upload template: select ./templates/Cloudvision.yaml)
51+
```
52+
- note: this will upload the template into an s3 bucket, remember to delete it afterwards
53+
54+
55+
- **Cleanup** <br/>Delete stack to clean test environment. [CFT limitation does not allow to automatically delete non-empty S3 bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html), so Stack deletion will fail when you request it. Delete S3 bucket manually and relaunch deletion for a full cleanup.
56+

templates/CloudVision.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,15 +96,21 @@ Parameters:
9696
SysdigSecureAPIToken:
9797
Type: String
9898
NoEcho: true
99+
AllowedPattern: ".+"
100+
ConstraintDescription: "SysdigSecureAPIToken is required"
101+
99102
SysdigSecureEndpoint:
100103
Type: String
101104
Default: "https://secure.sysdig.com"
105+
102106
SysdigRoleName:
103107
Type: String
104108
Default: "SysdigAgentlessRole"
109+
105110
SysdigExternalID:
106111
Type: String
107112
Default: ""
113+
108114
SysdigTrustedIdentity:
109115
Type: String
110116
Default: ""

0 commit comments

Comments
 (0)