diff --git a/dictionary-octopus.txt b/dictionary-octopus.txt index 8213e9234d..642a135782 100644 --- a/dictionary-octopus.txt +++ b/dictionary-octopus.txt @@ -2,4 +2,18 @@ astro cutover octopusdeploy runbook -runbooks \ No newline at end of file +runbooks +hotfix +hotfixes +ITSM +FIPS +NTLM +OIDC +HSTS +MTTR +swaggerui +apikey +reprioritize +reprovisioned +reprovisioning +xmark 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/getting-started/managing-octopus-subscriptions.md b/src/pages/docs/getting-started/managing-octopus-subscriptions.md index 965a5c0aed..31ae950b22 100644 --- a/src/pages/docs/getting-started/managing-octopus-subscriptions.md +++ b/src/pages/docs/getting-started/managing-octopus-subscriptions.md @@ -114,6 +114,8 @@ There are 2 levels of access you can provide users in Control Center. Each level 1. **Subscription Group access** provides management of a group of subscriptions plus access to all current and future subscriptions in the group. 2. **Direct access** provides access to individual subscriptions. +Changes to access control in Control Center V1 will only affect subscriptions located in Control Center V1 and changes in Control Center V2 will only affect subscriptions located in Control Center V2. + ### Subscription Group access Below are the roles for Subscription Group access, the permissions they provide for the group, and the subscriptions in the group: @@ -140,6 +142,8 @@ Below are the roles for Subscription Group access, the permissions they provide The invited user will receive an email to accept the invitation. If they already have an [Octopus ID](/docs/security/authentication/octopusid-authentication) (Octopus Deploy account), they can accept the invite and **Sign in** to view the Octopus instance. Otherwise, they will first need to **Register** a new account using the email address the invitation was sent to. +If the invited user already has an Octopus ID, they must still accept the invite sent via email to complete the process. + ### Direct access (Cloud only) Below are the roles available for Direct access: @@ -161,6 +165,8 @@ Below are the roles available for Direct access: The invited user will receive an email to accept the invitation. If they already have an [Octopus ID](/docs/security/authentication/octopusid-authentication) (Octopus Deploy account), they can accept the invite and **Sign in** to view the Octopus instance. Otherwise, they will first need to **Register** a new account using the email address the invitation was sent to. +If the invited user already has an Octopus ID, they must still accept the invite sent via email to complete the process. + :::div{.hint} **Note:** The user is only added to the Octopus Cloud instance after they sign in for the first time. After signing in, that user gets assigned to the **“Everyone”** team (if they’re a Cloud User) or the **“Octopus Managers”** team (if they’re a Cloud Owner). ::: 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-cloud/task-cap.md b/src/pages/docs/octopus-cloud/task-cap.md new file mode 100644 index 0000000000..6aff12dfc8 --- /dev/null +++ b/src/pages/docs/octopus-cloud/task-cap.md @@ -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 | \ No newline at end of file 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 diff --git a/src/shared-content/octopus-cloud/octopus-cloud-community-plan-instance-limits.include.md b/src/shared-content/octopus-cloud/octopus-cloud-community-plan-instance-limits.include.md index 784a0f8514..7172a8f413 100644 --- a/src/shared-content/octopus-cloud/octopus-cloud-community-plan-instance-limits.include.md +++ b/src/shared-content/octopus-cloud/octopus-cloud-community-plan-instance-limits.include.md @@ -2,4 +2,3 @@ - Limit of 5 users - Limit of 5 projects - Limit of 20 worker hours per month -- Technical support included diff --git a/src/shared-content/octopus-server/octopus-server-community-limits.include.md b/src/shared-content/octopus-server/octopus-server-community-limits.include.md index c592daaf18..5ed3ac4b90 100644 --- a/src/shared-content/octopus-server/octopus-server-community-limits.include.md +++ b/src/shared-content/octopus-server/octopus-server-community-limits.include.md @@ -2,4 +2,3 @@ - Limit of 5 users with [restricted permissions](/docs/administration/managing-licenses/community/#restricted-permissions) - Limit of 5 projects - Valid for 12 months, extend anytime for free -- Technical support included \ No newline at end of file