Skip to content

Commit 0f48ab6

Browse files
author
iru
committed
chore(doc): remove main module tf-docs. deprecated
1 parent 66d5bf2 commit 0f48ab6

File tree

1 file changed

+0
-53
lines changed

1 file changed

+0
-53
lines changed

README.md

Lines changed: 0 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -64,59 +64,6 @@ Notice that:
6464
* All created resources will be created within the tags `product:sysdig-secure-for-cloud`, within the resource-group `sysdig-secure-for-cloud`
6565

6666

67-
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
68-
## Requirements
69-
70-
| Name | Version |
71-
|------|---------|
72-
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.15.0 |
73-
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.50.0 |
74-
| <a name="requirement_sysdig"></a> [sysdig](#requirement\_sysdig) | >= 0.5.17 |
75-
76-
## Providers
77-
78-
| Name | Version |
79-
|------|---------|
80-
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.50.0 |
81-
82-
## Modules
83-
84-
| Name | Source | Version |
85-
|------|--------|---------|
86-
| <a name="module_cloud_bench"></a> [cloud\_bench](#module\_cloud\_bench) | ./modules/services/cloud-bench | |
87-
| <a name="module_cloud_connector"></a> [cloud\_connector](#module\_cloud\_connector) | ./modules/services/cloud-connector | |
88-
| <a name="module_cloudtrail"></a> [cloudtrail](#module\_cloudtrail) | ./modules/infrastructure/cloudtrail | |
89-
| <a name="module_ecs_fargate_cluster"></a> [ecs\_fargate\_cluster](#module\_ecs\_fargate\_cluster) | ./modules/infrastructure/ecs-fargate-cluster | |
90-
| <a name="module_resource_group_master"></a> [resource\_group\_master](#module\_resource\_group\_master) | ./modules/infrastructure/resource-group | |
91-
| <a name="module_ssm"></a> [ssm](#module\_ssm) | ./modules/infrastructure/ssm | |
92-
93-
## Resources
94-
95-
| Name | Type |
96-
|------|------|
97-
| [aws_caller_identity.me](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
98-
99-
## Inputs
100-
101-
| Name | Description | Type | Default | Required |
102-
|------|-------------|------|---------|:--------:|
103-
| <a name="input_sysdig_secure_api_token"></a> [sysdig\_secure\_api\_token](#input\_sysdig\_secure\_api\_token) | Sysdig Secure API token | `string` | n/a | yes |
104-
| <a name="input_cloudtrail_is_multi_region_trail"></a> [cloudtrail\_is\_multi\_region\_trail](#input\_cloudtrail\_is\_multi\_region\_trail) | testing/economization purpose. true/false whether cloudtrail will ingest multiregional events | `bool` | `true` | no |
105-
| <a name="input_cloudtrail_kms_enable"></a> [cloudtrail\_kms\_enable](#input\_cloudtrail\_kms\_enable) | testing/economization purpose. true/false whether s3 should be encrypted | `bool` | `true` | no |
106-
| <a name="input_is_organizational"></a> [is\_organizational](#input\_is\_organizational) | whether secure-for-cloud should be deployed in an organizational setup | `bool` | `false` | no |
107-
| <a name="input_name"></a> [name](#input\_name) | Name for the Cloud Vision deployment | `string` | `"sysdig-secure-for-cloud"` | no |
108-
| <a name="input_organizational_config"></a> [organizational\_config](#input\_organizational\_config) | organizational\_config. following attributes must be given<br><ul><li>`sysdig_secure_for_cloud_member_account_id` to enable reading permission,</li><li>`sysdig_secure_for_cloud_role_arn` for cloud-connector assumeRole in order to read cloudtrail s3 events</li><li>and the `connector_ecs_task_role_name` which has been granted trusted-relationship over the secure-for-cloud\_role</li></ul> | <pre>object({<br> sysdig_secure_for_cloud_member_account_id = string<br> sysdig_secure_for_cloud_role_arn = string<br> connector_ecs_task_role_name = string<br> })</pre> | <pre>{<br> "sysdig_secure_for_cloud_member_account_id": null,<br> "sysdig_secure_for_cloud_role_arn": null,<br> "connector_ecs_task_role_name": null<br>}</pre> | no |
109-
| <a name="input_sysdig_secure_endpoint"></a> [sysdig\_secure\_endpoint](#input\_sysdig\_secure\_endpoint) | Sysdig Secure API endpoint | `string` | `"https://secure.sysdig.com"` | no |
110-
| <a name="input_tags"></a> [tags](#input\_tags) | sysdig secure-for-cloud tags | `map(string)` | <pre>{<br> "product": "sysdig-secure-for-cloud"<br>}</pre> | no |
111-
112-
## Outputs
113-
114-
| Name | Description |
115-
|------|-------------|
116-
| <a name="output_cloudtrail_s3_arn"></a> [cloudtrail\_s3\_arn](#output\_cloudtrail\_s3\_arn) | sydig-secure-for-cloud cloudtrail s3 arn, required for organizational use case, in order to give proper permissions to cloudconnector role to assume |
117-
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
118-
119-
12067
## Troubleshooting
12168

12269
- Q: How to **validate secure-for-cloud cloud-connector (thread-detection) provisioning** is working as expected?<br/>

0 commit comments

Comments
 (0)