|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "doublecloud_airflow_cluster Resource - terraform-provider-doublecloud" |
| 4 | +subcategory: "" |
| 5 | +description: |- |
| 6 | + Airflow Cluster resource |
| 7 | +--- |
| 8 | + |
| 9 | +# doublecloud_airflow_cluster (Resource) |
| 10 | + |
| 11 | +Airflow Cluster resource |
| 12 | + |
| 13 | +## Example Usage |
| 14 | + |
| 15 | +```terraform |
| 16 | +resource "doublecloud_airflow_cluster" "example-airflow" { |
| 17 | + project_id = var.project_id |
| 18 | + name = "example-airflow" |
| 19 | + region_id = "eu-central-1" |
| 20 | + cloud_type = "aws" |
| 21 | + network_id = data.doublecloud_network.default.id |
| 22 | +
|
| 23 | + resources { |
| 24 | + airflow { |
| 25 | + max_worker_count = 1 |
| 26 | + min_worker_count = 1 |
| 27 | + environment_flavor = "dev_test" |
| 28 | + worker_concurrency = 16 |
| 29 | + worker_disk_size = 10 |
| 30 | + worker_preset = "small" |
| 31 | + } |
| 32 | + } |
| 33 | +
|
| 34 | + config { |
| 35 | + version_id = "2.9.0" |
| 36 | + sync_config { |
| 37 | + repo_url = "https://github.com/apache/airflow" |
| 38 | + branch = "main" |
| 39 | + dags_path = "airflow/example_dags" |
| 40 | + } |
| 41 | + } |
| 42 | +} |
| 43 | +``` |
| 44 | + |
| 45 | +<!-- schema generated by tfplugindocs --> |
| 46 | +## Schema |
| 47 | + |
| 48 | +### Required |
| 49 | + |
| 50 | +- `cloud_type` (String) Cloud provider (`aws`) |
| 51 | +- `name` (String) Cluster name |
| 52 | +- `network_id` (String) Cluster network ID |
| 53 | +- `project_id` (String) Project ID |
| 54 | +- `region_id` (String) Region where the cluster is located |
| 55 | + |
| 56 | +### Optional |
| 57 | + |
| 58 | +- `config` (Block, Optional) Cluster configuration (see [below for nested schema](#nestedblock--config)) |
| 59 | +- `description` (String) Cluster description |
| 60 | +- `resources` (Block, Optional) Cluster resources (see [below for nested schema](#nestedblock--resources)) |
| 61 | + |
| 62 | +### Read-Only |
| 63 | + |
| 64 | +- `connection_info` (Attributes) Public connection info (see [below for nested schema](#nestedatt--connection_info)) |
| 65 | +- `cr_connection_info` (Attributes) Remote connection info (see [below for nested schema](#nestedatt--cr_connection_info)) |
| 66 | +- `id` (String) Cluster ID |
| 67 | + |
| 68 | +<a id="nestedblock--config"></a> |
| 69 | +### Nested Schema for `config` |
| 70 | + |
| 71 | +Required: |
| 72 | + |
| 73 | +- `version_id` (String) Airflow cluster version ID |
| 74 | + |
| 75 | +Optional: |
| 76 | + |
| 77 | +- `airflow_env_variable` (Block List) Environment variables (see [below for nested schema](#nestedblock--config--airflow_env_variable)) |
| 78 | +- `custom_image_digest` (String) Custom Airflow image digest |
| 79 | +- `managed_requirements_txt` (String) Path to the managed `requirements.txt` file |
| 80 | +- `sync_config` (Block, Optional) DAG repository configuration (see [below for nested schema](#nestedblock--config--sync_config)) |
| 81 | +- `user_service_account` (String) Service account for the Airflow cluster |
| 82 | + |
| 83 | +<a id="nestedblock--config--airflow_env_variable"></a> |
| 84 | +### Nested Schema for `config.airflow_env_variable` |
| 85 | + |
| 86 | +Optional: |
| 87 | + |
| 88 | +- `name` (String) Environment variable name |
| 89 | +- `value` (String) Environment variable value |
| 90 | + |
| 91 | + |
| 92 | +<a id="nestedblock--config--sync_config"></a> |
| 93 | +### Nested Schema for `config.sync_config` |
| 94 | + |
| 95 | +Required: |
| 96 | + |
| 97 | +- `branch` (String) DAG repository branch name |
| 98 | +- `dags_path` (String) Path to the directory with DAGs |
| 99 | +- `repo_url` (String) DAG repository URL |
| 100 | + |
| 101 | +Optional: |
| 102 | + |
| 103 | +- `credentials` (Block, Optional) DAG repository credentials (see [below for nested schema](#nestedblock--config--sync_config--credentials)) |
| 104 | +- `revision` (String) DAG repository revision |
| 105 | + |
| 106 | +<a id="nestedblock--config--sync_config--credentials"></a> |
| 107 | +### Nested Schema for `config.sync_config.credentials` |
| 108 | + |
| 109 | +Optional: |
| 110 | + |
| 111 | +- `api_credentials` (Block, Optional) API credentials for accessing the DAG repository (see [below for nested schema](#nestedblock--config--sync_config--credentials--api_credentials)) |
| 112 | + |
| 113 | +<a id="nestedblock--config--sync_config--credentials--api_credentials"></a> |
| 114 | +### Nested Schema for `config.sync_config.credentials.api_credentials` |
| 115 | + |
| 116 | +Required: |
| 117 | + |
| 118 | +- `password` (String, Sensitive) Password |
| 119 | +- `username` (String) Username |
| 120 | + |
| 121 | + |
| 122 | + |
| 123 | + |
| 124 | + |
| 125 | +<a id="nestedblock--resources"></a> |
| 126 | +### Nested Schema for `resources` |
| 127 | + |
| 128 | +Optional: |
| 129 | + |
| 130 | +- `airflow` (Block, Optional) (see [below for nested schema](#nestedblock--resources--airflow)) |
| 131 | + |
| 132 | +<a id="nestedblock--resources--airflow"></a> |
| 133 | +### Nested Schema for `resources.airflow` |
| 134 | + |
| 135 | +Required: |
| 136 | + |
| 137 | +- `environment_flavor` (String) Environment configuration |
| 138 | +- `max_worker_count` (Number) Maximum number of workers |
| 139 | +- `min_worker_count` (Number) Minimum number of workers |
| 140 | +- `worker_concurrency` (Number) Worker concurrency |
| 141 | +- `worker_disk_size` (Number) Worker disk size |
| 142 | +- `worker_preset` (String) Worker resource preset |
| 143 | + |
| 144 | + |
| 145 | + |
| 146 | +<a id="nestedatt--connection_info"></a> |
| 147 | +### Nested Schema for `connection_info` |
| 148 | + |
| 149 | +Read-Only: |
| 150 | + |
| 151 | +- `host` (String) Webserver URL |
| 152 | +- `password` (String, Sensitive) Password for the Airflow user |
| 153 | +- `user` (String) Airflow user |
| 154 | + |
| 155 | + |
| 156 | +<a id="nestedatt--cr_connection_info"></a> |
| 157 | +### Nested Schema for `cr_connection_info` |
| 158 | + |
| 159 | +Read-Only: |
| 160 | + |
| 161 | +- `host` (String) host to use in clients |
| 162 | +- `password` (String, Sensitive) Password for the Airflow user |
| 163 | +- `user` (String) Airflow user |
0 commit comments