Skip to content

Commit

Permalink
doc: add missing resources
Browse files Browse the repository at this point in the history
  • Loading branch information
tchiotludo committed Oct 24, 2024
1 parent 01b5bd4 commit 4da6543
Show file tree
Hide file tree
Showing 30 changed files with 295 additions and 14 deletions.
1 change: 1 addition & 0 deletions docs/data-sources/binding.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_binding Data Source - terraform-provider-kestra"
subcategory: ""
description: |-
Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/flow.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_flow Data Source - terraform-provider-kestra"
subcategory: ""
description: |-
Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/group.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_group Data Source - terraform-provider-kestra"
subcategory: ""
description: |-
Expand Down
28 changes: 28 additions & 0 deletions docs/data-sources/kv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_kv Data Source - terraform-provider-kestra"
subcategory: ""
description: |-
Use this data source to access value for an existing Key-Value pair.
---

# kestra_kv (Data Source)

Use this data source to access value for an existing Key-Value pair.



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

### Required

- `key` (String) The key to fetch value for.
- `namespace` (String) The namespace of the Key-Value pair.

### Read-Only

- `id` (String) The ID of this resource.
- `tenant_id` (String) The tenant id.
- `type` (String) The type of the value. One of STRING, NUMBER, BOOLEAN, DATETIME, DATE, DURATION, JSON.
- `value` (String) The fetched value.
1 change: 1 addition & 0 deletions docs/data-sources/namespace.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_namespace Data Source - terraform-provider-kestra"
subcategory: ""
description: |-
Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/namespace_file.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_namespace_file Data Source - terraform-provider-kestra"
subcategory: ""
description: |-
Expand Down
3 changes: 2 additions & 1 deletion docs/data-sources/role.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_role Data Source - terraform-provider-kestra"
subcategory: ""
description: |-
Expand Down Expand Up @@ -26,8 +27,8 @@ data "kestra_role" "example" {

### Optional

- `is_default` (Boolean) The role is the default one at user creation. Only one role can be default. Latest create/update to true will be keep as default. Defaults to `false`.
- `namespace` (String) The linked namespace.
- `is_default` (Boolean) The role is the default one at user creation. Only one role can be default. Latest create/update to true will be keep as default.

### Read-Only

Expand Down
46 changes: 46 additions & 0 deletions docs/data-sources/service_account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_service_account Data Source - terraform-provider-kestra"
subcategory: ""
description: |-
Use this data source to access information about an existing Kestra Service Account.
---

# kestra_service_account (Data Source)

Use this data source to access information about an existing Kestra Service Account.

## Example Usage

```terraform
data "kestra_user_service_account" "example" {
id = "68xAawPfiJPkTkZJIPX6jQ"
}
```

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

### Required

- `id` (String) The service account id.

### Optional

- `group` (Block Set) The service account group. (see [below for nested schema](#nestedblock--group))

### Read-Only

- `description` (String) The service account description.
- `username` (String) The service account name.

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

Optional:

- `tenant_id` (String) The tenant id for this group.

Read-Only:

- `group_id` (String) The group id.
1 change: 1 addition & 0 deletions docs/data-sources/template.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_template Data Source - terraform-provider-kestra"
subcategory: ""
description: |-
Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/tenant.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_tenant Data Source - terraform-provider-kestra"
subcategory: ""
description: |-
Expand Down
2 changes: 2 additions & 0 deletions docs/data-sources/user.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_user Data Source - terraform-provider-kestra"
subcategory: ""
description: |-
Expand Down Expand Up @@ -36,4 +37,5 @@ data "kestra_user" "example" {
- `groups` (List of String) The user global roles in yaml string.
- `id` (String) The ID of this resource.
- `last_name` (String) The user last name.
- `tenant_id` (String) The tenant id.
- `username` (String) The user name.
40 changes: 40 additions & 0 deletions docs/data-sources/user_api_tokens.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_user_api_tokens Data Source - terraform-provider-kestra"
subcategory: ""
description: |-
Use this data source to access information about the API tokens of a Kestra User.
---

# kestra_user_api_tokens (Data Source)

Use this data source to access information about the API tokens of a Kestra User.



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

### Required

- `user_id` (String) The ID of the user owning the API Tokens.

### Read-Only

- `api_tokens` (Set of Object) The API tokens of the user. (see [below for nested schema](#nestedatt--api_tokens))
- `id` (String) The ID of this resource.

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

Read-Only:

- `description` (String)
- `exp` (String)
- `expired` (Boolean)
- `extended` (Boolean)
- `iat` (String)
- `last_used` (String)
- `name` (String)
- `token_id` (String)
- `token_prefix` (String)
8 changes: 5 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra Provider"
subcategory: ""
description: |-
Expand Down Expand Up @@ -30,7 +31,7 @@ provider "kestra" {
# optional extra headers
extra_headers = {
x-pipeline = "*****"
x-pipeline = "*****"
authorization = "Bearer *****"
}
}
Expand All @@ -44,8 +45,9 @@ provider "kestra" {
- `api_token` (String, Sensitive) The API token (EE)
- `extra_headers` (Map of String) Extra headers to add to every request
- `jwt` (String, Sensitive) The JWT token (EE)
- `keep_original_source` (Boolean) Keep original source code, keeping comment and indentation.
- `keep_original_source` (Boolean) Keep original source code, keeping comment and indentation. Setting to false is now deprecated and will be removed in the future.
- `password` (String, Sensitive) The BasicAuth password
- `tenant_id` (String) The tenant id (EE)
- `url` (String) The endpoint url without trailing slash
- `timeout` (Number) The timeout (in seconds) for http requests
- `url` (String) The endpoint url
- `username` (String) The BasicAuth username
2 changes: 2 additions & 0 deletions docs/resources/binding.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_binding Resource - terraform-provider-kestra"
subcategory: ""
description: |-
Expand Down Expand Up @@ -36,6 +37,7 @@ resource "kestra_binding" "example" {
### Read-Only

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

## Import

Expand Down
1 change: 1 addition & 0 deletions docs/resources/flow.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_flow Resource - terraform-provider-kestra"
subcategory: ""
description: |-
Expand Down
1 change: 1 addition & 0 deletions docs/resources/group.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_group Resource - terraform-provider-kestra"
subcategory: ""
description: |-
Expand Down
31 changes: 31 additions & 0 deletions docs/resources/kv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_kv Resource - terraform-provider-kestra"
subcategory: ""
description: |-
Manages a Kestra Namespace File.
---

# kestra_kv (Resource)

Manages a Kestra Namespace File.



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

### Required

- `key` (String) The key of the pair.
- `namespace` (String) The namespace of the Key-Value pair.
- `value` (String) The fetched value.

### Optional

- `type` (String) The type of the value. If not provided, we will try to deduce the type based on the value. Useful in case you provide numbers, booleans, dates or json that you want to be stored as string. Accepted values are: STRING, NUMBER, BOOLEAN, DATETIME, DATE, DURATION, JSON.

### Read-Only

- `id` (String) The ID of this resource.
- `tenant_id` (String) The tenant id.
7 changes: 4 additions & 3 deletions docs/resources/namespace.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_namespace Resource - terraform-provider-kestra"
subcategory: ""
description: |-
Expand All @@ -13,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 Down
1 change: 1 addition & 0 deletions docs/resources/namespace_file.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_namespace_file Resource - terraform-provider-kestra"
subcategory: ""
description: |-
Expand Down
10 changes: 8 additions & 2 deletions docs/resources/namespace_secret.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_namespace_secret Resource - terraform-provider-kestra"
subcategory: ""
description: |-
Expand All @@ -25,8 +26,13 @@ resource "kestra_namespace_secret" "example" {
### Required

- `namespace` (String) The namespace.
- `secret_key` (String) The namespace secrey key.
- `secret_value` (String, Sensitive) The namespace secrey value.
- `secret_key` (String) The namespace secret key.
- `secret_value` (String, Sensitive) The namespace secret value.

### Optional

- `secret_description` (String) The namespace secret description.
- `secret_tags` (Map of String) The namespace secret description.

### Read-Only

Expand Down
2 changes: 2 additions & 0 deletions docs/resources/role.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_role Resource - terraform-provider-kestra"
subcategory: ""
description: |-
Expand Down Expand Up @@ -39,6 +40,7 @@ resource "kestra_role" "example" {
### Optional

- `description` (String) The role description.
- `is_default` (Boolean) The role is the default one at user creation. Only one role can be default. Latest create/update to true will be keep as default. Defaults to `false`.
- `namespace` (String) The linked namespace.
- `permissions` (Block Set) The role permissions. (see [below for nested schema](#nestedblock--permissions))

Expand Down
55 changes: 55 additions & 0 deletions docs/resources/service_account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_service_account Resource - terraform-provider-kestra"
subcategory: ""
description: |-
Manages a Kestra Service Account.
---

# kestra_service_account (Resource)

Manages a Kestra Service Account.

## Example Usage

```terraform
resource "kestra_service_account" "example" {
username = "my-service-account"
description = "Friendly description"
}
```

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

### Required

- `username` (String) The service account name.

### Optional

- `description` (String) The service account description.
- `group` (Block Set) The service account group. (see [below for nested schema](#nestedblock--group))

### Read-Only

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

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

Required:

- `group_id` (String) The group id.

Optional:

- `tenant_id` (String) The tenant id for this group.

## Import

Import is supported using the following syntax:

```shell
terraform import kestra_service_account.example {{user_id}}
```
1 change: 1 addition & 0 deletions docs/resources/template.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kestra_template Resource - terraform-provider-kestra"
subcategory: ""
description: |-
Expand Down
Loading

0 comments on commit 4da6543

Please sign in to comment.