Skip to content

Commit 97f6468

Browse files
author
iru
authored
Update README.md
1 parent 8a97a71 commit 97f6468

File tree

1 file changed

+46
-39
lines changed

1 file changed

+46
-39
lines changed

‎examples/single-account-k8s/README.md

Lines changed: 46 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,27 @@ Deploy Sysdig Secure for Cloud in a provided existing Kubernetes Cluster.
66
- [Cloud-Connector Chart](https://charts.sysdig.com/charts/cloud-connector/)
77
- [Cloud-Scanning Chart](https://charts.sysdig.com/charts/cloud-scanning/)
88
- Because these charts require specific AWS credentials to be passed by parameter, a new user + access key will be created within account. See [`credentials.tf`](https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/examples/single-account-k8s/credentials.tf)
9-
- Used arquitecture is similar to [single-account](https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/examples/single-account) but changing ECS <---> with an existing EKS
9+
- Used architecture is similar to [single-account](https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/examples/single-account) but changing ECS <---> with an existing EKS
1010

1111
All the required resources and workloads will be run under the same AWS account.
1212

13-
![single-account-k8s diagram](https://raw.githubusercontent.com/sysdiglabs/terraform-aws-secure-for-cloud/master/examples/single-account-k8s/diagram.png)
13+
<img src="https://raw.githubusercontent.com/sysdiglabs/terraform-aws-secure-for-cloud/master/examples/single-account-k8s/diagram.png" alt="single-account-k8s diagram" style="zoom: 50%;" />
1414

1515
## Prerequisites
1616

1717
Minimum requirements:
1818

19-
1. AWS profile credentials configuration
20-
2. A Kubernetes cluster configured within your `~/.kube/config`
21-
3. Secure requirements, as input variable value
22-
```
23-
sysdig_secure_api_token=<SECURE_API_TOKEN>
24-
```
19+
1. **AWS** profile credentials configuration
20+
21+
2. **Kubernetes** cluster configured within your helm provider
22+
23+
3. **Sysdig** Secure requirements, as input variable value
24+
25+
```
26+
sysdig_secure_api_token=<SECURE_API_TOKEN>
27+
```
28+
29+
2530

2631
## Usage
2732

@@ -30,12 +35,11 @@ For quick testing, use this snippet on your terraform files
3035
```terraform
3136
provider "aws" {
3237
region = var.region
38+
...
3339
}
3440
3541
provider "helm" {
36-
kubernetes {
37-
config_path = "~/.kube/config"
38-
}
42+
...
3943
}
4044
4145
module "secure_for_cloud_aws_single_account" {
@@ -48,64 +52,67 @@ module "secure_for_cloud_aws_single_account" {
4852
See [inputs summary](#inputs) or module module [`variables.tf`](https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/examples/single-account-k8s/variables.tf) file for more optional configuration.
4953

5054
To run this example you need have your [aws account profile configured in CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) and to execute:
55+
5156
```terraform
5257
$ terraform init
5358
$ terraform plan
5459
$ terraform apply
5560
```
5661

5762
Notice that:
63+
5864
* This example will create resources that cost money.<br/>Run `terraform destroy` when you don't need them anymore
5965
* All created resources will be created within the tags `product:sysdig-secure-for-cloud`, within the resource-group `sysdig-secure-for-cloud`
6066

6167
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
68+
6269
## Requirements
6370

64-
| Name | Version |
65-
|------|---------|
71+
| Name | Version |
72+
| ------------------------------------------------------------ | --------- |
6673
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.15.0 |
67-
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.50.0 |
68-
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >=2.3.0 |
74+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.50.0 |
75+
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >=2.3.0 |
6976
| <a name="requirement_sysdig"></a> [sysdig](#requirement\_sysdig) | >= 0.5.19 |
7077

7178
## Providers
7279

73-
| Name | Version |
74-
|------|---------|
80+
| Name | Version |
81+
| ---------------------------------------------------- | ------- |
7582
| <a name="provider_helm"></a> [helm](#provider\_helm) | >=2.3.0 |
7683

7784
## Modules
7885

79-
| Name | Source | Version |
80-
|------|--------|---------|
81-
| <a name="module_cloud_connector_sqs"></a> [cloud\_connector\_sqs](#module\_cloud\_connector\_sqs) | ../../modules/infrastructure/sqs-sns-subscription | |
82-
| <a name="module_cloud_scanning_sqs"></a> [cloud\_scanning\_sqs](#module\_cloud\_scanning\_sqs) | ../../modules/infrastructure/sqs-sns-subscription | |
83-
| <a name="module_cloudtrail"></a> [cloudtrail](#module\_cloudtrail) | ../../modules/infrastructure/cloudtrail | |
84-
| <a name="module_codebuild"></a> [codebuild](#module\_codebuild) | ../../modules/infrastructure/codebuild | |
85-
| <a name="module_iam_user"></a> [iam\_user](#module\_iam\_user) | ../../modules/infrastructure/permissions/iam-user | |
86-
| <a name="module_resource_group"></a> [resource\_group](#module\_resource\_group) | ../../modules/infrastructure/resource-group | |
87-
| <a name="module_ssm"></a> [ssm](#module\_ssm) | ../../modules/infrastructure/ssm | |
86+
| Name | Source | Version |
87+
| ------------------------------------------------------------ | ------------------------------------------------- | ------- |
88+
| <a name="module_cloud_connector_sqs"></a> [cloud\_connector\_sqs](#module\_cloud\_connector\_sqs) | ../../modules/infrastructure/sqs-sns-subscription | |
89+
| <a name="module_cloud_scanning_sqs"></a> [cloud\_scanning\_sqs](#module\_cloud\_scanning\_sqs) | ../../modules/infrastructure/sqs-sns-subscription | |
90+
| <a name="module_cloudtrail"></a> [cloudtrail](#module\_cloudtrail) | ../../modules/infrastructure/cloudtrail | |
91+
| <a name="module_codebuild"></a> [codebuild](#module\_codebuild) | ../../modules/infrastructure/codebuild | |
92+
| <a name="module_iam_user"></a> [iam\_user](#module\_iam\_user) | ../../modules/infrastructure/permissions/iam-user | |
93+
| <a name="module_resource_group"></a> [resource\_group](#module\_resource\_group) | ../../modules/infrastructure/resource-group | |
94+
| <a name="module_ssm"></a> [ssm](#module\_ssm) | ../../modules/infrastructure/ssm | |
8895

8996
## Resources
9097

91-
| Name | Type |
92-
|------|------|
98+
| Name | Type |
99+
| ------------------------------------------------------------ | -------- |
93100
| [helm_release.cloud_connector](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |
94101
| [helm_release.cloud_scanning](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |
95102

96103
## Inputs
97104

98-
| Name | Description | Type | Default | Required |
99-
|------|-------------|------|---------|:--------:|
100-
| <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 |
101-
| <a name="input_cloudtrail_is_multi_region_trail"></a> [cloudtrail\_is\_multi\_region\_trail](#input\_cloudtrail\_is\_multi\_region\_trail) | true/false whether cloudtrail will ingest multiregional events. testing/economization purpose. | `bool` | `true` | no |
102-
| <a name="input_cloudtrail_kms_enable"></a> [cloudtrail\_kms\_enable](#input\_cloudtrail\_kms\_enable) | true/false whether s3 should be encrypted. testing/economization purpose. | `bool` | `true` | no |
103-
| <a name="input_enable_cloud_connector"></a> [enable\_cloud\_connector](#input\_enable\_cloud\_connector) | true/false whether to provision cloud\_connector permissions | `bool` | `true` | no |
104-
| <a name="input_enable_cloud_scanning"></a> [enable\_cloud\_scanning](#input\_enable\_cloud\_scanning) | true/false whether to provision cloud\_scanning permissions | `bool` | `true` | no |
105-
| <a name="input_name"></a> [name](#input\_name) | Name to be assigned to all child resources. A suffix may be added internally when required. Use default value unless you need to install multiple instances | `string` | `"sfc"` | no |
106-
| <a name="input_region"></a> [region](#input\_region) | Default region for resource creation | `string` | `"eu-central-1"` | no |
107-
| <a name="input_sysdig_secure_endpoint"></a> [sysdig\_secure\_endpoint](#input\_sysdig\_secure\_endpoint) | Sysdig Secure API endpoint | `string` | `"https://secure.sysdig.com"` | no |
108-
| <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 |
105+
| Name | Description | Type | Default | Required |
106+
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------- | ----------------------------------------------------------- | :------: |
107+
| <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 |
108+
| <a name="input_cloudtrail_is_multi_region_trail"></a> [cloudtrail\_is\_multi\_region\_trail](#input\_cloudtrail\_is\_multi\_region\_trail) | true/false whether cloudtrail will ingest multiregional events. testing/economization purpose. | `bool` | `true` | no |
109+
| <a name="input_cloudtrail_kms_enable"></a> [cloudtrail\_kms\_enable](#input\_cloudtrail\_kms\_enable) | true/false whether s3 should be encrypted. testing/economization purpose. | `bool` | `true` | no |
110+
| <a name="input_enable_cloud_connector"></a> [enable\_cloud\_connector](#input\_enable\_cloud\_connector) | true/false whether to provision cloud\_connector permissions | `bool` | `true` | no |
111+
| <a name="input_enable_cloud_scanning"></a> [enable\_cloud\_scanning](#input\_enable\_cloud\_scanning) | true/false whether to provision cloud\_scanning permissions | `bool` | `true` | no |
112+
| <a name="input_name"></a> [name](#input\_name) | Name to be assigned to all child resources. A suffix may be added internally when required. Use default value unless you need to install multiple instances | `string` | `"sfc"` | no |
113+
| <a name="input_region"></a> [region](#input\_region) | Default region for resource creation | `string` | `"eu-central-1"` | no |
114+
| <a name="input_sysdig_secure_endpoint"></a> [sysdig\_secure\_endpoint](#input\_sysdig\_secure\_endpoint) | Sysdig Secure API endpoint | `string` | `"https://secure.sysdig.com"` | no |
115+
| <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 |
109116

110117
## Outputs
111118

0 commit comments

Comments
 (0)