Skip to content

Commit 3f75093

Browse files
Update README for airflow_pool module parameters and pool deletion
1 parent a7d86c2 commit 3f75093

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

modules/airflow_pool/README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,20 @@ This optional module is used to create a Cloud Composer Pool.
66
module "pool" {
77
source = "terraform-google-modules/composer/google//modules/airflow_pool"
88
9-
project_id = "project-123"
10-
environment = "Composer-Prod-Env"
11-
location = "us-central1"
12-
name = "beta"
13-
slots = 1000
14-
description = "Pool used by beta DAGs"
9+
project = "project-123"
10+
environment = "Composer-Prod-Env"
11+
location = "us-central1"
12+
composer_env_name = "beta"
13+
slot_count = 1000
14+
description = "Pool used by beta DAGs"
1515
}
1616
```
1717

18+
> [!IMPORTANT]
19+
> to delete a pool you first need to run
20+
> ``` terraform destroy --target module.however_you_named_it ```
21+
> if you just remove the module configuration from your code the pool will not be deleted.
22+
1823
```
1924
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
2025
## Inputs
@@ -24,9 +29,10 @@ module "pool" {
2429
| composer\_env\_name | Name of the Cloud Composer Environment. | `string` | n/a | yes |
2530
| description | The description of the pool | `string` | `"Managed by Terraform"` | no |
2631
| pool\_name | The name of the pool | `string` | n/a | yes |
27-
| project\_id | Project ID where Cloud Composer Environment is created. | `string` | n/a | yes |
32+
| project | Project name where Cloud Composer Environment is created. | `string` | n/a | yes |
2833
| region | Region where the Cloud Composer Environment is created. | `string` | n/a | yes |
2934
| slot\_count | The number of slots in this pool | `number` | n/a | yes |
35+
| include_deferred | Whether the pool should include deferred tasks in its calculation of occupied slots | `bool` | false | no |
3036
3137
## Outputs
3238

0 commit comments

Comments
 (0)