updated docs

terraform-google-modules · Nov 21, 2023 · 1fad3a7 · 1fad3a7
1 parent 6f21190
commit 1fad3a7
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 22 deletions.
diff --git a/modules/create_environment_v2/README.md b/modules/create_environment_v2/README.md
@@ -27,11 +27,13 @@ module "simple-composer-environment" {
     storage_gb = 1
     count      = 2
   }
+
   web_server = {
     cpu        = 0.5
     memory_gb  = 1.875
     storage_gb = 1
   }
+
   worker = {
     cpu        = 0.5
     memory_gb  = 1.875
@@ -40,18 +42,12 @@ module "simple-composer-environment" {
     max_count  = 3
   }
 
-  scheduled_snapshots_config = {
-    enabled                    = true
-    snapshot_location          = "gs://snapshot-bucket-hdsfq86o"
-    snapshot_creation_schedule = "0 4 * * *"
-    time_zone                  = "UTC+01"
+  triggerer = {
+    cpu       = 1
+    memory_gb = 1
+    count     = 2
   }
 
-  maintenance_window = {
-    start_time = "2023-01-01T00:00:00Z"
-    end_time   = "2023-01-01T12:00:00Z"
-    recurrence = "FREQ=WEEKLY;BYDAY=SU,WE,SA"
-  }
 }
 
 ```
@@ -61,10 +57,10 @@ module "simple-composer-environment" {
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | airflow\_config\_overrides | Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags\_are\_paused\_at\_creation". | `map(string)` | `{}` | no |
-| cloud\_composer\_connection\_subnetwork | When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project | `string` | `null` | no |
+| cloud\_composer\_connection\_subnetwork | Subnetwork self-link. When specified, the environment will use Private Service Connect instead of VPC peerings to connect to CloudSQL in the Tenant Project. IP address of psc endpoint is allocated from this subnet | `string` | `null` | no |
 | cloud\_composer\_network\_ipv4\_cidr\_block | The CIDR block from which IP range in tenant project will be reserved. Required if VPC peering is used to connect to CloudSql instead of PSC | `string` | `null` | no |
 | cloud\_data\_lineage\_integration | Whether or not Dataplex data lineage integration is enabled. Cloud Composer environments in versions composer-2.1.2-airflow-..* and newer) | `bool` | `false` | no |
-| cloud\_sql\_ipv4\_cidr | The CIDR block from which IP range in tenant project will be reserved for Cloud SQL private service access | `string` | `null` | no |
+| cloud\_sql\_ipv4\_cidr | The CIDR block from which IP range in tenant project will be reserved for Cloud SQL private service access. Required if VPC peering is used to connect to CloudSql instead of PSC | `string` | `null` | no |
 | composer\_env\_name | Name of Cloud Composer Environment | `string` | n/a | yes |
 | composer\_service\_account | Service Account for running Cloud Composer. | `string` | `null` | no |
 | enable\_ip\_masq\_agent | Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. | `bool` | `false` | no |
@@ -81,20 +77,20 @@ module "simple-composer-environment" {
 | master\_ipv4\_cidr | The CIDR block from which IP range in tenant project will be reserved for the GKE master. Required when `use_private_environment` and `enable_private_endpoint` is `true` | `string` | `null` | no |
 | network | The VPC network to host the composer cluster. | `string` | n/a | yes |
 | network\_project\_id | The project ID of the shared VPC's host (for shared vpc support) | `string` | `""` | no |
-| pod\_ip\_allocation\_range\_name | The name of the cluster's secondary range used to allocate IP addresses to pods. | `string` | `null` | no |
+| pod\_ip\_allocation\_range\_name | The name of the subnet secondary range, used to allocate IP addresses for the pods. | `string` | `null` | no |
 | project\_id | Project ID where Cloud Composer Environment is created. | `string` | n/a | yes |
 | pypi\_packages | Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name (e.g. "numpy"). | `map(string)` | `{}` | no |
 | region | Region where the Cloud Composer Environment is created. | `string` | `"us-central1"` | no |
 | resilience\_mode | Cloud Composer 2.1.15 or newer only. The resilience mode states whether high resilience is enabled for the environment or not. Values for resilience mode are `HIGH_RESILIENCE` for high resilience and `STANDARD_RESILIENCE` for standard resilience | `string` | `null` | no |
 | scheduled\_snapshots\_config | The recovery configuration settings for the Cloud Composer environment | <pre>object({<br>    enabled                    = optional(bool, false)<br>    snapshot_location          = optional(string)<br>    snapshot_creation_schedule = optional(string)<br>    time_zone                  = optional(string)<br>  })</pre> | `null` | no |
 | scheduler | Configuration for resources used by Airflow schedulers. | <pre>object({<br>    cpu        = string<br>    memory_gb  = number<br>    storage_gb = number<br>    count      = number<br>  })</pre> | <pre>{<br>  "count": 2,<br>  "cpu": 2,<br>  "memory_gb": 7.5,<br>  "storage_gb": 5<br>}</pre> | no |
-| service\_ip\_allocation\_range\_name | The name of the services' secondary range used to allocate IP addresses to the cluster. | `string` | `null` | no |
+| service\_ip\_allocation\_range\_name | The name of the subnet secondary range, used to allocate IP addresses for the Services. | `string` | `null` | no |
 | storage\_bucket | Name of an existing Cloud Storage bucket to be used by the environment | `string` | `null` | no |
-| subnetwork | The subnetwork to host the composer cluster. | `string` | n/a | yes |
+| subnetwork | The name of the subnetwork to host the composer cluster. | `string` | n/a | yes |
 | subnetwork\_region | The subnetwork region of the shared VPC's host (for shared vpc support) | `string` | `""` | no |
 | tags | Tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls. | `set(string)` | `[]` | no |
 | triggerer | Configuration for resources used by Airflow triggerer | <pre>object({<br>    cpu       = string<br>    memory_gb = number<br>    count     = number<br>  })</pre> | `null` | no |
-| use\_private\_environment | Enable private environment. | `bool` | `false` | no |
+| use\_private\_environment | Create a private environment. | `bool` | `false` | no |
 | web\_server | Configuration for resources used by Airflow web server. | <pre>object({<br>    cpu        = string<br>    memory_gb  = number<br>    storage_gb = number<br>  })</pre> | <pre>{<br>  "cpu": 2,<br>  "memory_gb": 7.5,<br>  "storage_gb": 5<br>}</pre> | no |
 | worker | Configuration for resources used by Airflow workers. | <pre>object({<br>    cpu        = string<br>    memory_gb  = number<br>    storage_gb = number<br>    min_count  = number<br>    max_count  = number<br>  })</pre> | <pre>{<br>  "cpu": 2,<br>  "max_count": 6,<br>  "memory_gb": 7.5,<br>  "min_count": 2,<br>  "storage_gb": 5<br>}</pre> | no |
 

diff --git a/modules/create_environment_v2/variables.tf b/modules/create_environment_v2/variables.tf
@@ -61,7 +61,7 @@ variable "network_project_id" {
 
 variable "subnetwork" {
   type        = string
-  description = "The subnetwork to host the composer cluster."
+  description = "The name of the subnetwork to host the composer cluster."
 }
 
 variable "subnetwork_region" {
@@ -77,14 +77,14 @@ variable "composer_service_account" {
 }
 
 variable "pod_ip_allocation_range_name" {
-  description = "The name of the cluster's secondary range used to allocate IP addresses to pods."
+  description = "The name of the subnet secondary range, used to allocate IP addresses for the pods."
   type        = string
   default     = null
 }
 
 variable "service_ip_allocation_range_name" {
   type        = string
-  description = "The name of the services' secondary range used to allocate IP addresses to the cluster."
+  description = "The name of the subnet secondary range, used to allocate IP addresses for the Services."
   default     = null
 }
 
@@ -113,19 +113,19 @@ variable "pypi_packages" {
 }
 
 variable "use_private_environment" {
-  description = "Enable private environment."
+  description = "Create a private environment."
   type        = bool
   default     = false
 }
 
 variable "cloud_composer_connection_subnetwork" {
-  description = "When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project"
+  description = "Subnetwork self-link. When specified, the environment will use Private Service Connect instead of VPC peerings to connect to CloudSQL in the Tenant Project. IP address of psc endpoint is allocated from this subnet"
   type        = string
   default     = null
 }
 
 variable "cloud_sql_ipv4_cidr" {
-  description = "The CIDR block from which IP range in tenant project will be reserved for Cloud SQL private service access"
+  description = "The CIDR block from which IP range in tenant project will be reserved for Cloud SQL private service access. Required if VPC peering is used to connect to CloudSql instead of PSC"
   type        = string
   default     = null
 }