From e38f79800ca64ec6f4de6cd3ebef781a97ccdee2 Mon Sep 17 00:00:00 2001 From: PPacent Date: Tue, 30 May 2023 13:33:03 -0700 Subject: [PATCH 1/3] Update boundary_cluster.md Clarify UTC time zone --- docs/resources/boundary_cluster.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/resources/boundary_cluster.md b/docs/resources/boundary_cluster.md index 81bea6150..7e33aad5f 100644 --- a/docs/resources/boundary_cluster.md +++ b/docs/resources/boundary_cluster.md @@ -37,7 +37,7 @@ resource "hcp_boundary_cluster" "example" { ### Optional -- `maintenance_window_config` (Block List, Max: 1) The maintenance window configuration for when cluster upgrades can take place. (see [below for nested schema](#nestedblock--maintenance_window_config)) +- `maintenance_window_config` (Block List, Max: 1) The maintenance window configuration for when cluster upgrades can take place. (see [below for nested schema](#nestedblock--maintenance_window_config)). Must be in UTC time zone. - `project_id` (String) The ID of the HCP project where the Boundary cluster is located. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) @@ -60,7 +60,7 @@ Optional: -### Nested Schema for `timeouts` +### Nested Schema for `timeouts` (all times should be in UTC timezone) Optional: From 0ed2cd08421cfbd8e9ec25fb0468d95614b672c1 Mon Sep 17 00:00:00 2001 From: Uruemu Aganbi Date: Tue, 30 May 2023 17:00:43 -0400 Subject: [PATCH 2/3] Update documentation --- .changelog/518.txt | 3 +++ internal/provider/resource_boundary_cluster.go | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 .changelog/518.txt diff --git a/.changelog/518.txt b/.changelog/518.txt new file mode 100644 index 000000000..45383cd92 --- /dev/null +++ b/.changelog/518.txt @@ -0,0 +1,3 @@ +```release-note:improvement +Documentation: Update HCP Boundary maintenance window documentation to specify that UTC timezone is expected. +``` \ No newline at end of file diff --git a/internal/provider/resource_boundary_cluster.go b/internal/provider/resource_boundary_cluster.go index f3f1e89be..2d07b4eb3 100644 --- a/internal/provider/resource_boundary_cluster.go +++ b/internal/provider/resource_boundary_cluster.go @@ -126,7 +126,7 @@ func resourceBoundaryCluster() *schema.Resource { RequiredWith: []string{"maintenance_window_config.0.start"}, }, "start": { - Description: "The start time which upgrades can be performed. Uses 24H clock. Valid options include - 0 to 23 (inclusive)", + Description: "The start time which upgrades can be performed. Uses 24H clock and must be in UTC time zone. Valid options include - 0 to 23 (inclusive)", Type: schema.TypeInt, Optional: true, ValidateFunc: validation.IntBetween(0, 23), @@ -136,7 +136,7 @@ func resourceBoundaryCluster() *schema.Resource { RequiredWith: []string{"maintenance_window_config.0.day"}, }, "end": { - Description: "The end time which upgrades can be performed. Uses 24H clock. Valid options include - 1 to 24 (inclusive)", + Description: "The end time which upgrades can be performed. Uses 24H clock and must be in UTC time zone. Valid options include - 1 to 24 (inclusive)", Type: schema.TypeInt, Optional: true, ValidateFunc: validation.IntBetween(1, 24), From 85f6a562e8c3547fd99a0aec5f4eb763b5effc10 Mon Sep 17 00:00:00 2001 From: Uruemu Aganbi Date: Tue, 30 May 2023 17:01:12 -0400 Subject: [PATCH 3/3] Generate docs --- docs/resources/boundary_cluster.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/resources/boundary_cluster.md b/docs/resources/boundary_cluster.md index 7e33aad5f..7f1a2eb04 100644 --- a/docs/resources/boundary_cluster.md +++ b/docs/resources/boundary_cluster.md @@ -37,7 +37,7 @@ resource "hcp_boundary_cluster" "example" { ### Optional -- `maintenance_window_config` (Block List, Max: 1) The maintenance window configuration for when cluster upgrades can take place. (see [below for nested schema](#nestedblock--maintenance_window_config)). Must be in UTC time zone. +- `maintenance_window_config` (Block List, Max: 1) The maintenance window configuration for when cluster upgrades can take place. (see [below for nested schema](#nestedblock--maintenance_window_config)) - `project_id` (String) The ID of the HCP project where the Boundary cluster is located. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) @@ -54,13 +54,13 @@ resource "hcp_boundary_cluster" "example" { Optional: - `day` (String) The maintenance day of the week for scheduled upgrades. Valid options for maintenance window day - `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY` -- `end` (Number) The end time which upgrades can be performed. Uses 24H clock. Valid options include - 1 to 24 (inclusive) -- `start` (Number) The start time which upgrades can be performed. Uses 24H clock. Valid options include - 0 to 23 (inclusive) +- `end` (Number) The end time which upgrades can be performed. Uses 24H clock and must be in UTC time zone. Valid options include - 1 to 24 (inclusive) +- `start` (Number) The start time which upgrades can be performed. Uses 24H clock and must be in UTC time zone. Valid options include - 0 to 23 (inclusive) - `upgrade_type` (String) The upgrade type for the cluster. Valid options for upgrade type - `AUTOMATIC`, `SCHEDULED` -### Nested Schema for `timeouts` (all times should be in UTC timezone) +### Nested Schema for `timeouts` Optional: