-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/main' into frank/win2019eol-09jan
# Conflicts: # dictionary-octopus.txt
- Loading branch information
Showing
14 changed files
with
170 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
--- | ||
layout: src/layouts/Default.astro | ||
pubDate: 2023-10-13 | ||
modDate: 2023-10-13 | ||
title: Octopus Cloud Task Cap | ||
navOrder: 60 | ||
description: How to increase the task cap on an Octopus Cloud Instance. | ||
--- | ||
|
||
Every Octopus Deploy instance has set number of concurrent tasks it can process. That number of concurrent tasks is known as the Octopus Task Cap. | ||
|
||
A task can be: | ||
|
||
- Deployments | ||
- Runbook run | ||
- Retention Policies | ||
- Health Checks | ||
- Let’s Encrypt | ||
- Process triggers | ||
- Process subscriptions | ||
- Script console run | ||
- Sync built-in package repository | ||
- Sync community library step-templates | ||
- Tentacle upgrade | ||
- Upgrade calamari | ||
- Active Directory sync | ||
|
||
The most common tasks are deployments and runbook runs. | ||
|
||
The default task cap for Octopus Cloud instances is based on the license tier: | ||
- Community: 5 | ||
- Professional: 5 | ||
- Enterprise: 20 | ||
|
||
Self-hosted customers have more control over their task cap. As such, every self-hosted instance starts out with a task cap of 5. A higher task cap requires more hosting resources. Self-hosted customers can change their instance's task cap via the Octopus Deploy UI. That is because self-hosted customers take on the responsibility of allocating resources, and paying any additional Azure, AWS, or GCP fees. | ||
|
||
## Increasing the Task Cap for Octopus Cloud | ||
Octopus Cloud customers must reach out to sales@octopus.com to increase the task cap. | ||
|
||
Octopus Cloud provides the following Task Cap options: | ||
- Community: 5 | ||
- Professional: 5, 10, 20 | ||
- Enterprise: 20, 40, 80, 160 | ||
|
||
Increasing the task cap will incur a corresponding increase in platform fees. Deployments and runbook runs are computationally expensive. More concurrent deployments and runbook runs requires more resources from the Cloud Platform. | ||
|
||
We assign resources to the instance based on the task cap. Changing the task cap changes those resources. That requires a small outage as the instance and database are reprovisioned. We will wait until your next maintenance window to perform that reprovisioning. You might not see a change in the task cap until the next day. | ||
|
||
**Please note:** If you need a task cap higher than 160 please reach out to sales@octopus.com to discuss your use case. These options are meant to cover the majority of use cases. | ||
|
||
**Important:** 5, 10, 20, 40, 80, and 160 are the only options we offer. If you want an instance with a task cap above 160, again, reach out to sales@octopus.com. There are no options between those tiers. For example, no Octopus Cloud instance can have a task cap of 15, 34, 45, or 68. | ||
|
||
## How to choose a task cap | ||
We recommend the number of deployments required for a production deployment. Deployments and runbook runs are the most common tasks. Deployments typically take longer than runbook runs. Production deployments are time constrained. They are done off-hours during an outage window. | ||
|
||
**Important:** These tables represent the _MAX_ number of deployments. Additional tasks such as runbook runs, retention policies, or health checks can reduce the number. Use these tables as guidelines. | ||
|
||
### Task Cap 5 | ||
| Deployment Window | 10 Minute Deployments | 15 Minute Deployments | 30 Minute Deployments | | ||
| ----------------- | --------------------- | --------------------- | --------------------- | | ||
| 2 Hours | 60 Deployments | 40 Deployments | 20 Deployments | | ||
| 4 Hours | 120 Deployments | 80 Deployments | 40 Deployments | | ||
| 8 Hours | 240 Deployments | 160 Deployments | 80 Deployments | | ||
| 16 Hours | 480 Deployments | 320 Deployments | 160 Deployments | | ||
| 24 Hours | 720 Deployments | 480 Deployments | 320 Deployments | | ||
|
||
### Task Cap 10 | ||
| Deployment Window | 10 Minute Deployments | 15 Minute Deployments | 30 Minute Deployments | | ||
| ----------------- | --------------------- | --------------------- | --------------------- | | ||
| 2 Hours | 120 Deployments | 80 Deployments | 40 Deployments | | ||
| 4 Hours | 240 Deployments | 160 Deployments | 80 Deployments | | ||
| 8 Hours | 480 Deployments | 320 Deployments | 160 Deployments | | ||
| 16 Hours | 960 Deployments | 640 Deployments | 320 Deployments | | ||
| 24 Hours | 1,440 Deployments | 960 Deployments | 640 Deployments | | ||
|
||
### Task Cap 20 | ||
| Deployment Window | 10 Minute Deployments | 15 Minute Deployments | 30 Minute Deployments | | ||
| ----------------- | --------------------- | --------------------- | --------------------- | | ||
| 2 Hours | 240 Deployments | 160 Deployments | 80 Deployments | | ||
| 4 Hours | 480 Deployments | 320 Deployments | 160 Deployments | | ||
| 8 Hours | 960 Deployments | 640 Deployments | 320 Deployments | | ||
| 16 Hours | 1,920 Deployments | 1,280 Deployments | 640 Deployments | | ||
| 24 Hours | 2,880 Deployments | 1,920 Deployments | 960 Deployments | | ||
|
||
### Task Cap 40 | ||
| Deployment Window | 10 Minute Deployments | 15 Minute Deployments | 30 Minute Deployments | | ||
| ----------------- | --------------------- | --------------------- | --------------------- | | ||
| 2 Hours | 480 Deployments | 320 Deployments | 160 Deployments | | ||
| 4 Hours | 960 Deployments | 640 Deployments | 320 Deployments | | ||
| 8 Hours | 1,920 Deployments | 1,280 Deployments | 640 Deployments | | ||
| 16 Hours | 3,840 Deployments | 2,560 Deployments | 1,280 Deployments | | ||
| 24 Hours | 5,760 Deployments | 3,840 Deployments | 1,920 Deployments | | ||
|
||
### Task Cap 80 | ||
| Deployment Window | 10 Minute Deployments | 15 Minute Deployments | 30 Minute Deployments | | ||
| ----------------- | --------------------- | --------------------- | --------------------- | | ||
| 2 Hours | 960 Deployments | 640 Deployments | 320 Deployments | | ||
| 4 Hours | 1,920 Deployments | 1,280 Deployments | 640 Deployments | | ||
| 8 Hours | 3,840 Deployments | 2,560 Deployments | 1,280 Deployments | | ||
| 16 Hours | 7,680 Deployments | 5,120 Deployments | 2,560 Deployments | | ||
| 24 Hours | 11,520 Deployments | 7,680 Deployments | 3,840 Deployments | | ||
|
||
### Task Cap 160 | ||
| Deployment Window | 10 Minute Deployments | 15 Minute Deployments | 30 Minute Deployments | | ||
| ----------------- | --------------------- | --------------------- | --------------------- | | ||
| 2 Hours | 1,920 Deployments | 1,280 Deployments | 640 Deployments | | ||
| 4 Hours | 3,840 Deployments | 2,560 Deployments | 1,280 Deployments | | ||
| 8 Hours | 7,680 Deployments | 5,120 Deployments | 2,560 Deployments | | ||
| 16 Hours | 15,360 Deployments | 10,240 Deployments | 5,120 Deployments | | ||
| 24 Hours | 23,040 Deployments | 15,360 Deployments | 7,680 Deployments | |
6 changes: 5 additions & 1 deletion
6
src/pages/docs/octopus-rest-api/examples/tasks/reprioritize-tasks.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
layout: src/layouts/Default.astro | ||
pubDate: 2023-10-20 | ||
modDate: 2023-10-20 | ||
title: Tasks | ||
navTitle: Overview | ||
navSection: Tasks | ||
description: Tasks are the primary way of getting work done in Octopus. | ||
navOrder: 100 | ||
--- | ||
|
||
Many of the main operations Octopus performs are represented by Tasks. This includes all deployments and runbook runs, and system operations such as applying retention policies. Since Tasks consume resources on the Octopus Server while they are executing, the number of Tasks which can execute at the same time is limited by a task cap. See [increasing the task cap](/docs/support/increase-the-octopus-server-task-cap) for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
layout: src/layouts/Default.astro | ||
pubDate: 2023-10-20 | ||
modDate: 2023-10-20 | ||
title: Prioritize Tasks | ||
description: Tasks can be manually prioritized to run before other earlier queued tasks. | ||
--- | ||
|
||
Tasks are run sequentially based on the time they are queued to start. If you have many deployments or runbooks running simultaneously, this can result in a large queue of Tasks. Octopus **2023.4** adds support for prioritizing Tasks that require immediate execution, such as production hotfixes. | ||
|
||
Prioritizing Tasks can be done either on the **Tasks** page or when viewing an individual Task. On the **Tasks** page, select the overflow menu (`...`) on a queued task and click **Move to Top**. If you are viewing an individual Task, click the **Move to Top** button. Once an executing Task has completed, the prioritized Task will immediately start executing before any other Tasks in the queue. | ||
|
||
:::div{.warning} | ||
Ensure any other queued deployments to the same environment are cancelled when prioritizing a deployment, otherwise an unexpected version of a release may overwrite the prioritized deployment. | ||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,4 +2,3 @@ | |
- Limit of 5 users | ||
- Limit of 5 projects | ||
- Limit of 20 worker hours per month | ||
- Technical support included |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters