Skip to content

Commit 944c506

Browse files
author
iru
committed
chore(doc): readme cleanup
1 parent 0259a75 commit 944c506

File tree

3 files changed

+38
-41
lines changed

3 files changed

+38
-41
lines changed

‎README.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,36 @@
11
# Sysdig Secure for Cloud in AWS
22

3-
Terraform module that deploys the **Sysdig Secure for Cloud** stack in **AWS**. It provides unified threat detection, compliance, forensics and analysis.
3+
Terraform module that deploys the **Sysdig Secure for Cloud** stack in **AWS**.
4+
<br/>It provides unified threat detection, compliance, forensics and analysis.
45

5-
There are three major component:
6+
There are three major components:
67

7-
* **Cloud Threat Detection**: Tracks abnormal and suspicious activities in your cloud environment based on Falco language. Managed through cloud-connector.
8-
* **CSPM/Compliance**: It evaluates periodically your cloud configuration, using Cloud Custodian, against some benchmarks and returns the results and remediation you need to fix. Managed through cloud-bench.
9-
* **Cloud Scanning**: Automatically scans all container images pushed to the registry or as soon a new task which involves a container is spawned in your account. Managed through cloud-scanning.
8+
* **Cloud Threat Detection**: Tracks abnormal and suspicious activities in your cloud environment based on Falco language.<br/>Managed through cloud-connector.<br/><br/>
9+
* **CSPM/Compliance**: It evaluates periodically your cloud configuration, using Cloud Custodian, against some benchmarks and returns the results and remediation you need to fix.<br/>Managed through cloud-bench.<br/><br/>
10+
* **Cloud Scanning**: Automatically scans all container images pushed to the registry or as soon a new task which involves a container is spawned in your account.<br/>Managed through cloud-scanning.<br/><br/>
1011

11-
For other Cloud providers check:
12-
13-
* [GCP](https://github.com/sysdiglabs/terraform-google-cloudvision)
14-
* [Azure](https://github.com/sysdiglabs/terraform-azurerm-cloudvision)
12+
For other Cloud providers check: [GCP](https://github.com/sysdiglabs/terraform-google-cloudvision), [Azure](https://github.com/sysdiglabs/terraform-azurerm-cloudvision)
1513

1614
---
1715

1816
## Usage
1917

2018
There are several ways to deploy this in you AWS infrastructure:
2119

22-
### Single-Account
20+
### · Single-Account
21+
Sysdig workload will be deployed in the same account where user's resources will be watched.<br/>
22+
More info in [`./examples/single-account`](https://github.com/sysdiglabs/terraform-aws-cloudvision/tree/master/examples/single-account)
2323

24-
More info in the [`./examples/single-account/README.md`](https://github.com/sysdiglabs/terraform-aws-cloudvision/tree/master/examples/single-account/README.md)
24+
![single-account diagram](https://raw.githubusercontent.com/sysdiglabs/terraform-aws-cloudvision/07264a75926de2012512f4d67ee303aa964193ae/examples/single-account/diagram-single.png)
2525

26-
### Organizational
26+
### · Organizational
2727

2828
Using an organizational configuration Cloudtrail.
29-
More info in the [`./examples/organizational/README.md`](https://github.com/sysdiglabs/terraform-aws-cloudvision/tree/master/examples/organizational/README.md)
29+
More info in [`./examples/organizational`](https://github.com/sysdiglabs/terraform-aws-cloudvision/tree/master/examples/organizational)
30+
31+
![organizational diagram](https://raw.githubusercontent.com/sysdiglabs/terraform-aws-cloudvision/07264a75926de2012512f4d67ee303aa964193ae/examples/organizational/diagram-org.png)
3032

31-
### Self-Baked
33+
### · Self-Baked
3234

3335
If no [examples](https://github.com/sysdiglabs/terraform-aws-cloudvision/tree/master/examples) fit your use-case, be free to self-configure your own `cloudvision` module.
3436

@@ -44,7 +46,7 @@ module "cloudvision_aws" {
4446
}
4547
4648
```
47-
See main module [`variables.tf`](https://github.com/sysdiglabs/terraform-aws-cloudvision/tree/master/variables.tf) or [inputs summary](#inputs) file for more optional configuration.
49+
See [inputs summary](#inputs) or main [module `variables.tf`](https://github.com/sysdiglabs/terraform-aws-cloudvision/tree/master/variables.tf) file for more optional configuration.
4850

4951
To run this example you need have your [aws master-account profile configured in CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) and to execute:
5052
```terraform
@@ -54,9 +56,8 @@ $ terraform apply
5456
```
5557

5658
Notice that:
57-
- This example will create resources that cost money. Run `terraform destroy` when you don't need them anymore
58-
- For more detailed configuration inspect both main module and example input variables
59-
- All created resources will be created within the tags `product:sysdig-cloudvision`, within the resource-group `sysdig-cloudvision`
59+
* This example will create resources that cost money.<br/>Run `terraform destroy` when you don't need them anymore
60+
* All created resources will be created within the tags `product:sysdig-cloudvision`, within the resource-group `sysdig-cloudvision`
6061

6162
---
6263

‎examples/organizational/README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
# Sysdig Secure for Cloud in AWS: Shared Organizational Trail
22

3-
Deploy Sysdig Secure for Cloud sharing the Trail within an organization. The module will deploy an organizational
4-
CloudTrail and workload will be run in a member account.
3+
Deploy Sysdig Secure for Cloud sharing the Trail within an organization.
4+
* In the **master account**
5+
* An Organizational Cloutrail will be deployed
6+
* When an account becomes part of an organization, AWS will create an `OrganizationAccountAccessRole` [for account management](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html), which Sysdig Secure for Cloud will use for member-account provisioning.
7+
<br/>This Role is hardcoded ATM
8+
* In the **user-provided member account**:
9+
* An additional role `SysdigCloudvisionRole` will be created within the master account, to be able to read cloudtrail-s3 bucket events
10+
* All the Sysdig Secure for Cloud service-related resources will be created
511

6-
When an account becomes part of an organization, AWS will create an `OrganizationAccountAccessRole` [for account management](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html), which cloudvision module will use for member-account provisioning
7-
8-
In the member account:
9-
* An additional role `SysdigCloudvisionRole` will be created within the master account, to be able to read s3 bucket events
10-
* All the cloudvision service-related resources will be created
11-
12-
![organizational diagram](https://raw.githubusercontent.com/sysdiglabs/terraform-aws-cloudvision/master/examples/organizational/diagram-org.png)
12+
![organizational diagram](https://raw.githubusercontent.com/sysdiglabs/terraform-aws-cloudvision/07264a75926de2012512f4d67ee303aa964193ae/examples/organizational/diagram-org.png)
1313

1414
## Prerequisites
1515

1616
Minimum requirements:
1717

1818
1. Have an existing AWS account as the organization master account
19-
* Organizational cloudTrail service must be enabled
19+
* Organizational CloudTrail service must be enabled
2020
1. AWS profile credentials configuration of the `master` account of the organization
2121
* This account credentials must be [able to manage cloudtrail creation](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-trail-organization.html)
2222
> You must be logged in with the management account for the organization to create an organization trail. You must also have sufficient permissions for the IAM user or role in the management account to successfully create an organization trail.
@@ -42,7 +42,7 @@ module "cloudvision_aws_organizational" {
4242
}
4343
```
4444

45-
See main module [`variables.tf`](https://github.com/sysdiglabs/terraform-aws-cloudvision/blob/master/examples/organizational/variables.tf) or [inputs summary](#inputs) file for more optional configuration.
45+
See [inputs summary](#inputs) or module [`variables.tf`](https://github.com/sysdiglabs/terraform-aws-cloudvision/blob/master/examples/organizational/variables.tf) file for more optional configuration.
4646

4747
To run this example you need have your [aws master-account profile configured in CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) and to execute:
4848
```terraform
@@ -51,11 +51,9 @@ $ terraform plan
5151
$ terraform apply
5252
```
5353

54-
Note that:
55-
- This example will create resources that cost money. Run `terraform destroy` when you don't need them anymore
56-
- For more detailed configuration inspect both main module and example input variables
57-
- All created resources will be created within the tags `product:sysdig-cloudvision`, within the resource-group `sysdig-cloudvision`
58-
54+
Notice that:
55+
* This example will create resources that cost money.<br/>Run `terraform destroy` when you don't need them anymore
56+
* All created resources will be created within the tags `product:sysdig-cloudvision`, within the resource-group `sysdig-cloudvision`
5957

6058
---
6159

‎examples/single-account/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Deploy Sysdig Secure for Cloud in a single AWS account. All the required resources and workloads will be run
44
under the same AWS account.
55

6-
![organizational diagram](https://raw.githubusercontent.com/sysdiglabs/terraform-aws-cloudvision/master/examples/single-account/diagram-single.png)
6+
![single-account diagram](https://raw.githubusercontent.com/sysdiglabs/terraform-aws-cloudvision/07264a75926de2012512f4d67ee303aa964193ae/examples/single-account/diagram-single.png)
77

88
## Prerequisites
99

@@ -27,7 +27,7 @@ module "cloudvision_aws_single_account" {
2727
}
2828
```
2929

30-
See main module [`variables.tf`](https://github.com/sysdiglabs/terraform-aws-cloudvision/blob/master/examples/single-account/variables.tf) or [inputs summary](#inputs) file for more optional configuration.
30+
See [inputs summary](#inputs) or module module [`variables.tf`](https://github.com/sysdiglabs/terraform-aws-cloudvision/blob/master/examples/single-account/variables.tf) file for more optional configuration.
3131

3232
To run this example you need have your [aws master-account profile configured in CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) and to execute:
3333
```terraform
@@ -36,11 +36,9 @@ $ terraform plan
3636
$ terraform apply
3737
```
3838

39-
Note that:
40-
- This example will create resources that cost money. Run `terraform destroy` when you don't need them anymore
41-
- For more detailed configuration inspect both main module and example input variables
42-
- All created resources will be created within the tags `product:sysdig-cloudvision`, within the resource-group `sysdig-cloudvision`
43-
39+
Notice that:
40+
* This example will create resources that cost money.<br/>Run `terraform destroy` when you don't need them anymore
41+
* All created resources will be created within the tags `product:sysdig-cloudvision`, within the resource-group `sysdig-cloudvision`
4442
---
4543

4644

0 commit comments

Comments
 (0)