Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
75 changes: 48 additions & 27 deletions content/docs/13.terraform/data-sources/namespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ title: kestra_namespace
editLink: false
description: |-
Use this data source to access information about an existing Kestra Namespace.
-> This resource is only available on the Enterprise Edition https://kestra.io/enterprise
-> Some attributes are only available on the Enterprise Edition https://kestra.io/enterprise
---

# kestra_namespace (Data Source)

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

::alert{type="info"}
This resource is only available on the [Enterprise Edition](https://kestra.io/enterprise)
Some attributes are only available on the [Enterprise Edition](https://kestra.io/enterprise)
::

## Example Usage
Expand All @@ -28,25 +28,26 @@ data "kestra_namespace" "example" {

### Required

- `namespace_id` (String) The namespace.
- `namespace_id` (String) The namespace id.

### Read-Only

- `allowed_namespaces` (List of Object) The allowed namespaces. (see [below for nested schema](#nestedatt--allowed_namespaces))
- `description` (String) The namespace friendly description.
- `id` (String) The ID of this resource.
- `outputs_in_internal_storage` (Boolean) Whether outputs are stored in internal storage.
- `plugin_defaults` (String) The namespace plugin defaults.
- `secret_configuration` (Map of String) The secret configuration.
- `secret_isolation` (List of Object) Secret isolation configuration (same shape as storage_isolation). (see [below for nested schema](#nestedatt--secret_isolation))
- `secret_read_only` (Boolean) Whether secrets are read-only in this namespace.
- `secret_type` (String) The secret type.
- `storage_configuration` (Map of String) The storage configuration.
- `storage_isolation` (List of Object) Storage isolation configuration. (see [below for nested schema](#nestedatt--storage_isolation))
- `storage_type` (String) The storage type.
- `concurrency` (List of Object) The concurrency limit applied to the executions of every flow of the namespace and its descendants: `limit` and `behavior`. (see [below for nested schema](#nestedatt--concurrency))
- `default_worker_selector` (List of Object) The default routing applied to every task of the namespace that does not define its own: `tags`, `match` and `fallback`. (see [below for nested schema](#nestedatt--default_worker_selector))
- `description` (String) The namespace description.
- `id` (String) The namespace id.
- `outputs_in_internal_storage` (Boolean) Whether the task outputs are stored in the internal storage.
- `quotas` (List of Object) The quotas evaluated before an execution starts: `duration`, `limit` and `behavior`. (see [below for nested schema](#nestedatt--quotas))
- `secret_configuration` (Dynamic) The namespace secret configuration.
- `secret_isolation` (List of Object) Secret isolation configuration: `enabled` and `denied_services`. (see [below for nested schema](#nestedatt--secret_isolation))
- `secret_read_only` (Boolean) Whether the namespace secret manager is read only.
- `secret_type` (String) The namespace secret type.
- `storage_configuration` (Map of String) The namespace storage configuration.
- `storage_isolation` (List of Object) Storage isolation configuration: `enabled` and `denied_services`. (see [below for nested schema](#nestedatt--storage_isolation))
- `storage_type` (String) The namespace storage type.
- `tenant_id` (String) The tenant id.
- `variables` (String) The namespace variables.
- `worker_group` (List of Object) The worker group. (see [below for nested schema](#nestedatt--worker_group))
- `variables` (String) The namespace variables, as YAML.

<a id="nestedatt--allowed_namespaces"></a>
### Nested Schema for `allowed_namespaces`
Expand All @@ -56,28 +57,48 @@ Read-Only:
- `namespace` (String)


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

Read-Only:

- `denied_services` (List of String)
- `enabled` (Boolean)
- `behavior` (String)
- `limit` (Number)


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

Read-Only:

- `fallback` (String)
- `match` (String)
- `tags` (Set of String)


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

Read-Only:

- `denied_services` (List of String)
- `behavior` (String)
- `duration` (String)
- `limit` (Number)


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

Read-Only:

- `denied_services` (Set of String)
- `enabled` (Boolean)


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

Read-Only:

- `fallback` (String)
- `key` (String)
- `denied_services` (Set of String)
- `enabled` (Boolean)
43 changes: 43 additions & 0 deletions content/docs/13.terraform/data-sources/policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
title: kestra_policy
editLink: false
description: |-
Reads a Kestra governance Policy (EE) at the INSTANCE, TENANT or NAMESPACE scope.
---

# kestra_policy (Data Source)

Reads a Kestra governance Policy (EE) at the `INSTANCE`, `TENANT` or `NAMESPACE` scope.

## Example Usage

```hcl
data "kestra_policy" "tenant" {
scope = "TENANT"
policy_id = "deny-shell-commands"
}

data "kestra_policy" "namespace" {
scope = "NAMESPACE"
namespace = "company.team"
policy_id = "require-owner-label"
}
```

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

### Required

- `policy_id` (String) The policy id.
- `scope` (String) The policy scope: `INSTANCE`, `TENANT` or `NAMESPACE`.

### Optional

- `namespace` (String) The namespace the policy is attached to. Required for the `NAMESPACE` scope.
- `tenant_id` (String) The tenant id, for `TENANT` and `NAMESPACE` scopes. Defaults to the provider tenant when omitted. Must not be set for the `INSTANCE` scope.

### Read-Only

- `content` (String) The policy YAML source.
8 changes: 4 additions & 4 deletions content/docs/13.terraform/data-sources/role.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,13 @@ data "kestra_role" "by_name" {

- `description` (String) The role description.
- `id` (String) The ID of this resource.
- `permissions` (Set of Object) The role permissions. (see [below for nested schema](#nestedatt--permissions))
- `resources` (Set of Object) The role resource permissions. (see [below for nested schema](#nestedatt--resources))
- `tenant_id` (String) The tenant id.

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

Read-Only:

- `permissions` (List of String)
- `actions` (List of String)
- `type` (String)
58 changes: 40 additions & 18 deletions content/docs/13.terraform/data-sources/tenant.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ title: kestra_tenant
editLink: false
description: |-
Use this data source to access information about an existing Kestra Tenant.
-> This resource is only available on the Enterprise Edition https://kestra.io/enterprise
-> This data source is only available on the Enterprise Edition https://kestra.io/enterprise
---

# kestra_tenant (Data Source)

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

::alert{type="info"}
This resource is only available on the [Enterprise Edition](https://kestra.io/enterprise)
This data source is only available on the [Enterprise Edition](https://kestra.io/enterprise)
::

## Example Usage
Expand All @@ -32,41 +32,63 @@ data "kestra_tenant" "example" {

### Read-Only

- `id` (String) The ID of this resource.
- `concurrency` (List of Object) The concurrency limit applied to the executions of every flow of the tenant: `limit` and `behavior`. (see [below for nested schema](#nestedatt--concurrency))
- `default_worker_selector` (List of Object) The default routing applied to every task of the tenant that does not define its own: `tags`, `match` and `fallback`. (see [below for nested schema](#nestedatt--default_worker_selector))
- `id` (String) The tenant id.
- `name` (String) The tenant name.
- `outputs_in_internal_storage` (Boolean) Whether outputs are stored in internal storage.
- `require_existing_namespace` (Boolean) Whether the tenant requires existing namespaces.
- `quotas` (List of Object) The quotas evaluated before an execution starts: `duration`, `limit` and `behavior`. (see [below for nested schema](#nestedatt--quotas))
- `require_existing_namespace` (Boolean) Whether tenant requires an existing namespace.
- `secret_configuration` (Map of String) The secret configuration.
- `secret_isolation` (List of Object) Secret isolation configuration (same shape as storage_isolation). (see [below for nested schema](#nestedatt--secret_isolation))
- `secret_isolation` (List of Object) Secret isolation configuration: `enabled` and `denied_services`. (see [below for nested schema](#nestedatt--secret_isolation))
- `secret_read_only` (Boolean) Whether secrets are read-only in this tenant.
- `secret_type` (String) The secret type.
- `storage_configuration` (Map of String) The storage configuration.
- `storage_isolation` (List of Object) Storage isolation configuration. (see [below for nested schema](#nestedatt--storage_isolation))
- `storage_isolation` (List of Object) Storage isolation configuration: `enabled` and `denied_services`. (see [below for nested schema](#nestedatt--storage_isolation))
- `storage_type` (String) The storage type.
- `worker_group` (List of Object) The worker group. (see [below for nested schema](#nestedatt--worker_group))

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

Read-Only:

- `denied_services` (List of String)
- `enabled` (Boolean)
- `behavior` (String)
- `limit` (Number)


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

Read-Only:

- `fallback` (String)
- `match` (String)
- `tags` (Set of String)


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

Read-Only:

- `denied_services` (List of String)
- `behavior` (String)
- `duration` (String)
- `limit` (Number)


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

Read-Only:

- `denied_services` (Set of String)
- `enabled` (Boolean)


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

Read-Only:

- `fallback` (String)
- `key` (String)
- `denied_services` (Set of String)
- `enabled` (Boolean)
26 changes: 21 additions & 5 deletions content/docs/13.terraform/data-sources/worker_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,44 @@ title: kestra_worker_group
editLink: false
description: |-
Use this data source to access information about an existing Kestra Worker Group.
-> This resource is only available on the Enterprise Edition https://kestra.io/enterprise
-> This data source is only available on the Enterprise Edition https://kestra.io/enterprise
---

# kestra_worker_group (Data Source)

Use this data source to access information about an existing Kestra Worker Group.

::alert{type="info"}
This resource is only available on the [Enterprise Edition](https://kestra.io/enterprise)
This data source is only available on the [Enterprise Edition](https://kestra.io/enterprise)
::

## Example Usage

```hcl
data "kestra_worker_group" "example" {
group_id = "gpu-workers"
}
```

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

### Required

- `id` (String) The worker group id.
- `key` (String) The worker group key.
- `group_id` (String) The worker group identifier.

### Read-Only

- `allowed_tenants` (String) The list of tenants allowed to use the worker group.
- `description` (String) The worker group description.
- `id` (String) The worker group id.
- `name` (String) The worker group display name.
- `subscriptions` (List of Object) The Worker Queue subscriptions of the worker group: `worker_queue_id` (`default` for the global default queue), `reserved_percent` (`-1` means no reservation), and `mode` (`STRICT` or `ELASTIC`). (see [below for nested schema](#nestedatt--subscriptions))

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

Read-Only:

- `mode` (String)
- `reserved_percent` (Number)
- `worker_queue_id` (String)
39 changes: 39 additions & 0 deletions content/docs/13.terraform/data-sources/worker_queue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
title: kestra_worker_queue
editLink: false
description: |-
Use this data source to access information about an existing Kestra Worker Queue.
-> This data source is only available on the Enterprise Edition https://kestra.io/enterprise
---

# kestra_worker_queue (Data Source)

Use this data source to access information about an existing Kestra Worker Queue.

::alert{type="info"}
This data source is only available on the [Enterprise Edition](https://kestra.io/enterprise)
::

## Example Usage

```hcl
data "kestra_worker_queue" "example" {
queue_id = "gpu-queue"
}
```

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

### Required

- `queue_id` (String) The Worker Queue identifier.

### Read-Only

- `allowed_tenants` (Set of String) The tenants allowed to use the Worker Queue. Empty means unrestricted.
- `description` (String) The Worker Queue description.
- `id` (String) The Worker Queue id.
- `name` (String) The Worker Queue human-readable name.
- `tags` (Set of String) The canonical tag set of the Worker Queue.
Loading
Loading