diff --git a/src/pages/docs/octopus-cloud/maintenance-window.md b/src/pages/docs/octopus-cloud/maintenance-window.md index e6416c01b5..8ab54cfee6 100644 --- a/src/pages/docs/octopus-cloud/maintenance-window.md +++ b/src/pages/docs/octopus-cloud/maintenance-window.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-04-05 +modDate: 2024-09-23 title: Octopus Cloud Maintenance Window navOrder: 55 description: Details about the Octopus Cloud maintenance window @@ -15,7 +15,7 @@ Most of these won't affect your instance's availability, but occasionally, we mi We don’t need to perform actions on your instance daily, and most of our maintenance actions won’t take your instance offline. At most, you might notice a performance impact. The steps that require an outage typically only take a short time to complete. ::: -At the time of publishing this (April 2024), our maintenance tasks that require downtime average 15 minutes per week. +At the time of publishing this (April 2024), our maintenance tasks require an average of 15 minutes downtime per week. @@ -27,11 +27,11 @@ You can adjust your maintenance window anytime, but make sure to do it before yo ## View or change your maintenance window Setting up your maintenance window to suit your business needs is easy. Just follow these steps: -1. Log in to your Octopus account. +1. Log in to [Octopus.com](https://octopus.com). 2. Select your cloud instance. -3. Click **Configuration.** -4. Scroll down to the **Outage Window** section. -5. Select the time in UTC, providing a window of at least two hours and click **Save Outage window.** +3. Click **Configuration**. +4. Scroll down to the **Maintenance window** section. +5. Select the time in UTC, providing a window of at least two hours and click **Submit**. @@ -45,14 +45,14 @@ Those tasks include (but are not limited to) the following: - Moving your instance to new infrastructure. These operations don't happen as often, but are required when we roll out improvements to the underlying infrastructure. - Processing any billing events, such as applying the latest license key to the instance or changing the task cap. -Most maintenance operations can be performed without taking the instance offline, such as database maintenance. Your instance may feel a little slower while any online maintenance operations are running. For tasks that cause an outage, typically only a subset of steps requiring the instance to be offline. For all the other steps, we keep the instance online. +Most maintenance operations can be performed without taking the instance offline, such as database maintenance. Your instance may feel a little slower while any online maintenance operations are running. For tasks that cause an outage, typically only a subset of steps require the instance to be offline. For all the other steps, we keep the instance online. Many of those tasks have guard clauses. For example, we won't de-fragment a database that has 10% fragmentation. In addition, we would only attempt to upgrade an instance if a new version exists. It is important to note that most maintenance tasks do not start at the beginning of your maintenance window. We host thousands of customer instances. Because of that, we perform maintenance tasks in bulk. When we run a maintenance task, your instance might be the first, somewhere in the middle, or at the end of the list of instances. In some cases, by the time we finish processing other instances, your maintenance window is about to end. When that happens, your instance is skipped and that task won't be processed until the next day. That typically happens when performing upgrades. :::div{.hint} -Upgrading an instance is the primary cause of outages. The most noticeable impact of an outage is deployments and runbook runs will fail. We are actively working on [Resilient Scalable Deployments](https://roadmap.octopus.com/c/95-alpha-program-resilient-scalable-deployments-in-octopus-cloud) to allow the deployments and runbook runs to continue post-upgrade. +Upgrading an instance is the primary cause of outages. The most noticeable impact of an outage is deployments and runbook runs may fail. We are actively working on [Resilient Scalable Deployments](https://roadmap.octopus.com/c/95-alpha-program-resilient-scalable-deployments-in-octopus-cloud) to allow deployments and runbook runs to continue post-upgrade. ::: ## Taking your instance offline diff --git a/src/pages/docs/octopus-cloud/migrations.md b/src/pages/docs/octopus-cloud/migrations.md index 0d54a66b1e..328616967d 100644 --- a/src/pages/docs/octopus-cloud/migrations.md +++ b/src/pages/docs/octopus-cloud/migrations.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2023-10-04 +modDate: 2024-09-24 title: Migrating from Octopus Server to Octopus Cloud navOrder: 30 description: Migrating from Octopus Server to Octopus Cloud. @@ -12,7 +12,7 @@ This guide will walk you through a general set of steps to take to migrate your It is impossible to cover every last use case in a single guide, and as such, if you have any questions, please contact our [support team](https://octopus.com/support). We're always happy to help, and we can provide more specific information when you are ready to migrate. :::div{.hint} -This guide will follow the recommended approach to migrating to Octopus Cloud using the **Export/Import Projects** feature released in **Octopus 2021.1**. Learn more: [Exporting and Importing Projects](/docs/projects/export-import). +This guide will follow the recommended approach to migrating to Octopus Cloud using the **[Export/Import Projects](/docs/projects/export-import)** feature. ::: :::div{.problem} @@ -41,8 +41,8 @@ The deployments will **not** include: Before starting your migration to Octopus Cloud, you will need to address the following: 1. Understand the differences between Octopus Cloud and your Octopus Server. -1. Upgrading your Octopus Server instance to the latest major/minor release of Octopus Deploy (2021.1, 2021.2, etc.). -1. Determine if you are using [Polling or Listening tentacles](/docs/infrastructure/deployment-targets/tentacle/windows) for your deployment targets and workers. +1. Upgrading your Octopus Server instance to the latest release of Octopus Deploy. +1. Determine if you are using [Polling or Listening tentacles](/docs/infrastructure/deployment-targets/tentacle/tentacle-communication) for your deployment targets and workers. 1. Creating your Octopus Cloud instance. 1. Configuring any firewall settings for your tentacles. 1. Configuring workers and worker pools. @@ -54,7 +54,7 @@ Before starting your migration to Octopus Cloud, you will need to address the fo Octopus Cloud and Octopus Server are built on the same code base. The differences stem from the additional configuration steps we perform during the Octopus Cloud build. The differences are: - Octopus Cloud users cannot be Octopus Administrators, the "highest" level of permission possible is [Octopus Manager](/docs/octopus-cloud/permissions). -- Octopus Cloud has a subset of auth providers available to the Octopus Server. Most notably, Octopus Cloud does not include Active Directory or LDAP. Please see the [authentication provider compatibility page](/docs/security/authentication/auth-provider-compatibility) for an up to date list of what is available. +- Octopus Cloud has a subset of the auth providers available to Octopus Server. Most notably, Octopus Cloud does not include Active Directory or LDAP. Please see the [authentication provider compatibility page](/docs/security/authentication/auth-provider-compatibility) for an up to date list of what is available. - Octopus Cloud is subject to [storage limits and default retention policies](/docs/octopus-cloud/#octopus-cloud-storage-limits). - Octopus Cloud does not support running tasks on the server itself. Everything must run on a deployment target or worker. To help, Octopus Cloud includes [dynamic worker pools](/docs/infrastructure/workers/dynamic-worker-pools) with both Windows and Linux workers. @@ -115,11 +115,11 @@ Set up a couple of sample projects to deploy to your servers. That will be a fi ### User migration -The project export/import feature does not include users. All users must be created from scratch. If you are using an external authentication provider, such as Azure AD, or Okta, you can turn on "auto-create users" feature. +The project export/import feature does not include users. All users must be created from scratch. If you are using an external authentication provider, such as Azure AD, or Okta, you can turn on the [Automatic user creation](/docs/security/authentication/auto-user-creation) feature. ## Migration -The migration will use the **Export/Import Projects** feature in **Octopus 2021.1**. That feature was specifically designed for [migrating from Octopus Server to Octopus Cloud](/docs/projects/export-import). Our recommendations when using this tool are: +The migration will use the **Export/Import Projects** feature. This feature was specifically designed for [migrating from Octopus Server to Octopus Cloud](/docs/projects/export-import). Our recommendations when using this tool are: - Migrate using a phased approach over migrating everything at once. Migrate a project group or suite of applications to Octopus Cloud, test some deployments, then move onto the next batch. - The first couple of projects will take more time as you work through any configuration issues. As such, pick some non-mission-critical projects or applications first. @@ -155,7 +155,7 @@ A Windows or Linux server can have [1 to N tentacle instances](/docs/administrat 1. Original Tentacle Instance -> connects to your Octopus Server. 2. New Tentacle Instance -> connects to Octopus Cloud. -We have a [script to help create](https://github.com/OctopusDeployLabs/SpaceCloner/blob/master/docs/UseCase-CopyExistingTentacles.md) a cloned tentacle instance pointing to Octopus Cloud. You can copy a listening tentacle as a polling tentacle, a polling tentacle as a polling tentacle, or a listening tentacle as a listening tentacle. +We have a [script to help create](https://github.com/OctopusDeployLabs/SpaceCloner/blob/main/docs/UseCase-CopyExistingTentacles.md) a cloned tentacle instance pointing to Octopus Cloud. You can copy a listening tentacle as a polling tentacle, a polling tentacle as a polling tentacle, or a listening tentacle as a listening tentacle. :::div{.hint} That script requires PowerShell 5.1 or greater for Windows. We recommend PowerShell 7. @@ -183,7 +183,7 @@ After the build server has been updated, create a small change to trigger your C Disabling a project will prevent it from being able to create and deploy releases. It is also an excellent signal to all Octopus users that the project has been migrated. -1. Go to **Project ➜ Settings ➜ General** +1. Go to **Project Settings** 2. Click the overflow menu (`...`) 3. Select **Disable** on the menu @@ -201,6 +201,10 @@ At this point, we recommend deleting all the tentacle instances still pointing t In our experience, most people turn off their Octopus Server in about three to six months. When you decide to turn off your Octopus server, first take a full backup of the database and delete all the appropriate resources. +## Older versions + +The **Export/Import Projects** feature is available from Octopus Deploy **2021.1** onwards. + ## No longer offered or supported Before the **Export/Import Projects** feature, we offered a manual migration process. With the release of that feature, we no longer offer manual migrations from a self-hosted Octopus Server to Octopus Cloud and vice-versa. diff --git a/src/pages/docs/octopus-cloud/permissions.md b/src/pages/docs/octopus-cloud/permissions.md index d8be02b79d..112a8f2434 100644 --- a/src/pages/docs/octopus-cloud/permissions.md +++ b/src/pages/docs/octopus-cloud/permissions.md @@ -1,13 +1,13 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2023-01-01 +modDate: 2024-09-24 title: Permissions navOrder: 20 description: Octopus Cloud includes permissions that relate to hosting Octopus itself, and not for the configuration of your instance, as that's managed by Octopus for you. --- -Your Octopus Cloud instance includes permissions that relate to hosting Octopus itself, and not for the configuration/usability of your instance (e.g. server configuration logs), so we've introduced a new built-in team called **Octopus Managers**, think of it as a **cloud-instance** admin. +Your Octopus Cloud instance includes permissions that relate to hosting Octopus itself, and not for the configuration/usability of your instance (e.g. server configuration logs), so we've introduced a new built-in team called **Octopus Managers**, think of it as a **Cloud instance** admin. The **Octopus Administrators** team is still present, but it's only used by our **octoadmin** account, and if you ask us to log in to your instance for support. diff --git a/src/pages/docs/octopus-cloud/static-ip.md b/src/pages/docs/octopus-cloud/static-ip.md index 8ba1b17a4b..ca65f50c42 100644 --- a/src/pages/docs/octopus-cloud/static-ip.md +++ b/src/pages/docs/octopus-cloud/static-ip.md @@ -1,17 +1,17 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-08-06 +modDate: 2024-09-24 title: Static IP address navOrder: 10 description: How to find the list of static IP addresses for your Octopus Cloud instance --- -The Octopus Cloud is a multi-tenant service with several static IP addresses shared among customers in the same Azure region. +Octopus Cloud is a multi-tenant service with several static IP addresses shared among customers in the same Azure region. -Each Azure region uses a range of static IP addresses. The static IP address for an Octopus Cloud Server will be one from the range and may change to another static IP address within the range under certain situations. +Each Azure region uses a range of static IP addresses. The static IP address for an Octopus Cloud instance will be one from the range and may change to another static IP address within the range under certain situations. -With a static IP address, you can lock down the ingress and egress communications between a Tentacle in your infrastructure and your Octopus Cloud Server. +With a static IP address, you can lock down the ingress and egress communications between a Tentacle in your infrastructure and your Octopus Cloud instance. :::div{.hint} **Note:** @@ -21,7 +21,6 @@ The Octopus-hosted [Dynamic Workers](/docs/infrastructure/workers/dynamic-worker The range of IP Addresses that your Octopus Cloud Server will use is listed in the technical section of the instance details page. 1. Log in to [Octopus.com](https://octopus.com). -1. Click your profile in the upper right, followed by clicking **Control Center**. -1. Click on Cloud Instances under the Products subheading from the control center menu. -1. Click on the Octopus Cloud instance you want to get the IP addresses for and click **Configuration**. -1. Scroll down to the **Static IP addresses** entry, and you will see the static IP addresses your instance can use. +1. Select your cloud instance. +1. Click **Configuration**. +1. Scroll down to the **Static IP addresses** section, and you will see the static IP addresses your instance can use. diff --git a/src/pages/docs/octopus-cloud/task-cap.md b/src/pages/docs/octopus-cloud/task-cap.md index 06321db7f1..bcc0cf089c 100644 --- a/src/pages/docs/octopus-cloud/task-cap.md +++ b/src/pages/docs/octopus-cloud/task-cap.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-10-13 -modDate: 2023-10-13 +modDate: 2024-09-23 title: Octopus Cloud Task Cap navOrder: 60 description: How to increase the task cap on an Octopus Cloud Instance. @@ -22,7 +22,7 @@ A task can be: - Sync built-in package repository - Sync community library step-templates - Tentacle upgrade -- Upgrade calamari +- Upgrade Calamari - Active Directory sync The most common tasks are deployments and runbook runs. @@ -42,16 +42,16 @@ Octopus Cloud provides the following Task Cap options: - 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. +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 Octopus 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. +We assign resources to each Octopus Cloud 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. +We recommend task caps based upon the number and duration 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.