Improve AWS TF module docs (#44)

* Improve AWS TF module docs Inspired by: #43
* Remove vpc_id flag from all-vpc AWS example
* Fix AWS examples readmes
* Fix GCP resources names

cloud_AWS/terraform/module/README.md

@@ -65,9 +65,9 @@ module "kentik_aws_integration" {
 | iam\_role\_prefix | Prefix to use with IAM roles | `string` | `Kentik` | no |
 | store\_logs\_more\_frequently | Allows to chose how often save logs to s3. Default is once per 10 minutes. When enabled it saves once per minute | `bool` | `false` | no |
 | create\_role | If to create kentik role | `bool` | `true` | no |
-| name | Exported cloud name in Kentik Portal | `string` | `terraform_aws_exported_cloud` | no |
+| name | Cloudexport entry name in Kentik | `string` | `terraform_aws_exported_cloud` | no |
 | enabled | If cloud exported to Kentik is enabled | `bool` | `true` | no |
-| description | Description in Kentik Portal | `string` | `` | no |
+| description | Cloudexport entry description in Kentik | `string` | `` | no |
 | plan\_id | Billing plan ID. | `string` | | no |
 | delete\_after\_read | If to delete after read | `bool` | `false` | no |
 | multiple\_buckets | If to use multiple buckets | `bool` | `false` | no |

cloud_AWS/terraform/module/examples/all-vpc-from-region/README.md

@@ -27,7 +27,6 @@ terraform apply
 Clean up created resources:
 
 ```shell
-aws s3 rm s3://terraform-example-ingest-bucket-flow-logs
 terraform destroy
 ```
 

cloud_AWS/terraform/module/examples/all-vpc-from-region/main.tf

@@ -28,6 +28,7 @@ module "kentik_aws_integration" {
   rw_s3_access               = true
   vpc_id_list                = data.aws_vpcs.all-vpc.ids
   s3_bucket_prefix           = "terraform-example"
+  s3_delete_nonempty_buckets = true
   iam_role_prefix            = "terraform-example"
   store_logs_more_frequently = true
   name                       = "example-aws-terraform-name"

cloud_AWS/terraform/module/examples/no-cloudexport/README.md

@@ -16,14 +16,13 @@ Run the example:
 
 ```shell
 terraform init
-terraform apply
+terraform apply --var vpc_id=<vpc-id>
 ```
 
 Clean up created resources:
 
 ```shell
-aws s3 rm s3://terraform-example-ingest-bucket-flow-logs
-terraform destroy
+terraform destroy --var vpc_id=<vpc-id>
 ```
 
 ## Inputs

cloud_AWS/terraform/module/examples/no-cloudexport/main.tf

@@ -30,6 +30,7 @@ module "kentik_aws_integration" {
   rw_s3_access               = true
   vpc_id_list                = [var.vpc_id]
   s3_bucket_prefix           = "terraform-example"
+  s3_delete_nonempty_buckets = true
   iam_role_prefix            = "terraform-example"
   store_logs_more_frequently = true
 }

cloud_AWS/terraform/module/examples/single-vpc/README.md

@@ -21,14 +21,13 @@ Run the example:
 
 ```shell
 terraform init
-terraform apply
+terraform apply --var vpc_id=<vpc-id>
 ```
 
 Clean up created resources:
 
 ```shell
-aws s3 rm s3://terraform-example-ingest-bucket-flow-logs
-terraform destroy
+terraform destroy --var vpc_id=<vpc-id>
 ```
 
 ## Inputs
@@ -42,4 +41,4 @@ terraform destroy
 | Name | Description |
 |------|-------------|
 | iam\_role\_arn | ARN of created IAM role |
-| bucket\_name\_list | List of all created buckets - exactly one in this case |
+| bucket\_name\_list | List of all created buckets - exactly one in this case |

cloud_AWS/terraform/module/examples/single-vpc/main.tf

@@ -26,6 +26,7 @@ module "kentik_aws_integration" {
   rw_s3_access               = true
   vpc_id_list                = [var.vpc_id]
   s3_bucket_prefix           = "terraform-example"
+  s3_delete_nonempty_buckets = true
   iam_role_prefix            = "terraform-example"
   store_logs_more_frequently = true
   name                       = "example-aws-terraform-name"

cloud_AWS/terraform/module/variables.tf

@@ -58,7 +58,7 @@ variable "create_role" {
 }
 
 variable "name" {
-  description = "Exported cloud name in Kentik Portal"
+  description = "Cloudexport entry name in Kentik"
   type        = string
   default     = "terraform_aws_exported_cloud"
 }
@@ -70,7 +70,7 @@ variable "enabled" {
 }
 
 variable "description" {
-  description = "Description of exported cloud in Kentik Portal"
+  description = "Cloudexport entry description in Kentik"
   type        = string
   default     = ""
 }

cloud_GCP/terraform/module/README.md

@@ -86,15 +86,13 @@ module "kentik_gcp_integration" {
 | topic_prefix | Pub/Sub topic prefix and subscription prefix | `string` | `kentik_topic` | no |
 | sink_prefix | Prefix to use with logs sink | `string` | `kentik_pubsub_sink` | no |
 | project | GCP project name | `string` | | yes |
-| name | Exported cloud name in Kentik Portal | `string` | `terraform_aws_exported_cloud` | no |
+| name | Cloudexport entry name in Kentik | `string` | `terraform_gcp_exported_cloud` | no |
 | enabled | If cloud exported to Kentik is enabled | `bool` | `true` | no |
-| description | Description in Kentik Portal | `string` | `` | no |
+| description | Cloudexport entry description in Kentik | `string` | `` | no |
 | plan\_id | Billing plan ID | `string` | | yes |
 
-
-
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| subscription | Subscribtion name for kentik config |
+| subscription | Subscription name for kentik config |

cloud_GCP/terraform/module/examples/all-network-subnets/README.md

@@ -24,8 +24,8 @@ $ terraform apply
 | region | GCP region to use | `string` |
 | credentials | Credentials json file to log in to GCP | `string` |
 | network | Network name from which subnets should be collected | `list(string)` |
-| name | Exported cloud name in Kentik Portal | `string` |
-| dascription | Exported cloud description in Kentik Portal | `string` |
+| name | Cloudexport entry name in Kentik | `string` |
+| description | Cloudexport entry description in Kentik | `string` |
 | plan\_id | Kentik billing plan ID | `string` |
 
 ## Outputs

cloud_GCP/terraform/module/examples/all-network-subnets/variables.tf

@@ -19,12 +19,13 @@ variable "network" {
 }
 
 variable "name" {
-  description = "Exported cloud name in Kentik Portal"
+  description = "Cloudexport entry name in Kentik"
   type = string
-  default = "terraform_aws_exported_cloud"
+  default = "terraform_gcp_exported_cloud"
 }
 
 variable "description" {
+  description = "Cloudexport entry description in Kentik"
   type = string
   default = ""
 }

cloud_GCP/terraform/module/examples/subnet-list/README.md

@@ -24,8 +24,8 @@ $ terraform apply
 | region | GCP region to use | `string` |
 | credentials | Credentials json file to log in to GCP | `string` |
 | subnet_names | List of subnet names to gather logs | `list(string)` |
-| name | Exported cloud name in Kentik Portal | `string` |
-| dascription | Exported cloud description in Kentik Portal | `string` |
+| name | Cloudexport entry name in Kentik | `string` |
+| description | Cloudexport entry description in Kentik | `string` |
 | plan\_id | Kentik billing plan ID | `string` |
 
 ## Outputs

cloud_GCP/terraform/module/examples/subnet-list/variables.tf

@@ -19,12 +19,13 @@ variable "subnet_names" {
 }
 
 variable "name" {
-  description = "Exported cloud name in Kentik Portal"
+  description = "Cloudexport entry name in Kentik"
   type = string
-  default = "terraform_aws_exported_cloud"
+  default = "terraform_gcp_exported_cloud"
 }
 
 variable "description" {
+  description = "Cloudexport entry description in Kentik"
   type = string
   default = ""
 }

cloud_GCP/terraform/module/variables.tf

@@ -22,9 +22,9 @@ variable "region" {
 }
 
 variable "name" {
-  description = "Exported cloud name in Kentik Portal"
+  description = "Cloudexport entry name in Kentik"
   type = string
-  default = "terraform_aws_exported_cloud"
+  default = "terraform_gcp_exported_cloud"
 }
 
 variable "enabled" {
@@ -34,7 +34,7 @@ variable "enabled" {
 }
 
 variable "description" {
-  description = "Description of exported cloud in Kentik Portal"
+  description = "Cloudexport entry description in Kentik"
   type = string
   default = ""
 }