From 4da6543315cc2b1b8e22274e5f39c653a8585af2 Mon Sep 17 00:00:00 2001 From: Ludovic DEHON Date: Thu, 24 Oct 2024 21:51:44 +0200 Subject: [PATCH] doc: add missing resources --- docs/data-sources/binding.md | 1 + docs/data-sources/flow.md | 1 + docs/data-sources/group.md | 1 + docs/data-sources/kv.md | 28 ++++++++++ docs/data-sources/namespace.md | 1 + docs/data-sources/namespace_file.md | 1 + docs/data-sources/role.md | 3 +- docs/data-sources/service_account.md | 46 ++++++++++++++++ docs/data-sources/template.md | 1 + docs/data-sources/tenant.md | 1 + docs/data-sources/user.md | 2 + docs/data-sources/user_api_tokens.md | 40 ++++++++++++++ docs/index.md | 8 ++- docs/resources/binding.md | 2 + docs/resources/flow.md | 1 + docs/resources/group.md | 1 + docs/resources/kv.md | 31 +++++++++++ docs/resources/namespace.md | 7 ++- docs/resources/namespace_file.md | 1 + docs/resources/namespace_secret.md | 10 +++- docs/resources/role.md | 2 + docs/resources/service_account.md | 55 +++++++++++++++++++ docs/resources/template.md | 1 + docs/resources/tenant.md | 1 + docs/resources/user.md | 1 + docs/resources/user_api_token.md | 51 +++++++++++++++++ docs/resources/user_password.md | 1 + examples/provider/provider.tf | 2 +- .../resources/kestra_namespace/resource.tf | 6 +- .../kestra_service_account/resource.tf | 2 +- 30 files changed, 295 insertions(+), 14 deletions(-) create mode 100644 docs/data-sources/kv.md create mode 100644 docs/data-sources/service_account.md create mode 100644 docs/data-sources/user_api_tokens.md create mode 100644 docs/resources/kv.md create mode 100644 docs/resources/service_account.md create mode 100644 docs/resources/user_api_token.md diff --git a/docs/data-sources/binding.md b/docs/data-sources/binding.md index 6467ea4..b811875 100644 --- a/docs/data-sources/binding.md +++ b/docs/data-sources/binding.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_binding Data Source - terraform-provider-kestra" subcategory: "" description: |- diff --git a/docs/data-sources/flow.md b/docs/data-sources/flow.md index a2c02d9..9fda29c 100644 --- a/docs/data-sources/flow.md +++ b/docs/data-sources/flow.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_flow Data Source - terraform-provider-kestra" subcategory: "" description: |- diff --git a/docs/data-sources/group.md b/docs/data-sources/group.md index edd0ee1..aefe899 100644 --- a/docs/data-sources/group.md +++ b/docs/data-sources/group.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_group Data Source - terraform-provider-kestra" subcategory: "" description: |- diff --git a/docs/data-sources/kv.md b/docs/data-sources/kv.md new file mode 100644 index 0000000..a31e47b --- /dev/null +++ b/docs/data-sources/kv.md @@ -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 + +### 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. diff --git a/docs/data-sources/namespace.md b/docs/data-sources/namespace.md index 0b8e920..bdf35db 100644 --- a/docs/data-sources/namespace.md +++ b/docs/data-sources/namespace.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_namespace Data Source - terraform-provider-kestra" subcategory: "" description: |- diff --git a/docs/data-sources/namespace_file.md b/docs/data-sources/namespace_file.md index 27c96e2..cd8a524 100644 --- a/docs/data-sources/namespace_file.md +++ b/docs/data-sources/namespace_file.md @@ -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: |- diff --git a/docs/data-sources/role.md b/docs/data-sources/role.md index f70357e..52d889c 100644 --- a/docs/data-sources/role.md +++ b/docs/data-sources/role.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_role Data Source - terraform-provider-kestra" subcategory: "" description: |- @@ -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 diff --git a/docs/data-sources/service_account.md b/docs/data-sources/service_account.md new file mode 100644 index 0000000..5b2330e --- /dev/null +++ b/docs/data-sources/service_account.md @@ -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 + +### 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. + + +### Nested Schema for `group` + +Optional: + +- `tenant_id` (String) The tenant id for this group. + +Read-Only: + +- `group_id` (String) The group id. diff --git a/docs/data-sources/template.md b/docs/data-sources/template.md index b6464dc..c278688 100644 --- a/docs/data-sources/template.md +++ b/docs/data-sources/template.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_template Data Source - terraform-provider-kestra" subcategory: "" description: |- diff --git a/docs/data-sources/tenant.md b/docs/data-sources/tenant.md index f11d654..94379f5 100644 --- a/docs/data-sources/tenant.md +++ b/docs/data-sources/tenant.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_tenant Data Source - terraform-provider-kestra" subcategory: "" description: |- diff --git a/docs/data-sources/user.md b/docs/data-sources/user.md index bca7703..91c0c07 100644 --- a/docs/data-sources/user.md +++ b/docs/data-sources/user.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_user Data Source - terraform-provider-kestra" subcategory: "" description: |- @@ -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. diff --git a/docs/data-sources/user_api_tokens.md b/docs/data-sources/user_api_tokens.md new file mode 100644 index 0000000..b893150 --- /dev/null +++ b/docs/data-sources/user_api_tokens.md @@ -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 + +### 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. + + +### 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) diff --git a/docs/index.md b/docs/index.md index ba829e3..ed76301 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra Provider" subcategory: "" description: |- @@ -30,7 +31,7 @@ provider "kestra" { # optional extra headers extra_headers = { - x-pipeline = "*****" + x-pipeline = "*****" authorization = "Bearer *****" } } @@ -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 diff --git a/docs/resources/binding.md b/docs/resources/binding.md index 1050f7f..71c2c11 100644 --- a/docs/resources/binding.md +++ b/docs/resources/binding.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_binding Resource - terraform-provider-kestra" subcategory: "" description: |- @@ -36,6 +37,7 @@ resource "kestra_binding" "example" { ### Read-Only - `id` (String) The ID of this resource. +- `tenant_id` (String) The tenant id. ## Import diff --git a/docs/resources/flow.md b/docs/resources/flow.md index 5f0f978..916c9ef 100644 --- a/docs/resources/flow.md +++ b/docs/resources/flow.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_flow Resource - terraform-provider-kestra" subcategory: "" description: |- diff --git a/docs/resources/group.md b/docs/resources/group.md index 0aea03c..930765f 100644 --- a/docs/resources/group.md +++ b/docs/resources/group.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_group Resource - terraform-provider-kestra" subcategory: "" description: |- diff --git a/docs/resources/kv.md b/docs/resources/kv.md new file mode 100644 index 0000000..47d7a84 --- /dev/null +++ b/docs/resources/kv.md @@ -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 + +### 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. diff --git a/docs/resources/namespace.md b/docs/resources/namespace.md index 7870e82..77a617d 100644 --- a/docs/resources/namespace.md +++ b/docs/resources/namespace.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_namespace Resource - terraform-provider-kestra" subcategory: "" description: |- @@ -13,9 +14,9 @@ Manages a Kestra Namespace. ```terraform resource "kestra_namespace" "example" { - namespace_id = "company.team" - description = "Friendly description" - variables = < +## 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. + + +### 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}} +``` diff --git a/docs/resources/template.md b/docs/resources/template.md index 1d0b9ac..1e02d9e 100644 --- a/docs/resources/template.md +++ b/docs/resources/template.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_template Resource - terraform-provider-kestra" subcategory: "" description: |- diff --git a/docs/resources/tenant.md b/docs/resources/tenant.md index 93f35b0..62714f7 100644 --- a/docs/resources/tenant.md +++ b/docs/resources/tenant.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_tenant Resource - terraform-provider-kestra" subcategory: "" description: |- diff --git a/docs/resources/user.md b/docs/resources/user.md index ff36832..04f248e 100644 --- a/docs/resources/user.md +++ b/docs/resources/user.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_user Resource - terraform-provider-kestra" subcategory: "" description: |- diff --git a/docs/resources/user_api_token.md b/docs/resources/user_api_token.md new file mode 100644 index 0000000..cb636a1 --- /dev/null +++ b/docs/resources/user_api_token.md @@ -0,0 +1,51 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "kestra_user_api_token Resource - terraform-provider-kestra" +subcategory: "" +description: |- + Manages a Kestra User Api Token. +--- + +# kestra_user_api_token (Resource) + +Manages a Kestra User Api Token. + +## Example Usage + +```terraform +resource "kestra_user_api_token" "example" { + user_id = "4by6NvSLcPXFhCj8nwbZOM" + + name = "test-token" + description = "Test token" + max_age = "PT1H" + extended = false +} +``` + + +## Schema + +### Required + +- `description` (String) The API token description. +- `max_age` (String) The time the token remains valid since creation (ISO 8601 duration format). +- `name` (String) The API token display name. +- `user_id` (String) The ID of the user owning the API Token. + +### Optional + +- `extended` (Boolean) Specify whether the expiry date is automatically moved forward by max age whenever the token is used. Defaults to `false`. + +### Read-Only + +- `full_token` (String, Sensitive) The full API token. +- `id` (String) The ID of this resource. + +## Import + +Import is supported using the following syntax: + +```shell +terraform import kestra_user_api_token.example {{user_id}} +``` diff --git a/docs/resources/user_password.md b/docs/resources/user_password.md index 5f3ab34..2a5c6f6 100644 --- a/docs/resources/user_password.md +++ b/docs/resources/user_password.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "kestra_user_password Resource - terraform-provider-kestra" subcategory: "" description: |- diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf index 2564256..78a4697 100644 --- a/examples/provider/provider.tf +++ b/examples/provider/provider.tf @@ -16,7 +16,7 @@ provider "kestra" { # optional extra headers extra_headers = { - x-pipeline = "*****" + x-pipeline = "*****" authorization = "Bearer *****" } } diff --git a/examples/resources/kestra_namespace/resource.tf b/examples/resources/kestra_namespace/resource.tf index c1daed2..2c8bccf 100644 --- a/examples/resources/kestra_namespace/resource.tf +++ b/examples/resources/kestra_namespace/resource.tf @@ -1,7 +1,7 @@ resource "kestra_namespace" "example" { - namespace_id = "company.team" - description = "Friendly description" - variables = <