Skip to content

Commit

Permalink
Update documentation to enhance clarity and remove redundant sections
Browse files Browse the repository at this point in the history
  • Loading branch information
infezek committed Dec 11, 2024
1 parent aaa1a35 commit b6dfd8a
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 106 deletions.
51 changes: 20 additions & 31 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,33 @@
page_title: "rpaas Provider"
subcategory: ""
description: |-
---

# rpaas Provider



## Example Usage

```terraform
provider "rpaas" {}
provider "tsuru" {}
local {
tsuru_target = "https://mytsuru.example.com"
}
provider "rpaas" {
tsuru_target = local.tsuru_target
}
provider "tsuru" {
host = local.tsuru_target
}
resource "tsuru_service_instance" "my_rpaas" {
service_name = "rpaasv2-be"
name = "my-rpaas"
parameters = {
"plan-override" = jsonencode({
"config" = {
"cacheSize" = "30Gi",
"cacheZoneSize" = "200M",
"cacheInactive" = "24h",
"mapHashBucketSize" = 128,
},
})
}
}
resource "rpaas_autoscale" "be_autoscale" {
service_name = tsuru_service_instance.my_rpaas.service_name
instance = tsuru_service_instance.my_rpaas.name
Expand Down Expand Up @@ -84,22 +85,10 @@ resource "rpaas_route" "be_route_custom" {

### Optional

- `http_timeout_in_seconds` (Number) Timeout in seconds a HTTP request can take.
Zero means no limit.
- `http_timeout_in_seconds` (Number) Timeout in seconds a HTTP request can take. Zero means no limit.
- `rpaas_password` (String) Password to authentication on RPaaS API
- `rpaas_url` (String) URL address for RPaaS API
- `rpaas_user` (String) Username to authenticate on RPaaS API
- `skip_cert_verification` (Boolean) Whether should skip certificate
verification during TLS protocol.
- `tsuru_target` (String) URL address for Tsuru API
- `tsuru_token` (String) Authentication token for Tsuru API
- `parameters` (String) You can pass the parameter to override RPaaSV2 default
settings
- `plan-override` (Json) configuration which will replace values from the
default Nginx template with `config`.
- `config` (Json) The values that can be replaced are these
- `cacheSize` (String) this parameter will replace the Nginx default
- `cacheZoneSize` (String)this parameter will replace the Nginx default
- `cacheInactive` (String)this parameter will replace the Nginx default
- `mapHashBucketSize` (String)this parameter will replace the Nginx default
- `LogFormat` (String)this parameter will replace the Nginx default
- `rpaas_url` (String) URL address for RPaaS API.
- `rpaas_user` (String) Username to authenticate on RPaaS API.
- `skip_cert_verification` (Boolean) Whether should skip certificate verification during TLS protocol.
- `tsuru_target` (String) URL address for Tsuru API.
- `tsuru_token` (String) Authentication token for Tsuru API.
14 changes: 0 additions & 14 deletions docs/resources/acl.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,24 +32,10 @@ resource "rpaas_acl" "example" {
- `port` (Number) Number of port
- `service_name` (String) RPaaS Service Name

### Optional

- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `id` (String) The ID of this resource.

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

Optional:

- `create` (String)
- `delete` (String)
- `read` (String)
- `update` (String)

## Import

Import is supported using the following syntax:
Expand Down
14 changes: 0 additions & 14 deletions docs/resources/block.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,24 +78,10 @@ resource "rpaas_block" "example_lua" {
- `name` (String) Name of the block that will receive the custom configuration content. Allowed values: [root http server lua-server lua-worker]
- `service_name` (String) RPaaS Service Name

### Optional

- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `id` (String) The ID of this resource.

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

Optional:

- `create` (String)
- `delete` (String)
- `read` (String)
- `update` (String)

## Import

Import is supported using the following syntax:
Expand Down
12 changes: 1 addition & 11 deletions docs/resources/cert_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,22 +34,12 @@ resource "rpaas_cert_manager" "example" {

### Optional

- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
- `certificate_name` (String) Certificate Name, required on new version of RPaaS API

### Read-Only

- `id` (String) The ID of this resource.

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

Optional:

- `create` (String)
- `delete` (String)
- `read` (String)
- `update` (String)

## Import

Import is supported using the following syntax:
Expand Down
14 changes: 0 additions & 14 deletions docs/resources/certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,24 +34,10 @@ resource "rpaas_certificate" "example" {
- `name` (String) Name of certificate
- `service_name` (String) RPaaS Service Name

### Optional

- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `id` (String) The ID of this resource.

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

Optional:

- `create` (String)
- `delete` (String)
- `read` (String)
- `update` (String)

## Import

Import is supported using the following syntax:
Expand Down
11 changes: 0 additions & 11 deletions docs/resources/file.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,22 +53,11 @@ resource "rpaas_file" "example_txt" {

- `content` (String) Content of the persistent file in the instance filesystem, expected to be an UTF-8 encoded string.
- `content_base64` (String) Content of the persistent file in the instance filesystem, expected to be binary encoded as base64 string. (v0.2.3)
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `id` (String) The ID of this resource.

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

Optional:

- `create` (String)
- `delete` (String)
- `read` (String)
- `update` (String)

## Import

Import is supported using the following syntax:
Expand Down
11 changes: 0 additions & 11 deletions docs/resources/route.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,22 +37,11 @@ resource "rpaas_route" "example" {
- `content` (String) Custom Nginx configuration content
- `destination` (String) Custom Nginx upstream destination
- `https_only` (Boolean) Only on https
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `id` (String) The ID of this resource.

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

Optional:

- `create` (String)
- `delete` (String)
- `read` (String)
- `update` (String)

## Import

Import is supported using the following syntax:
Expand Down

0 comments on commit b6dfd8a

Please sign in to comment.