Skip to content

Commit 76f841f

Browse files
author
iru
authored
docs: organize readme and fix registry links
1 parent af53a91 commit 76f841f

File tree

1 file changed

+33
-24
lines changed

1 file changed

+33
-24
lines changed

README.md

Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,35 @@ Provides unified threat-detection, compliance, forensics and analysis through th
1414

1515
For other Cloud providers check: [AWS](https://github.com/sysdiglabs/terraform-aws-secure-for-cloud), [Azure](https://github.com/sysdiglabs/terraform-azurerm-secure-for-cloud)
1616

17+
<br/>
18+
19+
## Usage
20+
21+
There are several ways to deploy Secure for Cloud in you GCP infrastructure,
22+
23+
- **[`/examples`](https://github.com/sysdiglabs/terraform-google-secure-for-cloud/tree/master/examples)** for the most common scenarios
24+
- [Single Project](https://github.com/sysdiglabs/terraform-google-secure-for-cloud/tree/master/examples/single-project/)
25+
- [Single Project with a pre-existing Kubernetes Cluster](https://github.com/sysdiglabs/terraform-google-secure-for-cloud/tree/master/examples/single-project-k8s/README.md)
26+
- [Organizational](https://github.com/sysdiglabs/terraform-google-secure-for-cloud/tree/master/examples/organization/README.md)
27+
- Many module,examples and use-cases, we provide ways to **re-use existing resources (as optionals)** in your
28+
infrastructure. Check input summary on each example/module.
29+
- **[`/use-cases`](https://github.com/sysdiglabs/terraform-google-secure-for-cloud/tree/master/use-cases)** with self-baked customer-specific alternative scenarios.
30+
31+
Find specific overall service arquitecture diagrams attached to each example/use-case.
32+
33+
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.
34+
35+
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.
36+
1737

1838
## Notice
1939
* [GCP regions](https://cloud.google.com/compute/docs/regions-zones/#available)
2040
* Do not confuse required `region` with GCP location or zone. [Identifying a region or zone](https://cloud.google.com/compute/docs/regions-zones/#identifying_a_region_or_zone)
2141
* All Sysdig Secure for Cloud features but [Image Scanning](https://docs.sysdig.com/en/docs/sysdig-secure/scanning/) are enabled by default. You can enable it through `deploy_scanning` input variable parameter of each example.<br/>
2242
* This example will create resources that **cost money**. Run `terraform destroy` when you don't need them anymore.
2343
* 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!
44+
45+
2446
<br/>
2547

2648
## Prerequisites
@@ -67,19 +89,7 @@ Besides, the following GCP **APIs must be enabled** ([how do I check it?](#q-how
6789
* [Cloud Asset API](https://console.cloud.google.com/marketplace/product/google/cloudasset.googleapis.com)
6890

6991

70-
## Usage
71-
72-
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.
73-
74-
- There are several ways to deploy this in you AWS infrastructure, gathered under **[`/examples`](./examples)**
75-
- [Single Project](./examples/single-project/README.md)
76-
- [Single Project with a pre-existing Kubernetes Cluster](./examples/single-project-k8s/README.md)
77-
- [Organizational](./examples/organization/README.md)
78-
- Many module,examples and use-cases, we provide ways to **re-use existing resources (as optionals)** in your
79-
infrastructure. Check input summary on each example/module.
80-
- Find some real self-baked **use-case scenarios** under [`/use-cases`](./use-cases)
81-
82-
92+
<br/>
8393

8494
## Confirm the Services are Working
8595

@@ -115,7 +125,7 @@ It may take some time, but you should see logs detecting the new image in the `c
115125
116126
And a CloudBuild being launched successfully.
117127
118-
128+
<br/>
119129
120130
## Troubleshooting
121131
@@ -226,21 +236,20 @@ A: Verify that `gcr` topic exists. If `create_gcr_topic` is set to false and `gc
226236
## Upgrading
227237
228238
- Uninstall previous deployment resources before upgrading
229-
```
230-
$ terraform destroy
231-
```
239+
```
240+
$ terraform destroy
241+
```
232242
233243
- Upgrade the full terraform example with
234-
235-
```
236-
$ terraform init -upgrade
237-
$ terraform plan
238-
$ terraform apply
239-
```
244+
```
245+
$ terraform init -upgrade
246+
$ terraform plan
247+
$ terraform apply
248+
```
240249
241250
- 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.
242251
243-
<br/><br/>
252+
<br/>
244253
245254
## Authors
246255

0 commit comments

Comments
 (0)