Merge pull request #201 from chrislovecnm/readme-fix

README updates

Author: morgante

README.md

@@ -6,7 +6,9 @@ The resources/services/activations/deletions that this module will create/trigge
 - Create GKE Node Pool(s) with provided configuration and attach to cluster
 - Replace the default kube-dns configmap if `stub_domains` are provided
 - Activate network policy if `network_policy` is true
-- Add `ip-masq-agent` configmap with provided `non_masquerade_cidrs` if `network_policy` is true
+- Add `ip-masq-agent` configmap with provided `non_masquerade_cidrs` if `configure_ip_masq` is true
+
+Sub modules are provided from creating private clusters, beta private clusters, and beta public clusters as well.  Beta sub modules allow for the use of various GKE beta features. See the modules directory for the various sub modules.
 
 
 ## Compatibility
@@ -98,6 +100,7 @@ module "gke" {
 }
 ```
 
+<!-- do not understand what this is about -->
 Then perform the following commands on the root folder:
 
 - `terraform init` to get the plugins
@@ -234,14 +237,15 @@ In order to operate with the Service Account you must activate the following API
 The project has the following folders and files:
 
 - /: root folder
-- /examples: examples for using this module
-- /helpers: Helper scripts
-- /scripts: Scripts for specific tasks on module (see Infrastructure section on this file)
-- /test: Folders with files for testing the module (see Testing section on this file)
-- /main.tf: main file for this module, contains all the resources to create
-- /variables.tf: all the variables for the module
-- /output.tf: the outputs of the module
-- /readme.MD: this file
+- /examples: Examples for using this module and sub module.
+- /helpers: Helper scripts.
+- /scripts: Scripts for specific tasks on module (see Infrastructure section on this file).
+- /test: Folders with files for testing the module (see Testing section on this file).
+- /main.tf: `main` file for the public module, contains all the resources to create.
+- /variables.tf: Variables for the public cluster module.
+- /output.tf: The outputs for the public cluster module.
+- /README.MD: This file.
+- /modules: Private and beta sub modules.
 
 ## Templating
 

autogen/README.md

@@ -1,13 +1,15 @@
 # Terraform Kubernetes Engine Module
 
-This module handles opinionated Google Cloud Platform Kubernetes Engine cluster creation and configuration with Node Pools, IP MASQ, Network Policy, etc.{% if private_cluster %} This particular submodule creates a [private cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters){% endif %}{% if beta_cluster %}Beta features are enabled on this submodule.{% endif %}
+This module handles opinionated Google Cloud Platform Kubernetes Engine cluster creation and configuration with Node Pools, IP MASQ, Network Policy, etc.{% if private_cluster %} This particular submodule creates a [private cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters){% endif %}{% if beta_cluster %}Beta features are enabled in this submodule.{% endif %}
 
 The resources/services/activations/deletions that this module will create/trigger are:
 - Create a GKE cluster with the provided addons
 - Create GKE Node Pool(s) with provided configuration and attach to cluster
 - Replace the default kube-dns configmap if `stub_domains` are provided
 - Activate network policy if `network_policy` is true
-- Add `ip-masq-agent` configmap with provided `non_masquerade_cidrs` if `network_policy` is true
+- Add `ip-masq-agent` configmap with provided `non_masquerade_cidrs` if `configure_ip_masq` is true
+
+Sub modules are provided from creating private clusters, beta private clusters, and beta public clusters as well.  Beta sub modules allow for the use of various GKE beta features. See the modules directory for the various sub modules.
 
 {% if private_cluster %}
 **Note**: You must run Terraform from a VM on the same VPC as your cluster, otherwise there will be issues connecting to the GKE master.
@@ -112,6 +114,7 @@ module "gke" {
 }
 ```
 
+<!-- do not understand what this is about -->
 Then perform the following commands on the root folder:
 
 - `terraform init` to get the plugins
@@ -180,14 +183,15 @@ In order to operate with the Service Account you must activate the following API
 The project has the following folders and files:
 
 - /: root folder
-- /examples: examples for using this module
-- /helpers: Helper scripts
-- /scripts: Scripts for specific tasks on module (see Infrastructure section on this file)
-- /test: Folders with files for testing the module (see Testing section on this file)
-- /main.tf: main file for this module, contains all the resources to create
-- /variables.tf: all the variables for the module
-- /output.tf: the outputs of the module
-- /readme.MD: this file
+- /examples: Examples for using this module and sub module.
+- /helpers: Helper scripts.
+- /scripts: Scripts for specific tasks on module (see Infrastructure section on this file).
+- /test: Folders with files for testing the module (see Testing section on this file).
+- /main.tf: `main` file for the public module, contains all the resources to create.
+- /variables.tf: Variables for the public cluster module.
+- /output.tf: The outputs for the public cluster module.
+- /README.MD: This file.
+- /modules: Private and beta sub modules.
 
 ## Templating
 

modules/beta-private-cluster/README.md

@@ -1,12 +1,14 @@
 # Terraform Kubernetes Engine Module
 
-This module handles opinionated Google Cloud Platform Kubernetes Engine cluster creation and configuration with Node Pools, IP MASQ, Network Policy, etc. This particular submodule creates a [private cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters)Beta features are enabled on this submodule.
+This module handles opinionated Google Cloud Platform Kubernetes Engine cluster creation and configuration with Node Pools, IP MASQ, Network Policy, etc. This particular submodule creates a [private cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters)Beta features are enabled in this submodule.
 The resources/services/activations/deletions that this module will create/trigger are:
 - Create a GKE cluster with the provided addons
 - Create GKE Node Pool(s) with provided configuration and attach to cluster
 - Replace the default kube-dns configmap if `stub_domains` are provided
 - Activate network policy if `network_policy` is true
-- Add `ip-masq-agent` configmap with provided `non_masquerade_cidrs` if `network_policy` is true
+- Add `ip-masq-agent` configmap with provided `non_masquerade_cidrs` if `configure_ip_masq` is true
+
+Sub modules are provided from creating private clusters, beta private clusters, and beta public clusters as well.  Beta sub modules allow for the use of various GKE beta features. See the modules directory for the various sub modules.
 
 **Note**: You must run Terraform from a VM on the same VPC as your cluster, otherwise there will be issues connecting to the GKE master.
 
@@ -105,6 +107,7 @@ module "gke" {
 }
 ```
 
+<!-- do not understand what this is about -->
 Then perform the following commands on the root folder:
 
 - `terraform init` to get the plugins
@@ -258,14 +261,15 @@ In order to operate with the Service Account you must activate the following API
 The project has the following folders and files:
 
 - /: root folder
-- /examples: examples for using this module
-- /helpers: Helper scripts
-- /scripts: Scripts for specific tasks on module (see Infrastructure section on this file)
-- /test: Folders with files for testing the module (see Testing section on this file)
-- /main.tf: main file for this module, contains all the resources to create
-- /variables.tf: all the variables for the module
-- /output.tf: the outputs of the module
-- /readme.MD: this file
+- /examples: Examples for using this module and sub module.
+- /helpers: Helper scripts.
+- /scripts: Scripts for specific tasks on module (see Infrastructure section on this file).
+- /test: Folders with files for testing the module (see Testing section on this file).
+- /main.tf: `main` file for the public module, contains all the resources to create.
+- /variables.tf: Variables for the public cluster module.
+- /output.tf: The outputs for the public cluster module.
+- /README.MD: This file.
+- /modules: Private and beta sub modules.
 
 ## Templating
 

modules/beta-public-cluster/README.md

@@ -1,12 +1,14 @@
 # Terraform Kubernetes Engine Module
 
-This module handles opinionated Google Cloud Platform Kubernetes Engine cluster creation and configuration with Node Pools, IP MASQ, Network Policy, etc.Beta features are enabled on this submodule.
+This module handles opinionated Google Cloud Platform Kubernetes Engine cluster creation and configuration with Node Pools, IP MASQ, Network Policy, etc.Beta features are enabled in this submodule.
 The resources/services/activations/deletions that this module will create/trigger are:
 - Create a GKE cluster with the provided addons
 - Create GKE Node Pool(s) with provided configuration and attach to cluster
 - Replace the default kube-dns configmap if `stub_domains` are provided
 - Activate network policy if `network_policy` is true
-- Add `ip-masq-agent` configmap with provided `non_masquerade_cidrs` if `network_policy` is true
+- Add `ip-masq-agent` configmap with provided `non_masquerade_cidrs` if `configure_ip_masq` is true
+
+Sub modules are provided from creating private clusters, beta private clusters, and beta public clusters as well.  Beta sub modules allow for the use of various GKE beta features. See the modules directory for the various sub modules.
 
 
 ## Compatibility
@@ -100,6 +102,7 @@ module "gke" {
 }
 ```
 
+<!-- do not understand what this is about -->
 Then perform the following commands on the root folder:
 
 - `terraform init` to get the plugins
@@ -249,14 +252,15 @@ In order to operate with the Service Account you must activate the following API
 The project has the following folders and files:
 
 - /: root folder
-- /examples: examples for using this module
-- /helpers: Helper scripts
-- /scripts: Scripts for specific tasks on module (see Infrastructure section on this file)
-- /test: Folders with files for testing the module (see Testing section on this file)
-- /main.tf: main file for this module, contains all the resources to create
-- /variables.tf: all the variables for the module
-- /output.tf: the outputs of the module
-- /readme.MD: this file
+- /examples: Examples for using this module and sub module.
+- /helpers: Helper scripts.
+- /scripts: Scripts for specific tasks on module (see Infrastructure section on this file).
+- /test: Folders with files for testing the module (see Testing section on this file).
+- /main.tf: `main` file for the public module, contains all the resources to create.
+- /variables.tf: Variables for the public cluster module.
+- /output.tf: The outputs for the public cluster module.
+- /README.MD: This file.
+- /modules: Private and beta sub modules.
 
 ## Templating
 

modules/private-cluster/README.md

@@ -6,7 +6,9 @@ The resources/services/activations/deletions that this module will create/trigge
 - Create GKE Node Pool(s) with provided configuration and attach to cluster
 - Replace the default kube-dns configmap if `stub_domains` are provided
 - Activate network policy if `network_policy` is true
-- Add `ip-masq-agent` configmap with provided `non_masquerade_cidrs` if `network_policy` is true
+- Add `ip-masq-agent` configmap with provided `non_masquerade_cidrs` if `configure_ip_masq` is true
+
+Sub modules are provided from creating private clusters, beta private clusters, and beta public clusters as well.  Beta sub modules allow for the use of various GKE beta features. See the modules directory for the various sub modules.
 
 **Note**: You must run Terraform from a VM on the same VPC as your cluster, otherwise there will be issues connecting to the GKE master.
 
@@ -103,6 +105,7 @@ module "gke" {
 }
 ```
 
+<!-- do not understand what this is about -->
 Then perform the following commands on the root folder:
 
 - `terraform init` to get the plugins
@@ -243,14 +246,15 @@ In order to operate with the Service Account you must activate the following API
 The project has the following folders and files:
 
 - /: root folder
-- /examples: examples for using this module
-- /helpers: Helper scripts
-- /scripts: Scripts for specific tasks on module (see Infrastructure section on this file)
-- /test: Folders with files for testing the module (see Testing section on this file)
-- /main.tf: main file for this module, contains all the resources to create
-- /variables.tf: all the variables for the module
-- /output.tf: the outputs of the module
-- /readme.MD: this file
+- /examples: Examples for using this module and sub module.
+- /helpers: Helper scripts.
+- /scripts: Scripts for specific tasks on module (see Infrastructure section on this file).
+- /test: Folders with files for testing the module (see Testing section on this file).
+- /main.tf: `main` file for the public module, contains all the resources to create.
+- /variables.tf: Variables for the public cluster module.
+- /output.tf: The outputs for the public cluster module.
+- /README.MD: This file.
+- /modules: Private and beta sub modules.
 
 ## Templating