From 7bad33318682d6a821ac8833dd96553c572900d6 Mon Sep 17 00:00:00 2001 From: YannC Date: Thu, 19 Dec 2024 16:51:26 +0100 Subject: [PATCH] feat(): doc from plugindocs --- docs/index.md | 3 --- docs/resources/app.md | 25 +++++++++++++++++++++++ docs/resources/dashboard.md | 24 ++++++++++++++++++++++ docs/resources/kv.md | 2 +- docs/resources/namespace.md | 34 +++++++++++++++++++++++-------- docs/resources/service_account.md | 2 +- docs/resources/user_api_token.md | 6 +++--- 7 files changed, 79 insertions(+), 17 deletions(-) create mode 100644 docs/resources/app.md create mode 100644 docs/resources/dashboard.md diff --git a/docs/index.md b/docs/index.md index 7a5d802..ed76301 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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" diff --git a/docs/resources/app.md b/docs/resources/app.md new file mode 100644 index 0000000..3256b0d --- /dev/null +++ b/docs/resources/app.md @@ -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 + +### Required + +- `source` (String) The source text. + +### Read-Only + +- `id` (String) The ID of this resource. +- `uid` (String) The unique identifier. diff --git a/docs/resources/dashboard.md b/docs/resources/dashboard.md new file mode 100644 index 0000000..7decc50 --- /dev/null +++ b/docs/resources/dashboard.md @@ -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 + +### Required + +- `source_code` (String) The source code text. + +### Read-Only + +- `id` (String) The unique identifier. diff --git a/docs/resources/kv.md b/docs/resources/kv.md index e4dc244..47d7a84 100644 --- a/docs/resources/kv.md +++ b/docs/resources/kv.md @@ -8,7 +8,7 @@ description: |- # kestra_kv (Resource) -Manages a Kestra Namespace Key Value Store. +Manages a Kestra Namespace File. diff --git a/docs/resources/namespace.md b/docs/resources/namespace.md index e20e866..efca7ad 100644 --- a/docs/resources/namespace.md +++ b/docs/resources/namespace.md @@ -14,9 +14,9 @@ Manages a Kestra Namespace. ```terraform resource "kestra_namespace" "example" { - namespace_id = "company.team" - description = "Friendly description" - variables = < +### Nested Schema for `allowed_namespaces` + +Required: + +- `namespace` (String) The namespace. + + + +### 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: diff --git a/docs/resources/service_account.md b/docs/resources/service_account.md index f6fc1bb..e249417 100644 --- a/docs/resources/service_account.md +++ b/docs/resources/service_account.md @@ -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" } ``` diff --git a/docs/resources/user_api_token.md b/docs/resources/user_api_token.md index cb636a1..d79d1a3 100644 --- a/docs/resources/user_api_token.md +++ b/docs/resources/user_api_token.md @@ -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 } ```