Object storage improvements (#84)

* Add example

* Rename bucket_name --> bucket

* Fix examples in wrong folder

* Add example

* Lint examples

* Fix examples

---------

Co-authored-by: Henrique Santos <henrique.santos@freiheit.com>
This commit is contained in:
Henrique Santos 2023-10-13 18:33:45 +01:00 committed by GitHub
parent 7334c802ad
commit 6e51bdd5bf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
18 changed files with 102 additions and 48 deletions

View file

@ -10,18 +10,25 @@ description: |-
ObjectStorage bucket data source schema.
## Example Usage
```terraform
data "stackit_objectstorage_bucket" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
name = "example-name"
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- `bucket_name` (String) The bucket name. It must be DNS conform.
- `name` (String) The bucket name. It must be DNS conform.
- `project_id` (String) STACKIT Project ID to which the bucket is associated.
### Read-Only
- `id` (String) Terraform's internal data source identifier. It is structured as "`project_id`,`bucket_name`".
- `id` (String) Terraform's internal data source identifier. It is structured as "`project_id`,`name`".
- `url_path_style` (String)
- `url_virtual_hosted_style` (String)

View file

@ -10,7 +10,15 @@ description: |-
ObjectStorage credential data source schema.
## Example Usage
```terraform
data "stackit_objectstorage_credentials_group" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
credentials_group_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
credential_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```
<!-- schema generated by tfplugindocs -->
## Schema

View file

@ -10,7 +10,14 @@ description: |-
ObjectStorage credentials group data source schema.
## Example Usage
```terraform
data "stackit_objectstorage_credentials_group" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
credentials_group_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```
<!-- schema generated by tfplugindocs -->
## Schema

View file

@ -10,18 +10,25 @@ description: |-
ObjectStorage bucket resource schema.
## Example Usage
```terraform
resource "stackit_objectstorage_bucket" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
name = "example-bucket"
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- `bucket_name` (String) The bucket name. It must be DNS conform.
- `name` (String) The bucket name. It must be DNS conform.
- `project_id` (String) STACKIT Project ID to which the bucket is associated.
### Read-Only
- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`bucket_name`".
- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`name`".
- `url_path_style` (String)
- `url_virtual_hosted_style` (String)

View file

@ -10,7 +10,15 @@ description: |-
ObjectStorage credential resource schema.
## Example Usage
```terraform
resource "stackit_objectstorage_credential" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
credentials_group_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
expiration_timestamp = "2027-01-02T03:04:05Z"
}
```
<!-- schema generated by tfplugindocs -->
## Schema

View file

@ -10,7 +10,14 @@ description: |-
ObjectStorage credentials group resource schema.
## Example Usage
```terraform
resource "stackit_objectstorage_credentials_group" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
name = "example-credentials-group"
}
```
<!-- schema generated by tfplugindocs -->
## Schema