From aa7e1c037fad223b1419176d2936c616e22b03d2 Mon Sep 17 00:00:00 2001 From: Nelson Susanto Date: Tue, 24 Oct 2023 13:29:44 +1100 Subject: [PATCH] Add tasks section with overview and prioritize tasks (#2045) * Add tasks section with overview and prioritize-tasks * Update reprioritize-tasks script page * Move task cap * Revert "Move task cap" This reverts commit 39fa91ab811404bb5782eb28ee947dda4755ed17. * Update index * Update navOrders. Tasks now goes between Runbooks and Approvals * Update dictionary, fix capitalization * Update dictionary again * Change infrastructure to environment --- dictionary-octopus.txt | 13 ++++++++++++- src/pages/docs/administration/index.md | 2 +- src/pages/docs/approvals/index.md | 2 +- src/pages/docs/insights/index.md | 2 +- .../examples/tasks/reprioritize-tasks.mdx | 6 +++++- src/pages/docs/octopus-rest-api/index.mdx | 4 ++-- src/pages/docs/security/index.md | 2 +- src/pages/docs/support/index.md | 2 +- src/pages/docs/tasks/index.md | 12 ++++++++++++ src/pages/docs/tasks/prioritize-tasks.md | 15 +++++++++++++++ 10 files changed, 51 insertions(+), 9 deletions(-) create mode 100644 src/pages/docs/tasks/index.md create mode 100644 src/pages/docs/tasks/prioritize-tasks.md diff --git a/dictionary-octopus.txt b/dictionary-octopus.txt index 614fbfa61a..f62507f304 100644 --- a/dictionary-octopus.txt +++ b/dictionary-octopus.txt @@ -1,5 +1,16 @@ astro runbook -Runbook +runbooks +hotfix +hotfixes +ITSM +FIPS +NTLM +OIDC +HSTS +MTTR +swaggerui +apikey +reprioritize reprovisioned reprovisioning diff --git a/src/pages/docs/administration/index.md b/src/pages/docs/administration/index.md index 03370c8a7e..574a83155e 100644 --- a/src/pages/docs/administration/index.md +++ b/src/pages/docs/administration/index.md @@ -6,7 +6,7 @@ title: Administration navTitle: Overview navSection: Administration description: Octopus administration tasks and command reference. -navOrder: 120 +navOrder: 140 hideInThisSectionHeader: true --- diff --git a/src/pages/docs/approvals/index.md b/src/pages/docs/approvals/index.md index 11f9605d12..fb7566928b 100644 --- a/src/pages/docs/approvals/index.md +++ b/src/pages/docs/approvals/index.md @@ -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 --- diff --git a/src/pages/docs/insights/index.md b/src/pages/docs/insights/index.md index 60dc6bef54..8a4ae020f6 100644 --- a/src/pages/docs/insights/index.md +++ b/src/pages/docs/insights/index.md @@ -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. diff --git a/src/pages/docs/octopus-rest-api/examples/tasks/reprioritize-tasks.mdx b/src/pages/docs/octopus-rest-api/examples/tasks/reprioritize-tasks.mdx index 4317d8146a..d9833b918e 100644 --- a/src/pages/docs/octopus-rest-api/examples/tasks/reprioritize-tasks.mdx +++ b/src/pages/docs/octopus-rest-api/examples/tasks/reprioritize-tasks.mdx @@ -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} +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: diff --git a/src/pages/docs/octopus-rest-api/index.mdx b/src/pages/docs/octopus-rest-api/index.mdx index fdd2d33cb4..4d06c1fac1 100644 --- a/src/pages/docs/octopus-rest-api/index.mdx +++ b/src/pages/docs/octopus-rest-api/index.mdx @@ -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'; @@ -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": [ diff --git a/src/pages/docs/security/index.md b/src/pages/docs/security/index.md index eac852876c..3c0ac6ccaf 100644 --- a/src/pages/docs/security/index.md +++ b/src/pages/docs/security/index.md @@ -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. diff --git a/src/pages/docs/support/index.md b/src/pages/docs/support/index.md index 95d3b9696f..a311261ab8 100644 --- a/src/pages/docs/support/index.md +++ b/src/pages/docs/support/index.md @@ -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. diff --git a/src/pages/docs/tasks/index.md b/src/pages/docs/tasks/index.md new file mode 100644 index 0000000000..8e28e84e8b --- /dev/null +++ b/src/pages/docs/tasks/index.md @@ -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. \ No newline at end of file diff --git a/src/pages/docs/tasks/prioritize-tasks.md b/src/pages/docs/tasks/prioritize-tasks.md new file mode 100644 index 0000000000..335f8b7078 --- /dev/null +++ b/src/pages/docs/tasks/prioritize-tasks.md @@ -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. +::: \ No newline at end of file