Skip to content

Commit

Permalink
[WIP] RBAC (#659)
Browse files Browse the repository at this point in the history
* first version

* docs: add structure to RBAC docs

* Update index.md

* docs: fixes

* small fixes and screenshots

* --tenant-admin is not really needed

* fixes based on the last meeting

* docs: adjust RBAC

* Update 02.admins.md

* fix instance admin
  • Loading branch information
anna-geller authored Dec 13, 2023
1 parent 4fc9daa commit 1e17665
Show file tree
Hide file tree
Showing 31 changed files with 552 additions and 111 deletions.
File renamed without changes.
2 changes: 1 addition & 1 deletion content/docs/02.tutorial/03.outputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Outputs
---

Tasks can generate outputs, which can be passed to downstream tasks. These outputs can be variables or files stored in [internal storage](../08.architecture.md#the-internal-storage).
Tasks can generate outputs, which can be passed to downstream tasks. These outputs can be variables or files stored in [internal storage](../01.architecture.md#the-internal-storage).

## How to retrieve outputs

Expand Down
10 changes: 5 additions & 5 deletions content/docs/03.concepts/01.flows.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ There are two kinds of tasks in Kestra:

### Runnable Task

[Runnable Tasks](../05.developer-guide/02.tasks.md#runnable-tasks) handle computational work in the flow. For example, file system operations, API calls, database queries, etc. These tasks can be compute-intensive and are handled by [workers](../08.architecture.md#worker).
[Runnable Tasks](../05.developer-guide/02.tasks.md#runnable-tasks) handle computational work in the flow. For example, file system operations, API calls, database queries, etc. These tasks can be compute-intensive and are handled by [workers](../01.architecture.md#worker).

By default, Kestra only includes a few Runnable Tasks. However, many of them are available as [plugins](../../plugins/index.md), and if you use our default Docker image, plenty of them will already be included.

Expand All @@ -27,7 +27,7 @@ By default, Kestra only includes a few Runnable Tasks. However, many of them are

[Flowable Tasks](../05.developer-guide/02.tasks.md#flowable-tasks) only handle flow logic (branching, grouping, parallel processing, etc.) and start new tasks. For example, the Switch task decides the next task to run based on some inputs.

A Flowable Task is handled by [executors](../08.architecture.md#executor) and can be called very often. Because of that, these tasks cannot include intensive computations, unlike Runnable Tasks. Most of the common Flowable Tasks are available in the default Kestra installation.
A Flowable Task is handled by [executors](../01.architecture.md#executor) and can be called very often. Because of that, these tasks cannot include intensive computations, unlike Runnable Tasks. Most of the common Flowable Tasks are available in the default Kestra installation.


## Namespace
Expand Down Expand Up @@ -60,17 +60,17 @@ The inputs can be declared as either optional or mandatory. If the flow has requ

Inputs can have [validation rules](../05.developer-guide/04.inputs.md#input-validation) that are enforced at execution time.

Inputs of type `FILE` will be uploaded to Kestra's [internal storage](../08.architecture.md#the-internal-storage) and made available for all tasks.
Inputs of type `FILE` will be uploaded to Kestra's [internal storage](../01.architecture.md#the-internal-storage) and made available for all tasks.

Flow inputs can be seen in the **Overview** tab of the **Execution** page.

## Outputs

Each task can produce an output that may contain multiple properties. This output is described in the plugin documentation task and can then be accessible by all the following tasks via [variables](../05.developer-guide/03.variables/02.basic-usage.md).

Some outputs are of a special type and will be stored inside Kestra's [internal storage](../08.architecture.md#the-internal-storage). Successive tasks may still use them as Kestra will automatically make them available for all tasks.
Some outputs are of a special type and will be stored inside Kestra's [internal storage](../01.architecture.md#the-internal-storage). Successive tasks may still use them as Kestra will automatically make them available for all tasks.

Tasks outputs can be seen in the **Outputs** tab of the **Execution** page. If an output is a file from the [internal storage](../08.architecture.md#the-internal-storage), it will be available to download.
Tasks outputs can be seen in the **Outputs** tab of the **Execution** page. If an output is a file from the [internal storage](../01.architecture.md#the-internal-storage), it will be available to download.


## Revision
Expand Down
2 changes: 1 addition & 1 deletion content/docs/03.concepts/02.executions.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ If retries have been configured, a task failure will generate new attempts until

Each task can generate output data that other tasks of the current flow execution can use.

These outputs can be variables or files that will be stored inside Kestra's [internal storage](../08.architecture.md#the-internal-storage).
These outputs can be variables or files that will be stored inside Kestra's [internal storage](../01.architecture.md#the-internal-storage).

Outputs are described on each task documentation page and can be seen in the **Outputs** tab of the **Execution** page.

Expand Down
8 changes: 4 additions & 4 deletions content/docs/05.developer-guide/02.tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Tasks

In Kestra, workloads are done using **Runnable Tasks**.

Runnable Tasks handle computational work in the flow. For example, file system operations, API calls, database queries, etc. These tasks can be compute-intensive and are handled by [workers](../08.architecture.md#worker).
Runnable Tasks handle computational work in the flow. For example, file system operations, API calls, database queries, etc. These tasks can be compute-intensive and are handled by [workers](../01.architecture.md#worker).

Each task must have an identifier (id) and a type. The type is the task's Java Fully Qualified Class Name (FQCN).

Expand All @@ -28,7 +28,7 @@ The following task properties can be set.
|`retry`| Task retry behavior, more details [here](./07.errors-handling.md#retries). |
|`timeout`| Task timeout expressed in [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations). |
|`disabled`| Set it to `true` to disable execution of the task. |
|`workerGroup.key`|To execute this task on a specific [Worker Group (EE)](../08.architecture.md#worker-group-ee).|
|`workerGroup.key`|To execute this task on a specific [Worker Group (EE)](../01.architecture.md#worker-group-ee).|
|`logLevel`| To define the log level granularity for which logs will be inserted into the backend database. By default, all logs are stored. However, if you restrict that to e.g., the `INFO` level, all lower log levels such as `DEBUG` and TRACE won't be persisted. |

Task properties can be static or dynamic. Dynamic task properties can be set using [variables](./03.variables/01.index.md). To know if a task property is dynamic, read the task's documentation.
Expand Down Expand Up @@ -278,7 +278,7 @@ Syntax:
key: value
```

This will execute the subflow `dev.subflow` for each batch of items.
This will execute the subflow `dev.subflow` for each batch of items.
To pass the batch of items to a subflow, you can use [inputs](../04.inputs.md). The example above uses an input of `FILE` type called `file` that takes the URI of an internal storage file containing the batch of items.

::next-link
Expand Down Expand Up @@ -529,7 +529,7 @@ tasks:
type: io.kestra.core.tasks.flows.WorkingDirectory
namespaceFiles:
enabled: true
include:
include:
- dir1/*.*
exclude:
- dir2/*.*
Expand Down
Loading

0 comments on commit 1e17665

Please sign in to comment.