ref 624723: server backup schedules (#416)

Signed-off-by: Adrian Nackov <adrian.nackov@mail.schwarz>
This commit is contained in:
a_nackov 2024-06-26 13:51:06 +03:00 committed by GitHub
parent 7fbb13c0b6
commit b5eb8bd379
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
21 changed files with 1852 additions and 0 deletions

View file

@ -0,0 +1,47 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "stackit_server_backup_schedule Data Source - stackit"
subcategory: ""
description: |-
Server backup schedule resource schema. Must have a region specified in the provider configuration.
---
# stackit_server_backup_schedule (Data Source)
Server backup schedule resource schema. Must have a `region` specified in the provider configuration.
## Example Usage
```terraform
data "stackit_server_backup_schedule" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
server_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
backup_schedule_id = xxxxx
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- `backup_schedule_id` (Number) Backup schedule ID.
- `project_id` (String) STACKIT Project ID to which the server is associated.
- `server_id` (String) Server ID for the backup schedule.
### Read-Only
- `backup_properties` (Attributes) Backup schedule details for the backups. (see [below for nested schema](#nestedatt--backup_properties))
- `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.
<a id="nestedatt--backup_properties"></a>
### Nested Schema for `backup_properties`
Read-Only:
- `name` (String)
- `retention_period` (Number)
- `volume_ids` (List of String)

View file

@ -0,0 +1,53 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "stackit_server_backup_schedules Data Source - stackit"
subcategory: ""
description: |-
Server backup schedule data source schema.
---
# stackit_server_backup_schedules (Data Source)
Server backup schedule data source schema.
## Example Usage
```terraform
data "stackit_server_backup_schedules" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
server_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- `project_id` (String) STACKIT Project ID (UUID) to which the server is associated.
- `server_id` (String) Server ID (UUID) to which the backup schedule is associated.
### Read-Only
- `id` (String) Terraform's internal data source identifier. It is structured as "`project_id`,`server_id`".
- `items` (Attributes List) (see [below for nested schema](#nestedatt--items))
<a id="nestedatt--items"></a>
### Nested Schema for `items`
Read-Only:
- `backup_properties` (Attributes) Backup schedule details for the backups. (see [below for nested schema](#nestedatt--items--backup_properties))
- `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.
<a id="nestedatt--items--backup_properties"></a>
### Nested Schema for `items.backup_properties`
Read-Only:
- `name` (String)
- `retention_period` (Number)
- `volume_ids` (List of String)

View file

@ -161,6 +161,7 @@ Note: AWS specific checks must be skipped as they do not work on STACKIT. For de
- `region` (String) Region will be used as the default location for regional services. Not all services require a region, some are global
- `resourcemanager_custom_endpoint` (String) Custom endpoint for the Resource Manager service
- `secretsmanager_custom_endpoint` (String) Custom endpoint for the Secrets Manager service
- `server_backup_custom_endpoint` (String) Custom endpoint for the Server Backup service
- `service_account_email` (String) Service account email. It can also be set using the environment variable STACKIT_SERVICE_ACCOUNT_EMAIL. It is required if you want to use the resource manager project resource.
- `service_account_key` (String) Service account key used for authentication. If set, the key flow will be used to authenticate all operations.
- `service_account_key_path` (String) Path for the service account key used for authentication. If set, the key flow will be used to authenticate all operations.

View file

@ -0,0 +1,60 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "stackit_server_backup_schedule Resource - stackit"
subcategory: ""
description: |-
Server backup schedule resource schema. Must have a region specified in the provider configuration.
---
# stackit_server_backup_schedule (Resource)
Server backup schedule resource schema. Must have a `region` specified in the provider configuration.
## Example Usage
```terraform
resource "stackit_server_backup_schedule" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
server_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
name = "example_backup_schedule_name"
rrule = "DTSTART;TZID=Europe/Sofia:20200803T023000 RRULE:FREQ=DAILY;INTERVAL=1"
enabled = true
backup_properties = {
name = "example_backup_name"
retention_period = 14
volume_ids = null
}
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- `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.
- `server_id` (String) Server ID for the backup schedule.
### Optional
- `backup_properties` (Attributes) Backup schedule details for the backups. (see [below for nested schema](#nestedatt--backup_properties))
### Read-Only
- `backup_schedule_id` (Number) Backup schedule ID.
- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`server_id`,`backup_schedule_id`".
<a id="nestedatt--backup_properties"></a>
### Nested Schema for `backup_properties`
Required:
- `name` (String)
- `retention_period` (Number)
Optional:
- `volume_ids` (List of String)