Skip to content

Commit

Permalink
chore(docs): update documentation for #418
Browse files Browse the repository at this point in the history
  • Loading branch information
villevsv-upcloud authored and github-actions[bot] committed Oct 20, 2023
1 parent 0ae3c38 commit 83aaa78
Show file tree
Hide file tree
Showing 3 changed files with 183 additions and 0 deletions.
36 changes: 36 additions & 0 deletions docs/data-sources/managed_object_storage_regions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "upcloud_managed_object_storage_regions Data Source - terraform-provider-upcloud"
subcategory: ""
description: |-
Returns a list of available Managed Object Storage regions.
---

# upcloud_managed_object_storage_regions (Data Source)

Returns a list of available Managed Object Storage regions.

## Example Usage

```terraform
data "upcloud_Managed_object_storage" "this" {}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Read-Only

- `id` (String) The ID of this resource.
- `regions` (Set of Object) (see [below for nested schema](#nestedatt--regions))

<a id="nestedatt--regions"></a>
### Nested Schema for `regions`

Read-Only:

- `name` (String)
- `primary_zone` (String)
- `zones` (Set of String)


98 changes: 98 additions & 0 deletions docs/resources/managed_object_storage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "upcloud_managed_object_storage Resource - terraform-provider-upcloud"
subcategory: ""
description: |-
This resource represents an UpCloud Managed Object Storage instance, which provides S3 compatible storage.
---

# upcloud_managed_object_storage (Resource)

This resource represents an UpCloud Managed Object Storage instance, which provides S3 compatible storage.

## Example Usage

```terraform
// Create router for the network
resource "upcloud_router" "this" {
name = "object-storage-example-router"
}
// Create network for the Managed Object Storage
resource "upcloud_network" "this" {
name = "object-storage-example-net"
zone = "fi-hel1"
ip_network {
address = "172.16.2.0/24"
dhcp = true
family = "IPv4"
}
router = upcloud_router.this.id
}
resource "upcloud_managed_object_storage" "this" {
region = "europe-1"
configured_status = "started"
network {
family = "IPv4"
name = "example-private-net"
type = "private"
uuid = upcloud_network.this.id
}
users = ["example"]
labels = {
managed-by = "terraform"
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `configured_status` (String) Service status managed by the end user.
- `region` (String) Region in which the service will be hosted, see `upcloud_managed_object_storage_regions` data source.

### Optional

- `labels` (Map of String) Key-value pairs to classify the managed object storage.
- `network` (Block Set) Attached networks from where object storage can be used. Private networks must reside in object storage region. (see [below for nested schema](#nestedblock--network))
- `users` (Set of String) List of UpCloud API users allowed to use object storage. Valid values include current account and it's sub-accounts. See `upcloud_managed_object_storage_user_access_key` for managing access keys.

### Read-Only

- `created_at` (String) Creation time.
- `endpoint` (Set of Object) Endpoints for accessing the Managed Object Storage service. (see [below for nested schema](#nestedatt--endpoint))
- `id` (String) The ID of this resource.
- `operational_state` (String) Operational state of the Managed Object Storage service.
- `updated_at` (String) Creation time.

<a id="nestedblock--network"></a>
### Nested Schema for `network`

Required:

- `family` (String) Network family. IPv6 currently not supported.
- `name` (String) Network name. Must be unique within the service.
- `type` (String) Network type.

Optional:

- `uuid` (String) Private network uuid. For public networks the field should be omitted.


<a id="nestedatt--endpoint"></a>
### Nested Schema for `endpoint`

Read-Only:

- `domain_name` (String)
- `type` (String)


49 changes: 49 additions & 0 deletions docs/resources/managed_object_storage_user_access_key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "upcloud_managed_object_storage_user_access_key Resource - terraform-provider-upcloud"
subcategory: ""
description: |-
This resource represents an UpCloud Managed Object Storage user access key.
---

# upcloud_managed_object_storage_user_access_key (Resource)

This resource represents an UpCloud Managed Object Storage user access key.

## Example Usage

```terraform
resource "upcloud_managed_object_storage" "this" {
region = "europe-1"
configured_status = "started"
users = ["example"]
}
resource "upcloud_managed_object_storage_user_access_key" "this" {
name = "accesskey"
enabled = true
username = "example"
service_uuid = upcloud_managed_object_storage.this.id
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `enabled` (Boolean) Enabled or not.
- `name` (String) Access key name. Must be unique within the user.
- `service_uuid` (String) Managed Object Storage service UUID.
- `username` (String) Username.

### Read-Only

- `access_key_id` (String) Access key id.
- `created_at` (String) Creation time.
- `id` (String) The ID of this resource.
- `last_used_at` (String) Last used.
- `secret_access_key` (String, Sensitive) Secret access key.
- `updated_at` (String) Update time.


0 comments on commit 83aaa78

Please sign in to comment.