Skip to content

Commit f444910

Browse files
author
iru
authored
docs: homogeneize three-way use-cases (#145)
1 parent 2c99708 commit f444910

File tree

3 files changed

+31
-36
lines changed

3 files changed

+31
-36
lines changed

use-cases/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ If not Terraform nor Cloudformation suits, take a look at the `manual-*` prefixe
4646
| Deployment Type | all Sysdig resources will be deployed within the selected account | Most Sysdig resources will be deployed within the selected account (just one), but some features, require resources to be deployed on all of the member-accounts (for Compliance and Image Scanning) . <br />One role is needed on the management account for cloudtrail-s3 event access |
4747
| Target | will only analyse current account | handles all accounts (managed and member)|
4848
| Drawbacks | cannot re-use another account Cloudtrail data (unless its deployed on the same account where the sns/s3 bucket is) | for scanning, a per-member-account access role is required |
49-
| Optional resources usage limitations | - | For organizational example, Cloudtrail optional resources must exist in the management account. For other setups check other alternative use-cases</br><ul><li>[manual deployment; cloudtrail-s3 bucket in another member account](./manual-org-three-way.md)</li><li>[terraform-based deployment; cloudtrail with cloudtrail-s3 bucket in another member account. k8s flavor](./org-s3-k8s-filtered-account.md)</li><li>[terraform-based deployment; cloudtrail with cloudtrail-s3 bucket in another member account. ecs flavor](./org-three-cross-account-s3-event-forward.md)</li></ul>|
49+
| Optional resources usage limitations | - | For organizational example, Cloudtrail optional resources must exist in the management account. For other setups check other alternative use-cases</br><ul><li>[manual deployment; cloudtrail-s3 bucket in another member account](./manual-org-three-way.md)</li><li>[terraform-based deployment; cloudtrail with cloudtrail-s3 bucket in another member account. k8s flavor](./org-three-way-k8s.md)</li><li>[terraform-based deployment; cloudtrail with cloudtrail-s3 bucket in another member account. ecs flavor](./org-three-way-ecs.md)</li></ul>|
5050
| More Info | [single-ecs](https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/tree/master/examples/single-account-ecs), [single-apprunner](https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/tree/master/examples/single-account-apprunner), [single-k8s](https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/tree/master/examples/single-account-k8s) | [organizational](https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/tree/master/examples/organizational) |
5151

5252
With both examples `single` and `org`, you can customize the desired features to de deployed with the `deploy_*` input vars to avoid deploying more than wanted.

use-cases/org-three-cross-account-s3-event-forward.md renamed to use-cases/org-three-way-ecs.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1-
# OrganizationSetup - Three way Cross-Account - Cloudtrail with no SNS - Event Notification with S3-SNS-SQS
1+
# OrganizationSetup - Three way Cross-Account - ECS
22

33
## Use-Case explanation
44

5-
This use case will cover
5+
This use case will cover a three-way cross-account setup (typical from AWS ControlTower landing page).
6+
With ECS as workload-type.
7+
<br/>This is terraform-based guidelines, but can also check [Manual Organizational Setup - Three-Way Cross-Account ](./manual-org-three-way.md)
68

7-
- **User Infrastructure Setup**: AWS Organization Setup with three-way account setup
9+
10+
- **User Infrastructure Setup**:
811
1. Management Account
912
- Organizational Cloudtrail with no SNS activation
1013
2. Log Archive Account

use-cases/org-s3-k8s-filtered-account.md renamed to use-cases/org-three-way-k8s.md

Lines changed: 24 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,27 @@
1-
# OrganizationalSetup - Existing CloudtrailEventsOnS3 - Existing K8s Cluster - Filtered Account
1+
# OrganizationalSetup - Three way Cross-Account - K8S
22

33
## Use-Case explanation
44

5-
**Current User Setup**
6-
7-
- [X] organizational setup
8-
- [ ] organizational cloudtrail that reports to SNS and persists events in a managed-account stored S3 bucket
9-
- [X] centralized S3 bucket with cloudtrail-events
10-
- [ ] member account usage - all required and pre-existing resources exist in the same account
11-
- [X] member account usage - all required resources are in scattered
12-
- [X] pre-existing resources
13-
- [ ] k8s cluster we want to use to deploy Sysdig for Cloud workload
14-
- [ ] organizational cloudtrail, reporting to an SNS topic and delivering events to the S3 bucket
15-
- [ ] ecs cluster/vpc/subnet we want to use to deploy Sysdig for Cloud workload
16-
17-
18-
**Sysdig Secure For Cloud Features**
19-
20-
- [X] threat-detection
21-
- [X] account-specific
22-
- [ ] all accounts of the organization (management account included)
23-
- [ ] image-scanning (WIP?)
24-
- [ ] compliance (WIP?)
25-
- [ ] CIEM (WIP?)
26-
27-
**Other Requirements**
28-
29-
- [X] pre-existing kubernetes management vía service account (WIP)
30-
<br/>this has not been tested yet, we rely on an `accessKey` created specifically for Sysdig-For-Cloud.
31-
<!--
32-
Skip step 4 and remove `aws_access_key_id` and `aws_secret_access_key` parameters from `org_k8s_threat_reuse_cloudtrail` module
33-
-->
5+
This use case will cover a three-way cross-account setup (typical from AWS ControlTower landing page).
6+
With EKS as workload-type.
7+
<br/>This is terraform-based guidelines, but can also check [Manual Organizational Setup - Three-Way Cross-Account ](./manual-org-three-way.md)
8+
9+
- **User Infrastructure Setup**:
10+
1. Management Account
11+
- Organizational Cloudtrail with no SNS activation
12+
2. Log Archive Account
13+
- Cloudtrail-S3 bucket, with event notification to an SNS > SQS
14+
3. Member Account
15+
- Sysdig Secure for cloud deployment
16+
- Existing K8S Cluster
17+
- permission setup rely on an `accessKey/secretAccessKey` parameters of the workload, but can setup the
18+
service-account manually and ignore those two parameters.
19+
20+
- Required **Sysdig Secure For Cloud [Features](https://docs.sysdig.com/en/docs/installation/sysdig-secure-for-cloud/)**
21+
- Threat-Detection
22+
- :warning: Posture; Compliance + Identity Access Management not delivered with this use-case. Can use [manual compliance setup](./manual-compliance.md)
23+
- :warning: Cloud image scanning is not supported yet
24+
3425

3526
## Suggested building-blocks
3627

@@ -77,7 +68,8 @@ provider "helm" {
7768
```text
7869
cloudtrail_s3_name=cloudtrail-logging-237944556329
7970
```
80-
2. Populate `CLOUDTRAIL_S3_FILTER_PREFIX` in order to ingest a specific-account. Otherwise, just remove its assignation
71+
2. Optionally, populate `CLOUDTRAIL_S3_FILTER_PREFIX` in order to ingest a specific-account. Otherwise, just remove
72+
its assignation
8173
<br/>ex.:
8274
```text
8375
s3_event_notification_filter_prefix=cloudtrail/AWSLogs/237944556329
@@ -90,7 +82,7 @@ module "cloudtrail_s3_sns_sqs" {
9082
}
9183
source = "sysdiglabs/secure-for-cloud/aws//modules/infrastructure/cloudtrail_s3-sns-sqs"
9284
cloudtrail_s3_name = "<CLOUDTRAIL_S3_NAME>"
93-
s3_event_notification_filter_prefix="<CLOUDTRAIL_S3_FILTER_PREFIX>"
85+
# s3_event_notification_filter_prefix="<CLOUDTRAIL_S3_FILTER_PREFIX>"
9486
}
9587
```
9688

0 commit comments

Comments
 (0)