Skip to content

STACKITSBM-463 - update docs - rrule,maintenance_window #1221

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
aeter wants to merge 1 commit into
base: main
Choose a base branch
from
Open

STACKITSBM-463 - update docs - rrule,maintenance_window #1221

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/data-sources/server_backup_schedule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ data "stackit_server_backup_schedule" "example" {
- `enabled` (Boolean) Is the backup schedule enabled or disabled.
- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`server_id`,`backup_schedule_id`".
- `name` (String) The schedule name.
- `rrule` (String) Backup schedule described in `rrule` (recurrence rule) format.
- `rrule` (String) An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.

<a id="nestedatt--backup_properties"></a>
### Nested Schema for `backup_properties`
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/server_backup_schedules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Read-Only:
- `backup_schedule_id` (Number)
- `enabled` (Boolean) Is the backup schedule enabled or disabled.
- `name` (String) The backup schedule name.
- `rrule` (String) Backup schedule described in `rrule` (recurrence rule) format.
- `rrule` (String) An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.

<a id="nestedatt--items--backup_properties"></a>
### Nested Schema for `items.backup_properties`
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/server_update_schedule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,6 @@ data "stackit_server_update_schedule" "example" {

- `enabled` (Boolean) Is the update schedule enabled or disabled.
- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`region`,`server_id`,`update_schedule_id`".
- `maintenance_window` (Number) Maintenance window [1..24].
- `maintenance_window` (Number) Maintenance window [1..24]. Updates start within the defined hourly window. Depending on the updates, the process may exceed this timeframe and require an automatic restart.
- `name` (String) The schedule name.
- `rrule` (String) Update schedule described in `rrule` (recurrence rule) format.
- `rrule` (String) An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
4 changes: 2 additions & 2 deletions docs/data-sources/server_update_schedules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ data "stackit_server_update_schedules" "example" {
Read-Only:

- `enabled` (Boolean) Is the update schedule enabled or disabled.
- `maintenance_window` (Number) Maintenance window [1..24].
- `maintenance_window` (Number) Maintenance window [1..24]. Updates start within the defined hourly window. Depending on the updates, the process may exceed this timeframe and require an automatic restart.
- `name` (String) The update schedule name.
- `rrule` (String) Update schedule described in `rrule` (recurrence rule) format.
- `rrule` (String) An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
- `update_schedule_id` (Number)
2 changes: 1 addition & 1 deletion docs/resources/server_backup_schedule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ import {
- `enabled` (Boolean) Is the backup schedule enabled or disabled.
- `name` (String) The schedule name.
- `project_id` (String) STACKIT Project ID to which the server is associated.
- `rrule` (String) Backup schedule described in `rrule` (recurrence rule) format.
- `rrule` (String) An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
- `server_id` (String) Server ID for the backup schedule.

### Optional
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/server_update_schedule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@ import {
### Required

- `enabled` (Boolean) Is the update schedule enabled or disabled.
- `maintenance_window` (Number) Maintenance window [1..24].
- `maintenance_window` (Number) Maintenance window [1..24]. Updates start within the defined hourly window. Depending on the updates, the process may exceed this timeframe and require an automatic restart.
- `name` (String) The schedule name.
- `project_id` (String) STACKIT Project ID to which the server is associated.
- `rrule` (String) Update schedule described in `rrule` (recurrence rule) format.
- `rrule` (String) An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
- `server_id` (String) Server ID for the update schedule.

### Optional
Expand Down
2 changes: 1 addition & 1 deletion stackit/internal/services/serverbackup/schedule/resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ func (r *scheduleResource) Schema(_ context.Context, _ resource.SchemaRequest, r
},
},
"rrule": schema.StringAttribute{
Description: "Backup schedule described in `rrule` (recurrence rule) format.",
Description: "An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.",
Required: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.RequiresReplace(),
Expand Down
2 changes: 1 addition & 1 deletion stackit/internal/services/serverbackup/schedule/schedule_datasource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ func (r *scheduleDataSource) Schema(_ context.Context, _ datasource.SchemaReques
},
},
"rrule": schema.StringAttribute{
Description: "Backup schedule described in `rrule` (recurrence rule) format.",
Description: "An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.",
Computed: true,
},
"enabled": schema.BoolAttribute{
Expand Down
2 changes: 1 addition & 1 deletion stackit/internal/services/serverbackup/schedule/schedules_datasource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ func (r *schedulesDataSource) Schema(_ context.Context, _ datasource.SchemaReque
Computed: true,
},
"rrule": schema.StringAttribute{
Description: "Backup schedule described in `rrule` (recurrence rule) format.",
Description: "An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.",
Computed: true,
},
"enabled": schema.BoolAttribute{
Expand Down
4 changes: 2 additions & 2 deletions stackit/internal/services/serverupdate/schedule/resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ func (r *scheduleResource) Schema(_ context.Context, _ resource.SchemaRequest, r
},
},
"rrule": schema.StringAttribute{
Description: "Update schedule described in `rrule` (recurrence rule) format.",
Description: "An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.",
Required: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.RequiresReplace(),
Expand All @@ -193,7 +193,7 @@ func (r *scheduleResource) Schema(_ context.Context, _ resource.SchemaRequest, r
Required: true,
},
"maintenance_window": schema.Int64Attribute{
Description: "Maintenance window [1..24].",
Description: "Maintenance window [1..24]. Updates start within the defined hourly window. Depending on the updates, the process may exceed this timeframe and require an automatic restart.",
Required: true,
Validators: []validator.Int64{
int64validator.AtLeast(1),
Expand Down
4 changes: 2 additions & 2 deletions stackit/internal/services/serverupdate/schedule/schedule_datasource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,15 +107,15 @@ func (r *scheduleDataSource) Schema(_ context.Context, _ datasource.SchemaReques
},
},
"rrule": schema.StringAttribute{
Description: "Update schedule described in `rrule` (recurrence rule) format.",
Description: "An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.",
Computed: true,
},
"enabled": schema.BoolAttribute{
Description: "Is the update schedule enabled or disabled.",
Computed: true,
},
"maintenance_window": schema.Int64Attribute{
Description: "Maintenance window [1..24].",
Description: "Maintenance window [1..24]. Updates start within the defined hourly window. Depending on the updates, the process may exceed this timeframe and require an automatic restart.",
Computed: true,
},
"region": schema.StringAttribute{
Expand Down
4 changes: 2 additions & 2 deletions stackit/internal/services/serverupdate/schedule/schedules_datasource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,15 +109,15 @@ func (r *schedulesDataSource) Schema(_ context.Context, _ datasource.SchemaReque
Computed: true,
},
"rrule": schema.StringAttribute{
Description: "Update schedule described in `rrule` (recurrence rule) format.",
Description: "An `rrule` (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.",
Computed: true,
},
"enabled": schema.BoolAttribute{
Description: "Is the update schedule enabled or disabled.",
Computed: true,
},
"maintenance_window": schema.Int64Attribute{
Description: "Maintenance window [1..24].",
Description: "Maintenance window [1..24]. Updates start within the defined hourly window. Depending on the updates, the process may exceed this timeframe and require an automatic restart.",
Computed: true,
},
},
Expand Down