diff --git a/README.md b/README.md index 8120fffc8..57644e9e1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,17 @@ # Cloud Foundation Toolkit - Fabric -The Cloud Foundation Fabric provides end-to-end Terraform code examples for prototyping on GCP. -Code from this repository can be used as the basis for rapid prototyping of networking and organizational design, -and to lay the automated foundations for adopting additional CFT modules. +Cloud Foundation Fabric provides end-to-end Terraform code examples on GCP, which are meant for prototyping and as minimal samples to aid in designing real-world infrastructures. As such, these samples are meant to be adapted and updated for your different use cases, and often do not implement GCP security best practices for production use. -The Fabric repository is designed to be adapted and updated for your use cases. -For full-featured support out of the box, alternative Cloud Foundation Toolkit modules should be considered or integrated. +All the examples leverage composition, combining different Cloud Foundation Toolkit modules to realize an integrated design. Additional modules can be combined in to tailor the examples to specific needs, and to implement additional best practices. You can check the [full list of Cloud Foundation Toolkit modules here](https://github.com/terraform-google-modules). + +The examples are organized into two main sections: GCP foundational design, and infrastructure design + +## Foundational examples + +Foundational examples deal with organization-level management of GCP resources, and take care of folder hierarchy, initial automation requirements (service accounts, GCS buckets), and high level best practices like audit log exports and organization policies. + +They are simplified versions of real-life use cases, and put a particular emphasis on separation of duties at the environment or tenant level, and decoupling high level permissions from the day to day running of infrastructure automation. More details and the actual examples are available in the [foundations folder](foundations). + +## Infrastructure examples + +Infrastructure examples showcase typical networking configurations on GCP, and are meant to illustrate how to automate them with Terraform, and to offer an easy way of testing different scenarios. Like the foundational examples, they are simplified versions of real-life use cases. More details and the actual examples are available in the [infrastructure folder](infrastructure). diff --git a/infrastructure/README.md b/infrastructure/README.md index e69de29bb..e393e1108 100644 --- a/infrastructure/README.md +++ b/infrastructure/README.md @@ -0,0 +1,3 @@ +# Infrastructure samples + +These examples showcase typical networking configurations on GCP derived from real-world use cases, and are meant to illustrate how to automate them with Terraform, and to offer an easy way of testing different scenarios. We have a long list of examples we plan on adding, so check back here often. \ No newline at end of file diff --git a/infrastructure/shared-vpc/README.md b/infrastructure/shared-vpc/README.md index d634f636a..75ef68fde 100644 --- a/infrastructure/shared-vpc/README.md +++ b/infrastructure/shared-vpc/README.md @@ -54,12 +54,11 @@ There's a minor glitch that can surface running `terraform destroy`, with a simp | Name | Description | |------|-------------| +| host\_project\_id | VPC host project id. | | mysql-root-password | Password for the test MySQL db root user. | -| net-vpc-name | Shared VPC name | -| net-vpc-subnets | Shared VPC subnets. | -| project-gce | GCE service project. | -| project-gke | GKE service project. | -| project-host | VPC host project. | +| service\_project\_ids | Service project ids. | | test-instances | Test instance names. | +| vpc\_name | Shared VPC name | +| vpc\_subnets | Shared VPC subnets. |