Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tasks section with overview and prioritize tasks #2045

Merged
merged 10 commits into from
Oct 24, 2023
13 changes: 12 additions & 1 deletion dictionary-octopus.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
astro
runbook
Runbook
runbooks
hotfix
hotfixes
ITSM
FIPS
NTLM
OIDC
HSTS
MTTR
swaggerui
apikey
reprioritize
reprovisioned
reprovisioning
2 changes: 1 addition & 1 deletion src/pages/docs/administration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Administration
navTitle: Overview
navSection: Administration
description: Octopus administration tasks and command reference.
navOrder: 120
navOrder: 140
hideInThisSectionHeader: true
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/approvals/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Approvals
navTitle: Overview
navSection: Approvals
description: Octopus Deploy can integrate with supported ITSM tools for deployment control using Change Request approvals
navOrder: 95
navOrder: 110
hideInThisSection: true
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/insights/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Insights
navTitle: Overview
navSection: Insights
description: Insights gives you better visibility into your company's DevOps performance.
navOrder: 100
navOrder: 120
---

DevOps insights in Octopus gives you better visibility into your company's DevOps performance by surfacing the four key DORA metrics, so you can make more informed decisions on where to improve and celebrate your results.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2023-01-01
modDate: 2023-10-20
title: Reprioritize Tasks
description: An example script to find deployments or runbook runs for a specific environment, project, or tenant and move them to the top of the queue.
---
import ReprioritizeTasks from 'src/shared-content/scripts/reprioritize-tasks.include.md';

:::div{.hint}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good finding 👍

Support for [prioritizing tasks](/docs/tasks/prioritize-tasks) directly in Octopus is available from **2023.4**.
:::

This script can be used to move critical deployments from the bottom of the queue to the top of the queue.

How it works:
Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/octopus-rest-api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Octopus REST API
navTitle: Overview
navSection: Octopus REST API
description: Octopus integrates with build servers, scripts, external applications and anything else with its REST API.
navOrder: 110
navOrder: 130
---
import RestApi from 'src/shared-content/concepts/rest-api.include.md';

Expand Down Expand Up @@ -111,7 +111,7 @@ Collections of resources also include links. For example, following the `Environ
{
"ItemType": "Environment",
"TotalResults": 20,
"ItemserPage": 10,
"ItemsPerPage": 10,
"NumberOfPages": 2,
"LastPageNumber": 1,
"Items": [
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/security/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Security
navTitle: Overview
navSection: Security
description: Security considerations for Octopus Administrators.
navOrder: 130
navOrder: 150
---

We pride ourselves on making Octopus Deploy a secure product. The security and integrity of your Octopus Deploy installation is the result of a partnership between us as the software vendor, and you as the host and administrators of your installation.
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/support/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Support
navTitle: Overview
navSection: Support
description: Information explaining how to perform requested tasks by Octopus support.
navOrder: 130
navOrder: 160
---

Sometimes when you contact support we might ask you to perform tasks on your Octopus. This section explains how to perform some of those tasks.
Expand Down
12 changes: 12 additions & 0 deletions src/pages/docs/tasks/index.md
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.
15 changes: 15 additions & 0 deletions src/pages/docs/tasks/prioritize-tasks.md
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 infrastructure are cancelled when prioritizing a deployment, otherwise an unexpected version of a release may overwrite the prioritized deployment.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Can "environment" be more specific than "infrastructure" in this sentence?

:::