Skip to content

Commit fcf21e1

Browse files
authored
docs: generate (#61)
1 parent da5e752 commit fcf21e1

File tree

3 files changed

+130
-6
lines changed

3 files changed

+130
-6
lines changed

docs/resources/app_autoscale.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,23 @@ resource "tsuru_app_autoscale" "web" {
2222
2323
schedule {
2424
min_replicas = 5
25-
start = "0 18 * * *"
26-
end = "0 0 * * *"
27-
timezone = "America/Sao_Paulo"
25+
start = "0 18 * * *"
26+
end = "0 0 * * *"
27+
timezone = "America/Sao_Paulo"
2828
}
2929
3030
schedule {
3131
min_replicas = 10
32-
start = "0 18 * * *"
33-
end = "0 19 * * *"
34-
timezone = "UTC"
32+
start = "0 18 * * *"
33+
end = "0 19 * * *"
34+
timezone = "UTC"
35+
}
36+
37+
prometheus {
38+
name = "metric-test"
39+
threshold = 2.7
40+
query = "sum(rate(test_requests_total[1m])) * 60"
41+
custom_address = "http://prometheus.example.com:9090"
3542
}
3643
}
3744
```

docs/resources/job_deploy.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "tsuru_job_deploy Resource - terraform-provider-tsuru"
4+
subcategory: ""
5+
description: |-
6+
Perform an job deploy. Currently, only supporting deploys via prebuilt container images; in order to deploy via tsuru platforms please use tsuru-client
7+
---
8+
9+
# tsuru_job_deploy (Resource)
10+
11+
Perform an job deploy. Currently, only supporting deploys via prebuilt container images; in order to deploy via tsuru platforms please use tsuru-client
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `image` (String) Docker Image
21+
- `job` (String) Job name
22+
23+
### Optional
24+
25+
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
26+
- `wait` (Boolean) Wait for the rollout of deploy
27+
28+
### Read-Only
29+
30+
- `id` (String) The ID of this resource.
31+
- `output_image` (String) Image generated after success of deploy
32+
- `status` (String) After apply may be three kinds of statuses: running or failed or finished
33+
34+
<a id="nestedblock--timeouts"></a>
35+
### Nested Schema for `timeouts`
36+
37+
Optional:
38+
39+
- `create` (String)
40+
- `delete` (String)
41+
- `update` (String)

docs/resources/token.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "tsuru_token Resource - terraform-provider-tsuru"
4+
subcategory: ""
5+
description: |-
6+
Tsuru Token
7+
---
8+
9+
# tsuru_token (Resource)
10+
11+
Tsuru Token
12+
13+
## Example Usage
14+
15+
```terraform
16+
resource "tsuru_token" "simple_token" {
17+
token_id = "my-simple-token"
18+
description = "My description"
19+
team = "team-dev"
20+
expires = "24h"
21+
}
22+
```
23+
24+
<!-- schema generated by tfplugindocs -->
25+
## Schema
26+
27+
### Required
28+
29+
- `team` (String) The team name responsible for this token
30+
31+
### Optional
32+
33+
- `description` (String) Token description
34+
- `expires` (String) Token expiration with suffix (s for seconds, m for minutos, h for hours, ...) 0 or unset means it never expires
35+
- `regenerate_on_update` (Boolean) Setting regenerate will change de value of the token, invalidating the previous value
36+
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
37+
- `token_id` (String) Token name, must be a unique identifier, if empty it will be generated automatically
38+
39+
### Read-Only
40+
41+
- `created_at` (String) Token creation date
42+
- `creator_email` (String) Token creator email
43+
- `expires_at` (String) Token expiration date
44+
- `id` (String) The ID of this resource.
45+
- `last_access` (String) Token last access date
46+
- `roles` (List of Object) Tsuru token roles (see [below for nested schema](#nestedatt--roles))
47+
- `token` (String, Sensitive) Tsuru token
48+
49+
<a id="nestedblock--timeouts"></a>
50+
### Nested Schema for `timeouts`
51+
52+
Optional:
53+
54+
- `create` (String)
55+
- `delete` (String)
56+
- `update` (String)
57+
58+
59+
<a id="nestedatt--roles"></a>
60+
### Nested Schema for `roles`
61+
62+
Read-Only:
63+
64+
- `context_value` (String)
65+
- `name` (String)
66+
67+
## Import
68+
69+
Import is supported using the following syntax:
70+
71+
```shell
72+
terraform import tsuru_token.resource_name "token_id"
73+
74+
# example
75+
terraform import tsuru_token.simple_token "my-simple-token"
76+
```

0 commit comments

Comments
 (0)