Skip to content

Commit

Permalink
docs: generate (#61)
Browse files Browse the repository at this point in the history
  • Loading branch information
infezek authored Oct 23, 2024
1 parent da5e752 commit fcf21e1
Show file tree
Hide file tree
Showing 3 changed files with 130 additions and 6 deletions.
19 changes: 13 additions & 6 deletions docs/resources/app_autoscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,23 @@ resource "tsuru_app_autoscale" "web" {
schedule {
min_replicas = 5
start = "0 18 * * *"
end = "0 0 * * *"
timezone = "America/Sao_Paulo"
start = "0 18 * * *"
end = "0 0 * * *"
timezone = "America/Sao_Paulo"
}
schedule {
min_replicas = 10
start = "0 18 * * *"
end = "0 19 * * *"
timezone = "UTC"
start = "0 18 * * *"
end = "0 19 * * *"
timezone = "UTC"
}
prometheus {
name = "metric-test"
threshold = 2.7
query = "sum(rate(test_requests_total[1m])) * 60"
custom_address = "http://prometheus.example.com:9090"
}
}
```
Expand Down
41 changes: 41 additions & 0 deletions docs/resources/job_deploy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "tsuru_job_deploy Resource - terraform-provider-tsuru"
subcategory: ""
description: |-
Perform an job deploy. Currently, only supporting deploys via prebuilt container images; in order to deploy via tsuru platforms please use tsuru-client
---

# tsuru_job_deploy (Resource)

Perform an job deploy. Currently, only supporting deploys via prebuilt container images; in order to deploy via tsuru platforms please use tsuru-client



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

### Required

- `image` (String) Docker Image
- `job` (String) Job name

### Optional

- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
- `wait` (Boolean) Wait for the rollout of deploy

### Read-Only

- `id` (String) The ID of this resource.
- `output_image` (String) Image generated after success of deploy
- `status` (String) After apply may be three kinds of statuses: running or failed or finished

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

Optional:

- `create` (String)
- `delete` (String)
- `update` (String)
76 changes: 76 additions & 0 deletions docs/resources/token.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "tsuru_token Resource - terraform-provider-tsuru"
subcategory: ""
description: |-
Tsuru Token
---

# tsuru_token (Resource)

Tsuru Token

## Example Usage

```terraform
resource "tsuru_token" "simple_token" {
token_id = "my-simple-token"
description = "My description"
team = "team-dev"
expires = "24h"
}
```

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

### Required

- `team` (String) The team name responsible for this token

### Optional

- `description` (String) Token description
- `expires` (String) Token expiration with suffix (s for seconds, m for minutos, h for hours, ...) 0 or unset means it never expires
- `regenerate_on_update` (Boolean) Setting regenerate will change de value of the token, invalidating the previous value
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
- `token_id` (String) Token name, must be a unique identifier, if empty it will be generated automatically

### Read-Only

- `created_at` (String) Token creation date
- `creator_email` (String) Token creator email
- `expires_at` (String) Token expiration date
- `id` (String) The ID of this resource.
- `last_access` (String) Token last access date
- `roles` (List of Object) Tsuru token roles (see [below for nested schema](#nestedatt--roles))
- `token` (String, Sensitive) Tsuru token

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

Optional:

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


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

Read-Only:

- `context_value` (String)
- `name` (String)

## Import

Import is supported using the following syntax:

```shell
terraform import tsuru_token.resource_name "token_id"

# example
terraform import tsuru_token.simple_token "my-simple-token"
```

0 comments on commit fcf21e1

Please sign in to comment.