Skip to content

Update website documentation about Composer 3 and the recovery_config block #21459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update website documentation about Composer 3 and the recovery_config block #21459

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion website/docs/r/composer_environment.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -868,7 +868,7 @@ The following arguments are supported:
The configuration used for the Kubernetes Engine cluster. Structure is [documented below](#nested_node_config_c2).

* `recovery_config` -
(Optional, Cloud Composer 2 only)
(Optional)
The configuration settings for recovery. Structure is [documented below](#nested_recovery_config_c2).

* `software_config` -
Expand Down Expand Up @@ -1327,6 +1327,10 @@ The following arguments are supported:
(Optional)
The configuration used for the Kubernetes Engine cluster. Structure is [documented below](#nested_node_config_c3).

* `recovery_config` -
(Optional)
The configuration settings for recovery. Structure is [documented below](#nested_recovery_config_c3).

* `software_config` -
(Optional)
The configuration settings for software (Airflow) inside the environment. Structure is [documented below](#nested_software_config_c3).
Expand Down Expand Up @@ -1536,6 +1540,30 @@ The following arguments are supported:
The only allowed values for 'FREQ' field are 'FREQ=DAILY' and 'FREQ=WEEKLY;BYDAY=...'.
Example values: 'FREQ=WEEKLY;BYDAY=TU,WE', 'FREQ=DAILY'.

<a name="nested_recovery_config_c3"></a>The `recovery_config` block supports:

* `scheduled_snapshots_config` -
(Optional)
The recovery configuration settings for the Cloud Composer environment.

The `scheduled_snapshots_config` block supports:

* `enabled` -
(Optional)
When enabled, Cloud Composer periodically saves snapshots of your environment to a Cloud Storage bucket.

* `snapshot_location` -
(Optional)
The URI of a bucket folder where to save the snapshot.

* `snapshot_creation_schedule` -
(Optional)
Snapshot schedule, in the unix-cron format.

* `time_zone` -
(Optional)
A time zone for the schedule. This value is a time offset and does not take into account daylight saving time changes. Valid values are from UTC-12 to UTC+12. Examples: UTC, UTC-01, UTC+03.

The `workloads_config` block supports:

* `scheduler` -
Expand Down