Skip to content

Commit

Permalink
feat(): doc from plugindocs
Browse files Browse the repository at this point in the history
  • Loading branch information
Skraye committed Dec 19, 2024
1 parent b969953 commit 7bad333
Show file tree
Hide file tree
Showing 7 changed files with 79 additions and 17 deletions.
3 changes: 0 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@ provider "kestra" {
# mandatory, the Kestra webserver/standalone URL
url = "http://localhost:8080"
# optional api token (EE)
api_token = "api-token-value"
# optional basic auth username
username = "john"
Expand Down
25 changes: 25 additions & 0 deletions docs/resources/app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_app Resource - terraform-provider-kestra"
subcategory: ""
description: |-
Manages an App resource.
---

# kestra_app (Resource)

Manages an App resource.



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

### Required

- `source` (String) The source text.

### Read-Only

- `id` (String) The ID of this resource.
- `uid` (String) The unique identifier.
24 changes: 24 additions & 0 deletions docs/resources/dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_dashboard Resource - terraform-provider-kestra"
subcategory: ""
description: |-
Manages a Dashboard resource.
---

# kestra_dashboard (Resource)

Manages a Dashboard resource.



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

### Required

- `source_code` (String) The source code text.

### Read-Only

- `id` (String) The unique identifier.
2 changes: 1 addition & 1 deletion docs/resources/kv.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# kestra_kv (Resource)

Manages a Kestra Namespace Key Value Store.
Manages a Kestra Namespace File.



Expand Down
34 changes: 25 additions & 9 deletions docs/resources/namespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Manages a Kestra Namespace.

```terraform
resource "kestra_namespace" "example" {
namespace_id = "company.team"
description = "Friendly description"
variables = <<EOT
namespace_id = "company.team"
description = "Friendly description"
variables = <<EOT
k1: 1
k2:
v1: 1
Expand All @@ -41,21 +41,37 @@ EOT

### Optional

- `allowed_namespaces` (Block List) The allowed namespaces. (see [below for nested schema](#nestedblock--allowed_namespaces))
- `description` (String) The namespace friendly description.
- `plugin_defaults` (String) The namespace plugin defaults in yaml string.
- `variables` (String) The namespace variables in yaml string.
- `allowed_namespaces` (List of Object) The allowed namespaces.
- `namespace` (String) The allowed namespace.
- `storage_type` (String) The storage type.
- `storage_configuration` (Map of String) The storage configuration.
- `secret_type` (String) The secret type.
- `secret_configuration` (Map of String) The secret configuration.
- `secret_type` (String) The secret type.
- `storage_configuration` (Map of String) The storage configuration.
- `storage_type` (String) The storage type.
- `variables` (String) The namespace variables in yaml string.
- `worker_group` (Block List, Max: 1) The worker group. (see [below for nested schema](#nestedblock--worker_group))

### Read-Only

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

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

Required:

- `namespace` (String) The namespace.


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

Required:

- `fallback` (String) The fallback strategy.
- `key` (String) The worker group key.

## Import

Import is supported using the following syntax:
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/service_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Manages a Kestra Service Account.

```terraform
resource "kestra_service_account" "example" {
username = "my-service-account"
username = "my-service-account"
description = "Friendly description"
}
```
Expand Down
6 changes: 3 additions & 3 deletions docs/resources/user_api_token.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ Manages a Kestra User Api Token.
resource "kestra_user_api_token" "example" {
user_id = "4by6NvSLcPXFhCj8nwbZOM"
name = "test-token"
name = "test-token"
description = "Test token"
max_age = "PT1H"
extended = false
max_age = "PT1H"
extended = false
}
```

Expand Down

0 comments on commit 7bad333

Please sign in to comment.