Skip to content

Commit a1cf13c

Browse files
author
iru
authored
docs: reorganize main readme and fix links
1 parent d8cadd3 commit a1cf13c

File tree

1 file changed

+27
-40
lines changed

1 file changed

+27
-40
lines changed

README.md

Lines changed: 27 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -17,28 +17,26 @@ For other Cloud providers check: [GCP](https://github.com/sysdiglabs/terraform-g
1717

1818
<br/>
1919

20-
[comment]: <> (## Permissions)
2120

22-
[comment]: <> (Inspect `/module/infrastructure/permissions` subdirectories to understand the several)
23-
24-
[comment]: <> (permissions required.)
25-
26-
[comment]: <> (- `/iam-user` creates an IAM user + adds permissions for required modules &#40;general, cloud-connector, cloud-scanning&#41;<br/><br/>)
27-
28-
[comment]: <> (- `/general` concerns general permissions that apply to both threat-detection and image-scanning features)
29-
30-
[comment]: <> (- `/cloud-connector` for threat-detection features)
31-
32-
[comment]: <> (- `/cloud-scanning` for image-scanning features)
21+
## Usage
3322

34-
[comment]: <> (TODO review `/module/*/ permissions` vs. the ones in permissions folder)
23+
There are several ways to deploy Secure for Cloud in you AWS infrastructure,
24+
- **[`/examples`](https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/tree/master/examples)** for the most common scenarios
25+
- [Single Account on ECS](./examples/single-account-ecs/)
26+
- [Single Account on AppRunner](./examples/single-account-apprunner/)
27+
- [Single-Account with a pre-existing Kubernetes Cluster](./examples/single-account-k8s/)
28+
- [Organizational](./examples/organizational/README.md)
29+
- Many module,examples and use-cases, we provide ways to **re-use existing resources (as optionals)** in your
30+
infrastructure. Check input summary on each example/module.
3531

36-
[comment]: <> (TODO review)
32+
- **[`/use-cases`](https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/tree/master/use-cases)** with self-baked customer-specific alternative scenarios.
33+
<br/>
3734

38-
[comment]: <> (- `/org-role-ecs`)
35+
Find specific overall service arquitecture diagrams attached to each example/use-case.
3936

40-
[comment]: <> (- `/org-role-eks`)
37+
In the long-term our purpose is to evaluate those use-cases and if they're common enough, convert them into examples to make their usage easier.
4138

39+
If you're unsure about what/how to use this module, please fill the [questionnaire](https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/use-cases/_questionnaire.md) report as an issue and let us know your context, we will be happy to help.
4240

4341
### Notice
4442

@@ -48,22 +46,9 @@ For other Cloud providers check: [GCP](https://github.com/sysdiglabs/terraform-g
4846
- **Management Account ECR image scanning** is not support since it's [not a best practies](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_best-practices_mgmt-acct.html#best-practices_mgmt-use) to have an ECR in the management account. However, we have a workaround to [solve this problem](#q-scanning-images-pushed-to-management-account-ecr-are-not-scanned) in case you need to scan images pushed to the management account ECR.
4947
* **Deployment cost** This example will create resources that cost money.<br/>Run `terraform destroy` when you don't need them anymore
5048
* For **free subscription** users, beware that organizational examples may not deploy properly due to the [1 cloud-account limitation](https://docs.sysdig.com/en/docs/administration/administration-settings/subscription/#cloud-billing-free-tier). Open an Issue so we can help you here!
51-
<br/>
52-
53-
54-
## Usage
5549

56-
If you're unsure about what/how to use this module, please fill the [questionnaire](https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/use-cases/_questionnaire.md) report as an issue and let us know your context, we will be happy to help and improve our module.
57-
58-
- There are several ways to deploy this in you AWS infrastructure, gathered under **[`/examples`](./examples)**
59-
- [Single Account on ECS](./examples/single-account-ecs/README.md)
60-
- [Single Account on AppRunner](./examples/single-account-apprunner/README.md)
61-
- [Single-Account with a pre-existing Kubernetes Cluster](./examples/single-account-k8s/README.md)
62-
- [Organizational](./examples/organizational/README.md)
63-
- Many module,examples and use-cases, we provide ways to **re-use existing resources (as optionals)** in your
64-
infrastructure. Check input summary on each example/module.
65-
- Find some real self-baked **use-case scenarios** under [`/use-cases`](./use-cases)
6650

51+
<br/>
6752

6853
## Required Permissions
6954

@@ -124,6 +109,8 @@ ecs:DescribeTaskDefinition
124109
- Check [Organizational Use Case - Role Summary](./examples/organizational/README.md#role-summary) for more details
125110

126111

112+
<br/>
113+
127114
## Confirm the Services are Working
128115

129116
Check official documentation on [Secure for cloud - AWS, Confirm the Services are working](https://docs.sysdig.com/en/docs/installation/sysdig-secure-for-cloud/deploy-sysdig-secure-for-cloud-on-aws/#confirm-the-services-are-working)
@@ -304,21 +291,21 @@ $ curl -v https://<SYSDIG_SECURE_ENDPOINT>/api/cloud/v2/accounts/<AWS_ACCOUNT_ID
304291
## Upgrading
305292

306293
- Uninstall previous deployment resources before upgrading
307-
```
308-
$ terraform destroy
309-
```
294+
```
295+
$ terraform destroy
296+
```
310297

311298
- Upgrade the full terraform example with
312-
313-
```
314-
$ terraform init -upgrade
315-
$ terraform plan
316-
$ terraform apply
317-
```
299+
```
300+
$ terraform init -upgrade
301+
$ terraform plan
302+
$ terraform apply
303+
```
318304

319305
- If required, you can upgrade cloud-connector component by restarting the task (stop task). Because it's not pinned to an specific version, it will download the latest one.
320306

321-
<br/><br/>
307+
<br/>
308+
322309
## Authors
323310

324311
Module is maintained and supported by [Sysdig](https://sysdig.com).

0 commit comments

Comments
 (0)