Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ The task queue is a first-in, first-out (FIFO) queue. The node does not conside

### Restarting the server during an active deployment

Restarting the Octopus Deploy windows service or the underlying host OS will (eventually) cause any active tasks to fail. At first, the tasks will look like they are still in process. Once the node comes back online, it will cancel all active tasks. If the node doesn't come back online within an hour, one of the other nodes will cancel those tasks.
Restarting the Octopus Deploy Windows service or the underlying host OS will (eventually) cause any active tasks to fail. At first, the tasks will look like they are still in process. Once the node comes back online, it will cancel all active tasks. If the node doesn't come back online within an hour, one of the other nodes will cancel those tasks.

For planned outages, the recommendation is to enable drain mode. That will tell the node to finish up all active tasks and not pick up any new ones. That can be achieved by:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ During your outage window, perform the following steps (skip the sections that d

1. Ensure you have a backup of your master key.
1. Enable [Maintenance Mode](/docs/administration/managing-infrastructure/maintenance-mode) to prevent anyone from deploying or making changes during the upgrade.
1. Stop the Octopus Deploy windows service.
1. Stop the Octopus Deploy Windows service.

### Move the database

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ If you can easily restart your Octopus Server, and the problem you are experienc

1. Download the [JetBrains dotMemory application](https://www.jetbrains.com/dotmemory/) and install it on the machine hosting Octopus Server.
2. Start dotMemory **as an Administrator** and start a free trial (the trial can be paused afterwards).
3. Stop the Octopus Deploy windows service.
4. Configure dotMemory to start your Octopus Server windows service.
3. Stop the Octopus Deploy Windows service.
4. Configure dotMemory to start your Octopus Server Windows service.
![dotMemory start Octopus Server](/docs/img/administration/managing-infrastructure/performance/images/record-a-memory-trace-start-windows-service.png).
5. If everything is working as expected you should see a screen like the one shown below
![dotMemory take snapshot](/docs/img/administration/managing-infrastructure/performance/images/record-a-memory-trace-take-snapshot.png).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Learn about [Octopus Server configuration and file storage](/docs/administration
These steps will remove all traces of Octopus Server from your computer:

1. Before uninstalling the MSI, use the Octopus Server Manager to delete the Octopus Server instance from the computer.
* This will stop and uninstall the Octopus Server windows service.
* This will stop and uninstall the Octopus Server Windows service.
2. Now uninstall the MSI.
* This will remove the application files.
3. Find and delete the Octopus Home folder. By default, this is in **`%SYSTEMDRIVE%\Octopus`**.
Expand All @@ -52,4 +52,4 @@ These steps will remove all traces of Octopus Server from your computer:
* **`%LocalAppData%\Octopus`** - could be used for log files when a Home Directory cannot be discovered
6. Find and delete any Octopus certificates from the following certificate stores:
* **`Local Computer\Octopus`**
* **`Current User\Octopus`** - do this for any user accounts that have been used as the account for the Octopus Server windows service
* **`Current User\Octopus`** - do this for any user accounts that have been used as the account for the Octopus Server Windows service
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Octopus Server and Tentacle will generally endeavor to write all log entries to
The default log file location is therefore **C:\Windows\System32\config\systemprofile\AppData\Local\Octopus\Logs**
:::

This is only for information related to which instances the watchdog attempted to start, and any errors it received while trying to start the windows services. Any instance specific errors will still be located in the instance's log file.
This is only for information related to which instances the watchdog attempted to start, and any errors it received while trying to start the Windows services. Any instance specific errors will still be located in the instance's log file.

### Tentacle vs Octopus Server {#ServiceWatchdog-TentacleVsOctopusServer}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If you have just completed an in-place upgrade from **Octopus 2.6** to a modern

## What does the Tentacle MSI do? {#ManuallyuninstallTentacle-WhatdoestheTentacleMSIactuallydo?}

The MSI will stop the Tentacle windows service and remove the application files which are normally stored in your `%ProgramFiles%` folder. The MSI will leave all configuration required to run Tentacle just like before you run the uninstaller. The installer behaves this way because the makes it easier for you to upgrade the application files for Tentacle knowing your configuration, data, and applications preserved.
The MSI will stop the Tentacle windows service and remove the application files which are normally stored in your `%ProgramFiles%` folder. The MSI will leave all configuration required to run Tentacle just like before you run the uninstaller. The installer behaves this way because this makes it easier for you to upgrade the application files for Tentacle knowing your configuration, data, and applications preserved.

## Manually removing Tentacle {#ManuallyuninstallTentacle-ManuallyremovingTentacle}

Expand All @@ -44,7 +44,7 @@ Learn about [Tentacle configuration and file storage](/docs/administration/manag
These steps will remove all traces of Octopus Tentacle from your computer:

1. Before uninstalling the MSI, use the Octopus Tentacle Manager to delete the Tentacle instance from the computer.
- This will stop and uninstall the Tentacle windows service.
- This will stop and uninstall the Tentacle Windows service.
2. Now uninstall the MSI.
- This will remove the application files.
3. Find and delete the Octopus Home folder. By default, this is in **`%SYSTEMDRIVE%\Octopus`**.
Expand Down Expand Up @@ -77,8 +77,8 @@ Removing entries from the registry can have serious implications. Please make su
- **`%LocalAppData%\Octopus`** - could be used for log files when a Home Directory cannot be discovered
6. Find and delete any Octopus certificates from the following certificate stores:
- **`Local Computer\Octopus`**
- **`Current User\Octopus`** - do this for any user accounts that have been used as the account for the Tentacle windows service
7. Find and delete any [scheduled tasks](/docs/administration/managing-infrastructure/service-watchdog) associated with the Tentacle windows service
- **`Current User\Octopus`** - do this for any user accounts that have been used as the account for the Tentacle Windows service
7. Find and delete any [scheduled tasks](/docs/administration/managing-infrastructure/service-watchdog) associated with the Tentacle Windows service

### Manually removing Tentacle without affecting the deployed applications {#ManuallyuninstallTentacle-ManuallyremovingTentaclewithoutaffectingthedeployedapplications}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Container images require that the source server or the default worker pool used
Local tools are locally installed versions of the tools listed in the "Required local tools" section. Using this option does not require Docker to be installed on the source server.

:::div{.hint}
If you are migrating from an on-premises Windows server, you will likely select the `Local tools` options.
If you are migrating from an on-premises Windows Server, you will likely select the `Local tools` options.
:::

### Required local tools
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ While it is possible to run SQL Server in container, we do not recommend it for

## Use a load balancer for the Octopus Deploy UI

The Octopus Deploy UI is a stateless React single-page application that leverages a RESTful API for its data. We recommend using a load balancer for Octopus Deploy as soon as possible. This will make it much easier to move to high availability. In addition, it'll be easy to rebuild or change the underlying Windows server or to move to Linux Containers in the future.
The Octopus Deploy UI is a stateless React single-page application that leverages a RESTful API for its data. We recommend using a load balancer for Octopus Deploy as soon as possible. This will make it much easier to move to high availability. In addition, it'll be easy to rebuild or change the underlying Windows Server or to move to Linux Containers in the future.

Any standard load balancer, be it F5, Netscaler, or provided via a cloud provider, will work. If you need a small load balancer, NGINX will provide all the functionality you’ll need.

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/deployments/databases/sql-server/redgate.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ This documentation assumes a Windows VM already has the Tentacle installed on it
![Tentacle communication mode selection in the Octopus Web Portal](/docs/img/deployments/databases/sql-server/images/redgate-octopus-create-worker-select-tentacle-type.png)
:::

### Install the Tentacle on a Windows server {#install-the-tentacle-on-a-windows-server}
### Install the Tentacle on a Windows Server {#install-the-tentacle-on-a-windows-server}

Next, install the Tentacle on a Windows server. Aside from the latest version of .NET, no other software is required. The Redgate tooling will be automatically downloaded during the deployment.
Next, install the Tentacle on a Windows Server. Aside from the latest version of .NET, no other software is required. The Redgate tooling will be automatically downloaded during the deployment.

:::div{.info}
The server needs to access the PowerShell gallery to download the Redgate tooling.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ For this guide, we will start with the following deployment process for the Octo
1. Notify stakeholders

:::figure
![original windows deployment process](/docs/img/deployments/patterns/rollbacks/dotnet-windows-rollbacks/images/original-windows-deployment-process.png)
![original Windows deployment process](/docs/img/deployments/patterns/rollbacks/dotnet-windows-rollbacks/images/original-windows-deployment-process.png)
:::

:::div{.success}
Expand All @@ -58,7 +58,7 @@ The updated deployment process will be:
1. Notify stakeholders

:::figure
![simple rollback for windows deployment](/docs/img/deployments/patterns/rollbacks/dotnet-windows-rollbacks/images/windows-simple-rollback-process.png)
![simple rollback for Windows deployment](/docs/img/deployments/patterns/rollbacks/dotnet-windows-rollbacks/images/windows-simple-rollback-process.png)
:::

:::div{.success}
Expand All @@ -82,7 +82,7 @@ To skip these steps during a rollback, set the variable run condition to be:
We also recommend adding or updating the notes field to indicate it will only run on deployments.

:::figure
![windows updating notes field](/docs/img/deployments/patterns/rollbacks/dotnet-windows-rollbacks/images/windows-updating-notes-field.png)
![Windows updating notes field](/docs/img/deployments/patterns/rollbacks/dotnet-windows-rollbacks/images/windows-updating-notes-field.png)
:::

### Prevent release progression
Expand All @@ -91,7 +91,7 @@ We also recommend adding or updating the notes field to indicate it will only ru

## Complex rollback process

As mentioned earlier, re-deploying the website and windows service involves re-extracting the package, running configuration transforms, and any embedded scripts. Generally, those steps will finish within 60 seconds. However, re-deploying those packages carries a small amount of risk because variable snapshots can be updated. Or, the embedded scripts are complex and take time to finish.
As mentioned earlier, re-deploying the website and Windows service involves re-extracting the package, running configuration transforms, and any embedded scripts. Generally, those steps will finish within 60 seconds. However, re-deploying those packages carries a small amount of risk because variable snapshots can be updated. Or, the embedded scripts are complex and take time to finish.

By default, Octopus Deploy will keep all releases on your Windows Server (this can be changed via [retention policies](/docs/administration/retention-policies)), which means the previously extracted and configured Windows Service or Website already exists. Back in Octopus 3.x we added the system variable `Octopus.Action.Package.SkipIfAlreadyInstalled`. When that variable is set to `True`, Octopus Deploy will:

Expand All @@ -116,7 +116,7 @@ The resulting process will be:
1. Notify stakeholders

:::figure
![windows complex rollbacks](/docs/img/deployments/patterns/rollbacks/dotnet-windows-rollbacks/images/windows-complex-rollbacks.png)
![Windows complex rollbacks](/docs/img/deployments/patterns/rollbacks/dotnet-windows-rollbacks/images/windows-complex-rollbacks.png)
:::

:::div{.success}
Expand All @@ -143,7 +143,7 @@ Adding the system variable `Octopus.Action.Package.SkipIfAlreadyInstalled` will
```

:::figure
![windows skip if already installed](/docs/img/deployments/patterns/rollbacks/dotnet-windows-rollbacks/images/windows-skip-if-already-installed.png)
![Windows skip if already installed](/docs/img/deployments/patterns/rollbacks/dotnet-windows-rollbacks/images/windows-skip-if-already-installed.png)
:::

### Windows Service rollback
Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/deployments/patterns/rollbacks/nginx/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The updated deployment process will be:
1. Notify stakeholders

:::figure
![simple rollback for windows deployment](/docs/img/deployments/patterns/rollbacks/nginx/images/rollback-nginx-simple-rollback.png)
![simple rollback for Windows deployment](/docs/img/deployments/patterns/rollbacks/nginx/images/rollback-nginx-simple-rollback.png)
:::

:::div{.success}
Expand All @@ -81,7 +81,7 @@ To skip these steps during a rollback, set the variable run condition to be:
We also recommend adding or updating the notes field to indicate it will only run on deployments.

:::figure
![windows updating notes field](/docs/img/deployments/patterns/rollbacks/nginx/images/rollback-nginx-notes-field.png)
![Windows updating notes field](/docs/img/deployments/patterns/rollbacks/nginx/images/rollback-nginx-notes-field.png)
:::

### Block release progression
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/infrastructure/accounts/ssh-key-pair.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ If you need more information about generating an SSH key pair, see the [useful l

### Generating a key pair on Windows {#generate-key-pair-windows}

The easiest way to generate valid keys on windows is to use a tool like[ PuTTYgen](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html). Start by clicking "Generate" and wait for the tool to finish creating the random key pair.
The easiest way to generate valid keys on Windows is to use a tool like[ PuTTYgen](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html). Start by clicking "Generate" and wait for the tool to finish creating the random key pair.

:::figure
![](/docs/img/infrastructure/accounts/ssh-key-create-putty.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Once both Tentacles are installed and configured ensure that neither node has th

## Configure a new clustered service {#ClusteringTentacles-NewCluster}

Ensure each node that will be participating in the Tentacle Cluster is joined to the Active Directory Domain and has the **Failover Clustering** feature installed in Windows. For more information on installing the Failover Clustering feature in Windows please see the [Microsoft Failover Clustering documentation](https://blogs.msdn.microsoft.com/clustering/2012/04/06/installing-the-failover-cluster-feature-and-tools-in-windows-server-2012/ "installing the failover cluster service feature and tools in windows server 2012").
Ensure each node that will be participating in the Tentacle Cluster is joined to the Active Directory Domain and has the **Failover Clustering** feature installed in Windows. For more information on installing the Failover Clustering feature in Windows please see the [Microsoft Failover Clustering documentation](https://blogs.msdn.microsoft.com/clustering/2012/04/06/installing-the-failover-cluster-feature-and-tools-in-windows-server-2012/ "installing the failover cluster service feature and tools in Windows Server 2012").

Open the **Failover Cluster Manager** console on one of the nodes. If there is no cluster configured yet, you can right-click **Failover Cluster Manager** and select **New Cluster**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ If there is an available port, we recommend using [TCP Polling Tentacles](/docs/
The following prerequisites must be met to use this feature:

- Octopus Server must be self-hosted, and not an [Octopus Cloud](/docs/octopus-cloud) instance.
- Both the Octopus Server and Tentacle must be running windows 2012 or later.
- Both the Octopus Server and Tentacle must be running Windows 2012 or later.
- The server expects an SSL/TLS connection, so SSL offloading is not supported.
- The other application using the port must be using the standard Windows networking library ([HTTP.sys](https://docs.microsoft.com/en-us/iis/get-started/introduction-to-iis/introduction-to-iis-architecture#hypertext-transfer-protocol-stack-httpsys)). This includes IIS, .NET apps and Octopus itself. However, it does not include any applications that use non-HTTP.sys TCP/IP or HTTP stacks. Check your product's documentation for more information.
- The other application must be using HTTPS on that port.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2023-01-01
title: Permissions for the Octopus Windows Service
description: Information about the permissions required by the Octopus windows service to operate.
description: Information about the permissions required by the Octopus Windows service to operate.
navOrder: 5
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you don't want Octopus to automatically create the database for you as part o
1. The database must use a **case-insensitive collation** (a collation with a name containing "\_CI\_").
1. If you are using **Integrated Authentication** to connect to your database:
- The user account installing Octopus must be a member of the **db\_owner** role for that database.
- The account the Octopus Deploy windows server process runs under (by default, the `Local System` account) must be a member of the **db\_owner** role for that database.
- The account the Octopus Deploy Windows Server process runs under (by default, the `Local System` account) must be a member of the **db\_owner** role for that database.
2. If you are using **SQL Authentication** to connect to your database, the SQL user account defined in your connection string must be a member of the **db\_owner** role for that database.

## Changing the database collation
Expand Down
Loading