diff --git a/blog/2023-11-21-dedicated-workers/index.mdx b/blog/2023-11-21-dedicated-workers/index.mdx index d7b7a7158..7cb628006 100644 --- a/blog/2023-11-21-dedicated-workers/index.mdx +++ b/blog/2023-11-21-dedicated-workers/index.mdx @@ -88,8 +88,8 @@ Flows steps that use scripts with a dedicated worker already benefit from the sp href="/docs/misc/worker_group_management_ui" /> diff --git a/blog/2023-11-21-workers-group/index.mdx b/blog/2023-11-21-workers-group/index.mdx index d99ac6893..4b0c7d189 100644 --- a/blog/2023-11-21-workers-group/index.mdx +++ b/blog/2023-11-21-workers-group/index.mdx @@ -117,8 +117,8 @@ This approach offers added convenience to pre-install binaries or set initial co Init Script @@ -126,8 +126,8 @@ This approach offers added convenience to pre-install binaries or set initial co
@@ -174,8 +174,8 @@ You can then configure it directly from the UI and in particular set tags to lis href="/docs/misc/worker_group_management_ui" /> diff --git a/changelog/2024-05-15-concurrency-limit-observability/index.md b/changelog/2024-05-15-concurrency-limit-observability/index.md index fa3c6d5dd..a702bff80 100644 --- a/changelog/2024-05-15-concurrency-limit-observability/index.md +++ b/changelog/2024-05-15-concurrency-limit-observability/index.md @@ -1,7 +1,7 @@ --- slug: concurrency-limit-observability version: v1.331.0 -title: Concurrency Limit Observability +title: Concurrency limit observability tags: ['Concurrency limits', 'Script editor', 'Flow editor'] image: ./concurrent_runs.png description: Obversability around concurrent jobs has been improved from the Runs menu. diff --git a/docs/advanced/10_browser_automation/index.mdx b/docs/advanced/10_browser_automation/index.mdx index 525ab7d4b..1e2af2430 100644 --- a/docs/advanced/10_browser_automation/index.mdx +++ b/docs/advanced/10_browser_automation/index.mdx @@ -20,8 +20,7 @@ Running chromium without the sandbox is a security risk. Make sure you trust the ::: To run jobs on a chromium-equipped worker, you have to select the `chromium` tag in the settings of the script or flow step. -[Learn how here](/docs/script_editor/worker_group_tag). - +[Learn how here](../../core_concepts/9_worker_groups/index.mdx). ## Examples diff --git a/docs/advanced/8_preinstall_binaries/index.mdx b/docs/advanced/8_preinstall_binaries/index.mdx index 9ae132d90..4509d3b68 100644 --- a/docs/advanced/8_preinstall_binaries/index.mdx +++ b/docs/advanced/8_preinstall_binaries/index.mdx @@ -6,7 +6,7 @@ import DocCard from '@site/src/components/DocCard'; :::tip Init scripts -For an efficient way to preinstall binaries without the need to modify the base image, see [Init Scripts](#init-scripts). +For an efficient way to preinstall binaries without the need to modify the base image, see [Init scripts](#init-scripts). ::: @@ -85,18 +85,18 @@ FROM ${WM_IMAGE} [...] ``` -## Init Scripts +## Init scripts Init scripts provide a method to pre-install binaries or set initial configurations without the need to modify the base image. This approach offers added convenience. -Init Scripts are executed at the beginning when the worker starts, ensuring that any necessary binaries or configurations are set up before the worker undertakes any other job. +Init scripts are executed at the beginning when the worker starts, ensuring that any necessary binaries or configurations are set up before the worker undertakes any other job. Init scripts are available only on [self-hosting and enterprise edition](/pricing) on private clusters.
Init Scripts Infographics
@@ -107,7 +107,7 @@ Any scripts are set from the [Worker Management UI](../../misc/11_worker_group_m When adjustments are made in the [Worker Management UI](../../misc/11_worker_group_management_ui/index.mdx), the workers will shut down and are expected to be restarted by their supervisor (Docker or k8s). -The execution of Init Scripts is inspectable in the superadmin workspace, with `Kind = All` filter. The path of those executions are `init_script_{worker_name}`. +The execution of Init scripts is inspectable in the superadmin workspace, with `Kind = All` filter. The path of those executions are `init_script_{worker_name}`. ![Worker Group edit config](../../core_concepts/9_worker_groups/worker_group_ui.png.webp) diff --git a/docs/code_editor/index.mdx b/docs/code_editor/index.mdx index 78d810002..c1f132c28 100644 --- a/docs/code_editor/index.mdx +++ b/docs/code_editor/index.mdx @@ -8,7 +8,7 @@ The code editor is the main component for building scripts in Windmill's script Code editor in [Scripts](../script_editor/index.mdx): -![Script languages](../../static/images/script_languages.png.webp 'Script languages') +![Script languages](../../static/images/script_languages.png 'Script languages') Code editor in [Flows](../flows/1_flow_editor.mdx): diff --git a/docs/compared_to/prefect.mdx b/docs/compared_to/prefect.mdx index 765ecc89e..b7788214c 100644 --- a/docs/compared_to/prefect.mdx +++ b/docs/compared_to/prefect.mdx @@ -432,7 +432,7 @@ This document has focused on the Flow editor since it is the product closest to The [script editor](../script_editor/index.mdx) allows users to build long-running heavy background jobs, script with complex dependencies, endpoints with high rpm or simple one-off tasks without any overhead. They can be triggered them from a webhook, auto-generated UIs, flows, apps etc. -![Script languages](../../static/images/script_languages.png.webp 'Script languages') +![Script languages](../../static/images/script_languages.png 'Script languages')
diff --git a/docs/core_concepts/21_concurrency_limits/index.md b/docs/core_concepts/21_concurrency_limits/index.md index 65c156b61..2bbcf5610 100644 --- a/docs/core_concepts/21_concurrency_limits/index.md +++ b/docs/core_concepts/21_concurrency_limits/index.md @@ -6,7 +6,7 @@ Concurrency limit is a [Cloud plans and Pro Enterprise Self-Hosted](/pricing) on Concurrency limit can be set from the Settings menu. When jobs reach the concurrency limit, they are automatically queued for execution at the next available optimal slot given the time window. -The Concurrency Limit operates globally and across flow runs. It involves three key parameters: +The Concurrency limit operates globally and across flow runs. It involves three key parameters: ## Max number of executions within the time window @@ -28,7 +28,7 @@ Jobs can be filtered from the [Runs menu](../5_monitor_past_and_future_runs/inde [Concurrency limit of a script](../../script_editor/concurrency_limit.mdx) can be set from the Settings menu. Pick "Concurrency" and define a time window, max number of executions of the flow within that time window and optionally a custom concurrency key. -![Concurrency Limit](../../assets/code_editor/concurrency_limit.png.webp) +![Concurrency limit](../../assets/code_editor/concurrency_limit.png.webp) ### Concurrency limit of flow @@ -38,8 +38,8 @@ From the Flow Settings menu, pick "Concurrency" and define a time window, a max ### Concurrency limit of scripts within flow -The Concurrency Limit operates globally and across flow runs. It involves two key parameters: "Maximum number of runs" and the "Per time window (seconds)." +The Concurrency limit operates globally and across flow runs. It involves two key parameters: "Maximum number of runs" and the "Per time window (seconds)." Concurrency limit can be set for each step of a flow in the `Advanced` menu, on tab "Concurrency". -![Concurrency Limit Scripts within Flow](../../assets/code_editor/concurrency_limit_flow.png.webp "Concurrency Limit Scripts within Flow") \ No newline at end of file +![Concurrency limit Scripts within Flow](../../assets/code_editor/concurrency_limit_flow.png.webp "Concurrency limit Scripts within Flow") \ No newline at end of file diff --git a/docs/core_concepts/4_webhooks/index.mdx b/docs/core_concepts/4_webhooks/index.mdx index 6617ee82d..5ef5b4fed 100644 --- a/docs/core_concepts/4_webhooks/index.mdx +++ b/docs/core_concepts/4_webhooks/index.mdx @@ -329,6 +329,20 @@ Windmill does not support batching cloud events yet. This means that requests wi Learn more about what Cloud Events are [here](https://cloudevents.io/). +### Delete after use + +For a script, delete [logs](../14_audit_logs/index.mdx), arguments and results after use. + +:::warning + +This settings ONLY applies to [synchronous](#synchronous) webhooks. If used individually, this script must be triggered using a synchronous endpoint to have the desired effect. +
+The logs, arguments and results of the job will be completely deleted from Windmill once it is complete and the result has been returned. +
+The deletion is irreversible. + +::: + ## Workspace Webhook Connect your Windmill workspace to an external service to sync or get notified about any change. diff --git a/docs/core_concepts/9_worker_groups/index.mdx b/docs/core_concepts/9_worker_groups/index.mdx index 7cfcc9c3f..38ebbfc9a 100644 --- a/docs/core_concepts/9_worker_groups/index.mdx +++ b/docs/core_concepts/9_worker_groups/index.mdx @@ -22,7 +22,7 @@ In the [Community Edition](/pricing), worker management is done using tags that
@@ -34,7 +34,7 @@ In the [Cloud plans & Self-Hosted Enterprise Edition](/pricing), workers can be
@@ -257,15 +257,15 @@ Examples of configurations include: ## Init scripts -[Init scripts](../../advanced/8_preinstall_binaries/index.mdx#init-scripts) provide a method to pre-install binaries or set initial configurations without the need to modify the base image. This approach offers added convenience. Init Scripts are executed at the beginning when the worker starts, ensuring that any necessary binaries or configurations are set up before the worker undertakes any other job. +[Init scripts](../../advanced/8_preinstall_binaries/index.mdx#init-scripts) provide a method to pre-install binaries or set initial configurations without the need to modify the base image. This approach offers added convenience. Init scripts are executed at the beginning when the worker starts, ensuring that any necessary binaries or configurations are set up before the worker undertakes any other job. Under the [Cloud plans & Self-Hosted Enterprise Edition](/pricing), they can be set from Windmill UI.
Init Scripts Infographics
@@ -274,8 +274,8 @@ Under the [Cloud plans & Self-Hosted Enterprise Edition](/pricing), they can be
diff --git a/docs/core_concepts/index.mdx b/docs/core_concepts/index.mdx index e08bb41ec..d43c7baf8 100644 --- a/docs/core_concepts/index.mdx +++ b/docs/core_concepts/index.mdx @@ -275,7 +275,7 @@ All details on Scripts can be found in the [Script section](../script_editor/ind
@@ -290,13 +290,8 @@ All details on Scripts can be found in the [Script section](../script_editor/ind href="/docs/core_concepts/versioning#script-versioning" /> - @@ -599,4 +594,19 @@ All details & features on [Pricing page](/pricing). description="The Windmill React SDK provides a suite of tools and components to integrate Windmill applications into React-based projects." href="/docs/misc/react_sdk" /> + + +
diff --git a/docs/flows/11_flow_approval.mdx b/docs/flows/11_flow_approval.mdx index 04fe2e384..a4d1112b9 100644 --- a/docs/flows/11_flow_approval.mdx +++ b/docs/flows/11_flow_approval.mdx @@ -42,7 +42,7 @@ The approval steps are received in the form of an HTTP request. For each event,
diff --git a/docs/flows/1_flow_editor.mdx b/docs/flows/1_flow_editor.mdx index 02952b3d0..132017c32 100644 --- a/docs/flows/1_flow_editor.mdx +++ b/docs/flows/1_flow_editor.mdx @@ -126,7 +126,7 @@ The Flow editor has the following features which are the subject of specific pag diff --git a/docs/flows/3_editor_components.mdx b/docs/flows/3_editor_components.mdx index 38f8f3be7..8918ffacd 100644 --- a/docs/flows/3_editor_components.mdx +++ b/docs/flows/3_editor_components.mdx @@ -466,14 +466,14 @@ The advanced section allows to configure the following: /> diff --git a/docs/getting_started/0_scripts_quickstart/2_python_quickstart/create_script_python.png b/docs/getting_started/0_scripts_quickstart/2_python_quickstart/create_script_python.png deleted file mode 100644 index 34872d241..000000000 Binary files a/docs/getting_started/0_scripts_quickstart/2_python_quickstart/create_script_python.png and /dev/null differ diff --git a/docs/getting_started/0_scripts_quickstart/2_python_quickstart/create_script_python.png.webp b/docs/getting_started/0_scripts_quickstart/2_python_quickstart/create_script_python.png.webp deleted file mode 100644 index b0a6ee945..000000000 Binary files a/docs/getting_started/0_scripts_quickstart/2_python_quickstart/create_script_python.png.webp and /dev/null differ diff --git a/docs/getting_started/0_scripts_quickstart/2_python_quickstart/index.mdx b/docs/getting_started/0_scripts_quickstart/2_python_quickstart/index.mdx index 7a8d4a94c..27a8a7c93 100644 --- a/docs/getting_started/0_scripts_quickstart/2_python_quickstart/index.mdx +++ b/docs/getting_started/0_scripts_quickstart/2_python_quickstart/index.mdx @@ -77,9 +77,9 @@ first step of script creation: Metadata. ## Settings -![New script](./create_script_python.png.webp) +![New script](../../../../static/images/script_languages.png "New script") -As part of the settings menu, each script has metadata associated with it, enabling it to be defined and configured in depth. +As part of the [settings](../../../script_editor/settings.mdx) menu, each script has metadata associated with it, enabling it to be defined and configured in depth. - **Path** is the Script's unique identifier that consists of the [script's owner](../../../core_concepts/16_roles_and_permissions/index.mdx), and the script's name. @@ -92,12 +92,7 @@ As part of the settings menu, each script has metadata associated with it, enabl to users on how to run your Script. It supports markdown. - **Script kind**: Action (by default), [Trigger](../../../flows/10_flow_trigger.mdx), [Approval](../../../flows/11_flow_approval.mdx) or [Error handler](../../../flows/7_flow_error_handler.md). This acts as a tag to filter appropriate scripts from the [flow editor](../../6_flows_quickstart/index.mdx). -This menu also has additional settings, such as: - -- **[Concurrency limits](../../../script_editor/concurrency_limit.mdx)** enable defining concurrency limits for scripts and inline scripts within flows to prevent exceeding the API Limit of the targeted API. -- **[Worker group tag](../../../core_concepts/9_worker_groups/index.mdx)** to assign scripts to specific worker groups (such as nodes with GPU accelaration). -- **[Cache](../../../core_concepts/24_caching/index.md)** to cache the results for each possible inputs for a given time. -- **[Dedicated Workers](../../../core_concepts/25_dedicated_workers/index.mdx)** to run the script on, to run the script at native speed. Only available on [Cloud plans and Self-Hosted Enterprise edition](/pricing) and with Python and TypeScript. +This menu also has additional settings on [Runtime](../../../script_editor/settings.mdx#runtime), [Generated UI](#triggers) and [Triggers](../../../script_editor/settings.mdx#triggers).
diff --git a/docs/getting_started/0_scripts_quickstart/3_go_quickstart/create_script_go.png b/docs/getting_started/0_scripts_quickstart/3_go_quickstart/create_script_go.png deleted file mode 100644 index e4063ab47..000000000 Binary files a/docs/getting_started/0_scripts_quickstart/3_go_quickstart/create_script_go.png and /dev/null differ diff --git a/docs/getting_started/0_scripts_quickstart/3_go_quickstart/create_script_go.png.webp b/docs/getting_started/0_scripts_quickstart/3_go_quickstart/create_script_go.png.webp deleted file mode 100644 index f888ebc65..000000000 Binary files a/docs/getting_started/0_scripts_quickstart/3_go_quickstart/create_script_go.png.webp and /dev/null differ diff --git a/docs/getting_started/0_scripts_quickstart/3_go_quickstart/index.mdx b/docs/getting_started/0_scripts_quickstart/3_go_quickstart/index.mdx index 31979f50f..945d849c5 100644 --- a/docs/getting_started/0_scripts_quickstart/3_go_quickstart/index.mdx +++ b/docs/getting_started/0_scripts_quickstart/3_go_quickstart/index.mdx @@ -84,9 +84,9 @@ first step of script creation: Metadata. ## Settings -![New script](./create_script_go.png.webp) +![New script](../../../../static/images/script_languages.png "New script") -As part of the settings menu, each script has metadata associated with it, enabling it to be defined and configured in depth. +As part of the [settings](../../../script_editor/settings.mdx) menu, each script has metadata associated with it, enabling it to be defined and configured in depth. - **Path** is the Script's unique identifier that consists of the [script's owner](../../../core_concepts/16_roles_and_permissions/index.mdx), and the script's name. @@ -99,12 +99,7 @@ As part of the settings menu, each script has metadata associated with it, enabl to users on how to run your Script. It supports markdown. - **Script kind**: Action (by default), [Trigger](../../../flows/10_flow_trigger.mdx), [Approval](../../../flows/11_flow_approval.mdx) or [Error handler](../../../flows/7_flow_error_handler.md). This acts as a tag to filter appropriate scripts from the [flow editor](../../6_flows_quickstart/index.mdx). -This menu also has additional settings, such as: - -- **[Concurrency limits](../../../script_editor/concurrency_limit.mdx)** enable defining concurrency limits for scripts and inline scripts within flows to prevent exceeding the API Limit of the targeted API. -- **[Worker group tag](../../../core_concepts/9_worker_groups/index.mdx)** to assign scripts to specific worker groups (such as nodes with GPU acceleration). -- **[Cache](../../../core_concepts/24_caching/index.md)** to cache the results for each possible inputs for a given time. -- **[Dedicated Workers](../../../core_concepts/25_dedicated_workers/index.mdx)** to run the script on, to run the script at native speed. Only available on [Cloud plans and Self-Hosted Enterprise edition](/pricing) and with Python and TypeScript. +This menu also has additional settings on [Runtime](../../../script_editor/settings.mdx#runtime), [Generated UI](#triggers) and [Triggers](../../../script_editor/settings.mdx#triggers).
diff --git a/docs/getting_started/0_scripts_quickstart/4_bash_quickstart/create_script_bash.png b/docs/getting_started/0_scripts_quickstart/4_bash_quickstart/create_script_bash.png deleted file mode 100644 index d4fe92291..000000000 Binary files a/docs/getting_started/0_scripts_quickstart/4_bash_quickstart/create_script_bash.png and /dev/null differ diff --git a/docs/getting_started/0_scripts_quickstart/4_bash_quickstart/create_script_bash.png.webp b/docs/getting_started/0_scripts_quickstart/4_bash_quickstart/create_script_bash.png.webp deleted file mode 100644 index 319df4f71..000000000 Binary files a/docs/getting_started/0_scripts_quickstart/4_bash_quickstart/create_script_bash.png.webp and /dev/null differ diff --git a/docs/getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx b/docs/getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx index d5f198455..b5c5b6282 100644 --- a/docs/getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx +++ b/docs/getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx @@ -97,9 +97,9 @@ first step of script creation: Metadata. ## Settings -![New script](./create_script_bash.png.webp) +![New script](../../../../static/images/script_languages.png "New script") -As part of the settings menu, each script has metadata associated with it, enabling it to be defined and configured in depth. +As part of the [settings](../../../script_editor/settings.mdx) menu, each script has metadata associated with it, enabling it to be defined and configured in depth. - **Path** is the Script's unique identifier that consists of the [script's owner](../../../core_concepts/16_roles_and_permissions/index.mdx), and the script's name. @@ -112,12 +112,7 @@ As part of the settings menu, each script has metadata associated with it, enabl to users on how to run your Script. It supports markdown. - **Script kind**: Action (by default), [Trigger](../../../flows/10_flow_trigger.mdx), [Approval](../../../flows/11_flow_approval.mdx) or [Error handler](../../../flows/7_flow_error_handler.md). This acts as a tag to filter appropriate scripts from the [flow editor](../../6_flows_quickstart/index.mdx). -This menu also has additional settings, such as: - -- **[Concurrency limits](../../../script_editor/concurrency_limit.mdx)** enable defining concurrency limits for scripts and inline scripts within flows to prevent exceeding the API Limit of the targeted API. -- **[Worker group tag](../../../core_concepts/9_worker_groups/index.mdx)** to assign scripts to specific worker groups (such as nodes with GPU acceleration). -- **[Cache](../../../core_concepts/24_caching/index.md)** to cache the results for each possible inputs for a given time. -- **[Dedicated Workers](../../../core_concepts/25_dedicated_workers/index.mdx)** to run the script on, to run the script at native speed. Only available on [Cloud plans and Self-Hosted Enterprise edition](/pricing) and with Python and TypeScript. +This menu also has additional settings on [Runtime](../../../script_editor/settings.mdx#runtime), [Generated UI](#triggers) and [Triggers](../../../script_editor/settings.mdx#triggers).
diff --git a/docs/getting_started/0_scripts_quickstart/5_sql_quickstart/index.mdx b/docs/getting_started/0_scripts_quickstart/5_sql_quickstart/index.mdx index 15d7d810a..0e21b150a 100644 --- a/docs/getting_started/0_scripts_quickstart/5_sql_quickstart/index.mdx +++ b/docs/getting_started/0_scripts_quickstart/5_sql_quickstart/index.mdx @@ -806,7 +806,7 @@ And so on for [MS SQL](#ms-sql), [BigQuery](#bigquery) and [Snowflake](#snowflak After you're done, click on "[Deploy](../../../core_concepts/0_draft_and_deploy/index.mdx)", which will save it to your workspace. You can now use this Script in your [Flows](../../../flows/1_flow_editor.mdx), [app](../../../apps/0_app_editor/index.mdx) or as standalone. Feel free to customize your script's metadata ([path](../../../core_concepts/16_roles_and_permissions/index.mdx#path), name, description), -runtime ([concurrency limits](../../../script_editor/concurrency_limit.mdx), [worker group](../../../script_editor/worker_group_tag.mdx), +runtime ([concurrency limits](../../../script_editor/concurrency_limit.mdx), [worker group](../../../script_editor/settings.mdx#worker-group-tag), [cache](../../../core_concepts/24_caching/index.md), [dedicated workers](../../../core_concepts/25_dedicated_workers/index.mdx)) and [generated UI](../../../script_editor/customize_ui.mdx). ![Customize SQL](./customize_sql.png 'Customize SQL') diff --git a/docs/getting_started/0_scripts_quickstart/6_rest_grapqhql_quickstart/create_script_rest.png b/docs/getting_started/0_scripts_quickstart/6_rest_grapqhql_quickstart/create_script_rest.png deleted file mode 100644 index be352c799..000000000 Binary files a/docs/getting_started/0_scripts_quickstart/6_rest_grapqhql_quickstart/create_script_rest.png and /dev/null differ diff --git a/docs/getting_started/0_scripts_quickstart/6_rest_grapqhql_quickstart/create_script_rest.png.webp b/docs/getting_started/0_scripts_quickstart/6_rest_grapqhql_quickstart/create_script_rest.png.webp deleted file mode 100644 index 6d326b84c..000000000 Binary files a/docs/getting_started/0_scripts_quickstart/6_rest_grapqhql_quickstart/create_script_rest.png.webp and /dev/null differ diff --git a/docs/getting_started/0_scripts_quickstart/6_rest_grapqhql_quickstart/index.mdx b/docs/getting_started/0_scripts_quickstart/6_rest_grapqhql_quickstart/index.mdx index a42005fb8..95e61d8b6 100644 --- a/docs/getting_started/0_scripts_quickstart/6_rest_grapqhql_quickstart/index.mdx +++ b/docs/getting_started/0_scripts_quickstart/6_rest_grapqhql_quickstart/index.mdx @@ -67,9 +67,9 @@ export async function main() { ## Settings -![New script](./create_script_rest.png.webp) +![New script](../../../../static/images/script_languages.png "New script") -As part of the settings menu, each script has metadata associated with it, enabling it to be defined and configured in depth. +As part of the [settings](../../../script_editor/settings.mdx) menu, each script has metadata associated with it, enabling it to be defined and configured in depth. - **Path** is the Script's unique identifier that consists of the [script's owner](../../../core_concepts/16_roles_and_permissions/index.mdx), and the script's name. @@ -82,12 +82,7 @@ As part of the settings menu, each script has metadata associated with it, enabl to users on how to run your Script. It supports markdown. - **Script kind**: Action (by default), [Trigger](../../../flows/10_flow_trigger.mdx), [Approval](../../../flows/11_flow_approval.mdx) or [Error handler](../../../flows/7_flow_error_handler.md). This acts as a tag to filter appropriate scripts from the [flow editor](../../6_flows_quickstart/index.mdx). -This menu also has additional settings, such as: - -- **[Concurrency limits](../../../script_editor/concurrency_limit.mdx)** enable defining concurrency limits for scripts and inline scripts within flows to prevent exceeding the API Limit of the targeted API. -- **[Worker group tag](../../../core_concepts/9_worker_groups/index.mdx)** to assign scripts to specific worker groups (such as nodes with GPU acceleration). -- **[Cache](../../../core_concepts/24_caching/index.md)** to cache the results for each possible inputs for a given time. -- **[Dedicated Workers](../../../core_concepts/25_dedicated_workers/index.mdx)** to run the script on, to run the script at native speed. Only available on [Cloud plans and Self-Hosted Enterprise edition](/pricing) and with Python and TypeScript. +This menu also has additional settings on [Runtime](../../../script_editor/settings.mdx#runtime), [Generated UI](#triggers) and [Triggers](../../../script_editor/settings.mdx#triggers).
diff --git a/docs/getting_started/0_scripts_quickstart/7_docker_quickstart/index.mdx b/docs/getting_started/0_scripts_quickstart/7_docker_quickstart/index.mdx index 856feff2e..70f7049ba 100644 --- a/docs/getting_started/0_scripts_quickstart/7_docker_quickstart/index.mdx +++ b/docs/getting_started/0_scripts_quickstart/7_docker_quickstart/index.mdx @@ -155,9 +155,9 @@ first step of script creation: Metadata. ## Settings -![New script](../4_bash_quickstart/create_script_bash.png.webp) +![New script](../../../../static/images/script_languages.png "New script") -As part of the settings menu, each script has metadata associated with it, enabling it to be defined and configured in depth. +As part of the [settings](../../../script_editor/settings.mdx) menu, each script has metadata associated with it, enabling it to be defined and configured in depth. - **Path** is the Script's unique identifier that consists of the [script's owner](../../../core_concepts/16_roles_and_permissions/index.mdx), and the script's name. @@ -170,12 +170,7 @@ As part of the settings menu, each script has metadata associated with it, enabl to users on how to run your Script. It supports markdown. - **Script kind**: Action (by default), [Trigger](../../../flows/10_flow_trigger.mdx), [Approval](../../../flows/11_flow_approval.mdx) or [Error handler](../../../flows/7_flow_error_handler.md). This acts as a tag to filter appropriate scripts from the [flow editor](../../6_flows_quickstart/index.mdx). -This menu also has additional settings, such as: - -- **[Concurrency limits](../../../script_editor/concurrency_limit.mdx)** enable defining concurrency limits for scripts and inline scripts within flows to prevent exceeding the API Limit of the targeted API. -- **[Worker group tag](../../../core_concepts/9_worker_groups/index.mdx)** to assign scripts to specific worker groups (such as nodes with GPU accelaration). -- **[Cache](../../../core_concepts/24_caching/index.md)** to cache the results for each possible inputs for a given time. -- **[Dedicated Workers](../../../core_concepts/25_dedicated_workers/index.mdx)** to run the script on, to run the script at native speed. Only available on [Cloud plans and Self-Hosted Enterprise edition](/pricing) and with Python and TypeScript. +This menu also has additional settings on [Runtime](../../../script_editor/settings.mdx#runtime), [Generated UI](#triggers) and [Triggers](../../../script_editor/settings.mdx#triggers).
diff --git a/docs/getting_started/0_scripts_quickstart/8_php_quickstart/create_script_php.png b/docs/getting_started/0_scripts_quickstart/8_php_quickstart/create_script_php.png deleted file mode 100644 index 195114f2e..000000000 Binary files a/docs/getting_started/0_scripts_quickstart/8_php_quickstart/create_script_php.png and /dev/null differ diff --git a/docs/getting_started/0_scripts_quickstart/8_php_quickstart/index.mdx b/docs/getting_started/0_scripts_quickstart/8_php_quickstart/index.mdx index 137b11fb3..324c80b44 100644 --- a/docs/getting_started/0_scripts_quickstart/8_php_quickstart/index.mdx +++ b/docs/getting_started/0_scripts_quickstart/8_php_quickstart/index.mdx @@ -72,9 +72,9 @@ From the Home page, click `+Script`. This will take you to the first step of scr ## Settings -![New script](./create_script_php.png "New script") +![New script](../../../../static/images/script_languages.png "New script") -As part of the settings menu, each script has metadata associated with it, enabling it to be defined and configured in depth. +As part of the [settings](../../../script_editor/settings.mdx) menu, each script has metadata associated with it, enabling it to be defined and configured in depth. - **Path** is the Script's unique identifier that consists of the [script's owner](../../../core_concepts/16_roles_and_permissions/index.mdx), and the script's name. @@ -87,12 +87,7 @@ As part of the settings menu, each script has metadata associated with it, enabl to users on how to run your Script. It supports markdown. - **Script kind**: Action (by default), [Trigger](../../../flows/10_flow_trigger.mdx), [Approval](../../../flows/11_flow_approval.mdx) or [Error handler](../../../flows/7_flow_error_handler.md). This acts as a tag to filter appropriate scripts from the [flow editor](../../6_flows_quickstart/index.mdx). -This menu also has additional settings, such as: - -- **[Concurrency limits](../../../script_editor/concurrency_limit.mdx)** enable defining concurrency limits for scripts and inline scripts within flows to prevent exceeding the API Limit of the targeted API. -- **[Worker group tag](../../../core_concepts/9_worker_groups/index.mdx)** to assign scripts to specific worker groups (such as nodes with GPU accelaration). -- **[Cache](../../../core_concepts/24_caching/index.md)** to cache the results for each possible inputs for a given time. -- **[Dedicated Workers](../../../core_concepts/25_dedicated_workers/index.mdx)** to run the script on, to run the script at native speed. Only available on [Cloud plans and Self-Hosted Enterprise edition](/pricing) and with Python and TypeScript. +This menu also has additional settings on [Runtime](../../../script_editor/settings.mdx#runtime), [Generated UI](#triggers) and [Triggers](../../../script_editor/settings.mdx#triggers).
diff --git a/docs/getting_started/0_scripts_quickstart/9_ansible_quickstart/index.mdx b/docs/getting_started/0_scripts_quickstart/9_ansible_quickstart/index.mdx index a5266f755..53cb35e0f 100644 --- a/docs/getting_started/0_scripts_quickstart/9_ansible_quickstart/index.mdx +++ b/docs/getting_started/0_scripts_quickstart/9_ansible_quickstart/index.mdx @@ -7,9 +7,7 @@ import DocCard from '@site/src/components/DocCard'; # Ansible quickstart -## Windmill Scripts - -In this quickstart guide, we will write our first script/playbook with ansible. +In this quickstart guide, we will write our first script/playbook with [Ansible](https://www.ansible.com/).
-#### Webhooks: Trigger scripts from Slack +#### Webhooks: trigger scripts from Slack One use case of webhooks is [building a Slackbot with Windmill](/blog/handler-slack-commands). diff --git a/docs/getting_started/9_trigger_flows/index.mdx b/docs/getting_started/9_trigger_flows/index.mdx index adadd0319..b801e1c07 100644 --- a/docs/getting_started/9_trigger_flows/index.mdx +++ b/docs/getting_started/9_trigger_flows/index.mdx @@ -8,7 +8,7 @@ On-demand triggers: - [Auto-generated UIs](/docs/getting_started/trigger_flows#auto-generated-uis) - [Customized UIs with the App editor](#customized-uis-with-the-app-editor) -- [Schedule the Execution of a Flow](#schedule-the-execution-of-a-flow) +- [Schedule](#schedule) - [Trigger Flows from CLI (Command-line interface)](#cli-command-line-interface) - [Trigger a Flow from another Flow](#trigger-a-flow-from-another-flow) @@ -19,7 +19,7 @@ Triggers from external events: - [Custom HTTP routes](#custom-http-routes) - [Scheduling + Trigger scripts](#scheduling--trigger-scripts) -## On-demand Triggers +## On-demand triggers ### Auto-generated UIs @@ -82,7 +82,7 @@ You can also [automatically generate](../../core_concepts/6_auto_generated_uis/i src="/videos/cowsay_app.mp4" /> -### Schedule the Execution of a Flow +### Schedule Windmill allows you to schedule scripts using a user-friendly interface and control panels, **similar to [cron](https://crontab.guru/)** but with more features. @@ -143,7 +143,7 @@ Windmill supports inner flows. This allows you to call a flow from another workf />
-## Triggers from External Events +## Triggers from external events ### Trigger from API @@ -175,7 +175,7 @@ Using webhooks, you could also trigger a flow from scripts. />
-#### Webhooks: Trigger Flows from Slack +#### Webhooks: trigger flows from Slack One use case of webhooks is [building a Slackbot with Windmill](/blog/handler-slack-commands). diff --git a/docs/misc/11_worker_group_management_ui/index.mdx b/docs/misc/11_worker_group_management_ui/index.mdx index d4773e95d..6ba79e85e 100644 --- a/docs/misc/11_worker_group_management_ui/index.mdx +++ b/docs/misc/11_worker_group_management_ui/index.mdx @@ -27,8 +27,8 @@ More at: href="/docs/core_concepts/dedicated_workers" />
diff --git a/docs/misc/17_windows_workers/index.mdx b/docs/misc/17_windows_workers/index.mdx index cd25bf141..ec703649a 100644 --- a/docs/misc/17_windows_workers/index.mdx +++ b/docs/misc/17_windows_workers/index.mdx @@ -1,10 +1,10 @@ --- -title: Windows-Workers +title: Windows workers --- import DocCard from '@site/src/components/DocCard'; -# Windows Workers +# Windows workers Windows Native Workers are a [Self-Hosted Enterprise](/pricing) Feature. diff --git a/docs/script_editor/concurrency_limit.mdx b/docs/script_editor/concurrency_limit.mdx index 69104357c..1721babd7 100644 --- a/docs/script_editor/concurrency_limit.mdx +++ b/docs/script_editor/concurrency_limit.mdx @@ -6,13 +6,13 @@ canonical_url: /docs/core_concepts/concurrency_limits The Concurrency limits feature allows you to define concurrency limits for scripts, flows and inline scripts within flows. Its primary goal is to prevent exceeding the API Limit of the targeted API, eliminating the need for complex workarounds using worker groups. -![Concurrency Limit](../assets/code_editor/concurrency_limit.png.webp) +![Concurrency limit](../assets/code_editor/concurrency_limit.png.webp) Concurrency limit is a [Cloud plans and Pro Enterprise Self-Hosted](/pricing) only. Concurrency limit can be set from the Settings menu. When jobs reach the concurrency limit, they are automatically queued for execution at the next available optimal slot given the time window. -The Concurrency Limit operates globally and across flow runs. It involves three key parameters: +The Concurrency limit operates globally and across flow runs. It involves three key parameters: ## Max number of executions within the time window diff --git a/docs/script_editor/index.mdx b/docs/script_editor/index.mdx index 374101b78..d0e6d0507 100644 --- a/docs/script_editor/index.mdx +++ b/docs/script_editor/index.mdx @@ -18,7 +18,7 @@ specification and the [code content](../code_editor/index.mdx). ![Script languages](../../static/images/script_languages.png 'Script languages') Python and Go Scripts also have an -auto-generated lockfile that ensure that executions of the same Script always +auto-generated [lockfile](../advanced/6_imports/index.mdx) that ensure that executions of the same Script always use the exact same set of versioned dependencies. To fit Windmill's execution model, the code must always have a main function, which is its entrypoint when executed as an individual serverless endpoint or a [Flow](../flows/1_flow_editor.mdx) module and typed parameters used to infer the script's inputs and [auto-generated UI](../core_concepts/6_auto_generated_uis/index.mdx): @@ -93,7 +93,7 @@ The Script editor is made of the following features: href="/docs/script_editor/settings" /> @@ -108,13 +108,8 @@ The Script editor is made of the following features: href="/docs/core_concepts/versioning#script-versioning" /> -
-## Approval Scripts +## Approval scripts Suspend a flow until it's approved. An Approval Script will interact with the Windmill API using any of the Windmill clients to retrieve a secret approval URL -and resume/cancel endpoints. Most common scenario for Approval Scripts is to +and resume/cancel endpoints. Most common scenario for Approval scripts is to send an external notification with an URL that can be used to resume or cancel a flow. diff --git a/docs/script_editor/settings.mdx b/docs/script_editor/settings.mdx index adb53c116..d773d7c51 100644 --- a/docs/script_editor/settings.mdx +++ b/docs/script_editor/settings.mdx @@ -2,13 +2,29 @@ import DocCard from '@site/src/components/DocCard'; # Settings -Each script has metadata associated with it, enabling it to be defined and configured in depth. +Each script has settings associated with it, enabling it to be defined and configured in depth. -![Script Metadata](../assets/code_editor/script_metadata.png 'Script Metadata') +![Script settings](../../static/images/script_languages.png 'Script settings') -## Path +## Metadata -**Path** is the Script's unique identifier that consists of the [script's owner](../core_concepts/16_roles_and_permissions/index.mdx#permissions-and-access-control), and the script's name. +Metadata is used to define the script's path, summary, description, language and kind. + +### Summary + +Summary (optional) is a short, human-readable summary of the Script. It will be displayed as a title across Windmill. If omitted, the UI will use the `path` by default. + +It can be pre-filled automatically using [Windmill AI](../core_concepts/22_ai_generation/index.mdx): + +