Skip to content

Commit

Permalink
Merge main into sweep/add-sweep-config
Browse files Browse the repository at this point in the history
  • Loading branch information
sweep-ai[bot] authored Sep 15, 2023
2 parents 8b36fd7 + eef5dec commit c856217
Show file tree
Hide file tree
Showing 10 changed files with 65 additions and 79 deletions.
2 changes: 2 additions & 0 deletions docs/apps/0_app_editor/index.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import DocCard from '@site/src/components/DocCard';
import { Timer } from 'lucide-react';

# App Editor

Expand All @@ -10,6 +11,7 @@ The app editor is a low-code builder to create apps with components, create inte
title="Apps Quickstart"
description="Learn how to build your first app in a matter of minutes."
href="/docs/getting_started/apps_quickstart"
Icon={Timer}
/>
<DocCard
color="orange"
Expand Down
8 changes: 5 additions & 3 deletions docs/core_concepts/25_dedicated_workers/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,19 @@ import DocCard from '@site/src/components/DocCard';
Dedicated Workers are workers that are dedicated to a particular script. They are able to execute any job that target this script much faster than normal workers at the expense of being capable to only execute that one script.
They are as fast as running the same logic in a forloop, but keep the benefit of showing separate jobs per execution.

For now it only work with bun scripts that have been pre-deployed.
Dedicated Workers / Native Performance are an [enterprise-only](../../misc/7_plans_details/index.mdx) feature.

For now it only works with **bun scripts** that have been pre-deployed.

The scripts can be used within flows.

To use:

1. Assign one worker group to execute that script
1. Assign one worker group to execute that script:

![Worker group config](./worker_group_config.png)

The worker group will restart (assuming the pods/restart are set to restart automatically) and will now wait for step 2. below to happen
The worker group will restart (assuming the pods/restart are set to restart automatically) and will now wait for step 2. below to happen:

2. toggle the "Dedicated Workers" option for that script in the metadata:

Expand Down
Binary file modified docs/core_concepts/25_dedicated_workers/worker_group_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 1 addition & 6 deletions docs/core_concepts/4_webhooks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,19 +68,14 @@ Be cautious with potentially long-running jobs in **synchronous** mode.

:::

:::tip Asynchronous vs. Synchronous
### Asynchronous vs. Synchronous

It's always better to use asynchronous mode as it allows your client not to wait for the response and it avoids Windmill to have to maintain a connection to your client while the job is running. However, for short-running jobs where it's easier in your code to block until you get a response, then use the synchronous mode.

<br/>

When using the **synchronous mode**, the webhook returns the result of the script directly. If the script returns an error, the endpoint still returns the `200` status code with the error as a JSON object.

<br/>

When using the **asynchronous mode**, the webhook returns a `uuid` and you can poll the [get job](https://app.windmill.dev/openapi.html#/operations/getJob) API call to fetch the status and results once it is completed.

:::

## User token

Expand Down
4 changes: 2 additions & 2 deletions docs/core_concepts/9_worker_groups/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Workers can belong to multiple worker groups simultaneously. The default worker

If you assign custom worker groups to all your workers, make sure that they cover all worker groups above, otherwise those jobs will never be executed.

To make custom tags available from the UI, go to your workspace settings and click on the "Assignable Tags" button:
To make custom tags available from the UI, go to the dedicated "Workers" tab on the workspace and click on the "Assignable Tags" button:

![Worker Group Assignable Tags](./worker_group_ui_2.png)

Expand Down Expand Up @@ -64,7 +64,7 @@ Use the edit/create config next to the worker group name in windmill UI:

![Worker Group edit config](./worker_group_ui.png)

**Note**: The worker group management UI is an enterprise only feature. It is still possible to use worker groups with the community edition by passing to each worker the env variable `WORKER_TAGS`:
**Note**: The worker group management UI is an [enterprise only](../../misc/7_plans_details/index.mdx) feature. It is still possible to use worker groups with the community edition by passing to each worker the env variable `WORKER_TAGS`:

```
WORKER_TAGS=tag1,tag2
Expand Down
5 changes: 5 additions & 0 deletions docs/core_concepts/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,11 @@ On top of its editors to build endpoints, flows and apps, Windmill comes with a
title="Dedicated Workers / Native Performance"
description="Dedicated Workers are workers that are dedicated to a particular script."
href="/docs/core_concepts/dedicated_workers"
/>
<DocCard
title="Worker Groups Management UI"
description="Manage Worker Groups through Windmill UI."
href="/docs/misc/worker_group_management_ui"
/>
<DocCard
title="Deploy to staging/prod web UI"
Expand Down
4 changes: 3 additions & 1 deletion docs/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Start building now using our **<a href="https://app.windmill.dev/" rel="nofollow
/>
</div>

## Quick Overview of Windmill
## Quickstarts

Windmill is a feature-rich platform that allows you to build endpoints, cron jobs, workflows & UIs. Each of these features can be used standalone.

Expand Down Expand Up @@ -88,11 +88,13 @@ However the 3 core layers of Windmill, namely Scripts, Flows and Apps are comple
<DocCard
title="Flow Editor"
description="Low-code editor to build workflows."
color="teal"
href="/docs/flows/flow_editor"
/>
<DocCard
title="App Editor"
description="Drag-and-drop editor to build apps."
color="orange"
href="/docs/apps/app_editor"
/>
</div>
Expand Down
25 changes: 25 additions & 0 deletions docs/misc/11_worker_group_management_ui/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import DocCard from '@site/src/components/DocCard';

# Worker Groups Management UI

Workers are autonomous processes that run one script at a time using the full
machines resources available to them. They are at the basis of [Windmill's architecture](../10_architecture/index.md).

Under an [Enterprise license](../7_plans_details/index.mdx), worker groups can be managed through Windmill UI.

![Worker Group edit config](../../core_concepts/9_worker_groups/worker_group_ui.png)

More at:

<div class="grid grid-cols-2 gap-6 mb-4">
<DocCard
title="Workers and Worker Groups"
description="Worker Groups allow users to run scripts and flows on different machines with varying specifications."
href="/docs/core_concepts/worker_groups"
/>
<DocCard
title="Dedicated Workers / Native Performance"
description="Dedicated Workers are workers that are dedicated to a particular script."
href="/docs/core_concepts/dedicated_workers"
/>
</div>
88 changes: 21 additions & 67 deletions docs/misc/7_plans_details/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,74 +14,49 @@ Windmill provides a range of pricing plans for both Cloud and Self-hosted deploy

## Cloud

### Community Edition
### Community Edition - Cloud

No commitment or credit card required.
- Features include Google/Github/Microsoft/Gitlab SSO, unlimited variables/resources/scripts/apps/flows (except abuse), and 1000 free executions per month.
- Public apps, groups, folders, and granular permissions available.
- Deployment from Github and community support on Discord.
- Features include Google/Github/Microsoft/Gitlab SSO, unlimited variables/resources/scripts/apps/flows (except abuse), and 1,000 free executions per month.
- [Granular permissions](../../core_concepts/16_roles_and_permissions/index.mdx), [groups](../../core_concepts/8_groups_and_folders/index.mdx), [folders](../../core_concepts/8_groups_and_folders/index.mdx) and [public apps](../../apps/8_public_apps.md) available.
- [Deployment from Github](../../advanced/9_deploy_gh_gl/index.md) and community support on [Discord](https://discord.com/invite/V7PM2YHsPB).

### Team Plan
### Team Plan - Cloud

Designed for small teams automating processes.
- Includes all Community edition features.
- [Priority Support](../12_support_and_sla/index.mdx) 24/7 with a 48-hour response time and automation engineer assistance.
- [Audit logs](../../core_concepts/14_audit_logs/index.mdx) with a 7-day retention period.
- [Dedicated Workers / Native Performance](../../core_concepts/25_dedicated_workers/index.mdx).
- [Deploy to staging/prod web UI](../../core_concepts/12_staging_prod/index.md).
- [Global CSS on App Editor](../15_css_editor/index.md).
- [Multiplayer](../../core_concepts/7_multiplayer/index.md) editing.
- Each seat: $10/month.
- Each seat includes one user or two operators.
- Up to 10k executions per month.
- Each seat includes one user or two operators and 10k executions.
- Limited to 20 users.

`seats = max(users, executions / 10k)`. Meaning if you have 4 users and 60k executions, you pay 60$ = 40$ + 20$.

See [Upgrading to Team Edition](#upgrading-to-team-edition).

### Enterprise Plan
### Enterprise Plan - Cloud

Your own hosted dedicated Windmill cluster without restrictions.
Dedicated support, guidance and infrastructure for advanced capabilities.

- Isolated & dedicated database network & workers.
- [SLA and priority support](../12_support_and_sla/index.mdx) with a 3-hour response time.
- [Audit logs](../../core_concepts/14_audit_logs/index.mdx) with a 60-day retention period.
- [Dedicated Workers / Native Performance](../../core_concepts/25_dedicated_workers/index.mdx).
- [Deploy to staging/prod web UI](../../core_concepts/12_staging_prod/index.md).
- [Global CSS on App Editor](../15_css_editor/index.md).
- [Multiplayer](../../core_concepts/7_multiplayer/index.md) editing.
- SAML support.
- Opportunity to become a design partner for influencing the Windmill roadmap.
- Each worker: $100/month.
- [SAML / SCIM support](../14_saml_and_scim/index.md). Group sync with active directory.
- Design partner for Windmill roadmap.
- Base price at $600.
- Each seat: $40/month.
- Multi-tenant Shared infrastructure: $200/month.
- Isolated workers and database (Available in US/EU/Asia): $600/month.
- Dedicated Kubernetes cluster (Available in US/EU/Asia): $1200/month.
- Each worker: $100/month.
- Each worker can run up to ~26M jobs per month.

See [Upgrading to Enterprise Edition](#upgrading-to-enterprise-edition).

<div class="grid grid-cols-2 gap-6 mb-4">
<DocCard
title="Support & SLA"
description="Our SLAs are designed to provide timely assistance and address any issues."
href="/docs/misc/support_and_sla"
/>
<DocCard
title="Audit Logs"
description="Windmill provides audit logs for every operation and action that has side-effects."
href="/docs/core_concepts/audit_logs"
/>
<DocCard
title="Deploy to Staging or Prod"
description="Deploy items to another staging/prod workspace."
href="/docs/core_concepts/staging_prod"
/>
<DocCard
title="Multiplayer"
description="Collaborate on scripts simultaneously."
href="/docs/core_concepts/multiplayer"
/>
</div>

## Self-hosted

### Free and Open-source
Expand All @@ -90,47 +65,26 @@ See [Upgrading to Enterprise Edition](#upgrading-to-enterprise-edition).
- Features [Google/Github/Microsoft/Gitlab SSO](../../misc/2_setup_oauth/index.md) and easy deployment on Fargate/Docker/Kubernetes.
- Community support on [Discord](https://discord.com/invite/V7PM2YHsPB).

### Enterprise Edition
### Enterprise Edition - Self-Hosted

Designed for companies requiring dedicated support and advanced infrastructure.
Designed for companies requiring dedicated support, guidance and advanced infrastructure.
- Commercial license.
- [SLA and priority support](../12_support_and_sla/index.mdx) with a 3-hour response time.
- [Audit logs](../../core_concepts/14_audit_logs/index.mdx) with a 60-day retention period.
- [Dedicated Workers / Native Performance](../../core_concepts/25_dedicated_workers/index.mdx).
- [Worker Group Management UI](../11_worker_group_management_ui/index.mdx).
- [Deploy to staging/prod web UI](../../core_concepts/12_staging_prod/index.md).
- [Global CSS on App Editor](../15_css_editor/index.md).
- [Multiplayer](../../core_concepts/7_multiplayer/index.md) editing.
- SAML support.
- [SAML / SCIM support](../14_saml_and_scim/index.md). Group sync with active directory.
- Shared Global Dependency Cache plugin to allow multiple workers to share a centralized cache.
- Opportunity to become a design partner for influencing the Windmill roadmap.
- Design partner for Windmill roadmap.
- Each worker: $50/month.
- Each seat: $20/month.
- Each worker can run up to ~26M jobs per month.

See [Upgrading to Enterprise Edition](#upgrading-to-enterprise-edition).

<div class="grid grid-cols-2 gap-6 mb-4">
<DocCard
title="Support & SLA"
description="Our SLAs are designed to provide timely assistance and address any issues."
href="/docs/misc/support_and_sla"
/>
<DocCard
title="Audit Logs"
description="Windmill provides audit logs for every operation and action that has side-effects."
href="/docs/core_concepts/audit_logs"
/>
<DocCard
title="Deploy to Staging or Prod"
description="Deploy items to another staging/prod workspace."
href="/docs/core_concepts/staging_prod"
/>
<DocCard
title="Multiplayer"
description="Collaborate on scripts simultaneously."
href="/docs/core_concepts/multiplayer"
/>
</div>

## White Labeling Windmill

Windmill offers white labeling capabilities, allowing you to customize the Windmill platform to align with your brand. We do prodive a library to embed the entire Windmill app or specific components - such as the flow builder or the app builder - into your own application or website. This enables you to provide Windmill's services to your clients while maintaining your brand's identity.
Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,7 @@ const sidebars = {
'misc/support_and_sla/index',
'core_concepts/audit_logs/index',
'core_concepts/dedicated_workers/index',
'misc/worker_group_management_ui/index',
'core_concepts/staging_prod/index',
'misc/css_editor/index',
'core_concepts/multiplayer/index',
Expand Down

0 comments on commit c856217

Please sign in to comment.