Skip to content
Merged
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,12 +71,16 @@ You do not need session affinity. Any node can serve any Tentacle.

Configuring a Redis connection string enables multi-node support for Polling Tentacles; removing it disables it. Configure **every node** in the cluster with the same connection string.

The value is a [StackExchange.Redis connection string](https://stackexchange.github.io/StackExchange.Redis/Configuration.html), for example:
The value is a [StackExchange.Redis connection string](https://github.com/StackExchange/StackExchange.Redis/blob/main/docs/Configuration.md), for example:

```text
your-redis-host:6380,password=your-secret-password,ssl=true
your-redis-host:6379,password=your-secret-password
```

This example uses the default Redis port, `6379`. If your Redis uses a different port, use that instead.

If your Redis requires TLS, add `ssl=true`.

### Windows and Linux servers

1. Configure the [cluster shared directory](#cluster-shared-storage) with the [path command](/docs/administration/octopus.server.exe-command-line/path):
Expand Down Expand Up @@ -108,9 +112,11 @@ your-redis-host:6380,password=your-secret-password,ssl=true
For example, to set the Redis connection string using the command line, run the [configure command](/docs/administration/octopus.server.exe-command-line/configure):

```powershell
Octopus.Server.exe configure --instance="OctopusServer" --multiNodePollingTentaclesRedisConnectionString="your-redis-host:6380,password=your-secret-password,ssl=true"
Octopus.Server.exe configure --instance="OctopusServer" --multiNodePollingTentaclesRedisConnectionString="your-redis-host:6379,password=your-secret-password"
```

On Windows, this usually needs to be run as an administrator.

The command checks that the connection string is valid before saving it. The value is treated as sensitive, so it is masked in the command's output.
1. Restart each node. The setting takes effect when Octopus Server starts.
1. [Check the connection to Redis](#check-redis).
Expand Down Expand Up @@ -162,7 +168,7 @@ octopus:
multiNodePollingTentacles:
enabled: true
redis:
connectionString: "your-redis-host:6380,password=your-secret-password,ssl=true"
connectionString: "your-redis-host:6379,password=your-secret-password"
```

This setting is under `octopus.multiNodePollingTentacles`, not the top-level `redis` key, which only controls the in-cluster Redis. Leave `redis.enabled` set to `false`. If it is `true`, the chart ignores your connection string and uses the in-cluster Redis.
Expand Down Expand Up @@ -277,7 +283,7 @@ When multi-node support for Polling Tentacles is enabled, Octopus temporarily st
## Troubleshooting

**The configure command reports that the Redis connection string is not valid.**
Check the value follows the [StackExchange.Redis connection string format](https://stackexchange.github.io/StackExchange.Redis/Configuration.html). Wrap the whole value in quotes so your shell does not split it on commas.
Check the value follows the [StackExchange.Redis connection string format](https://github.com/StackExchange/StackExchange.Redis/blob/main/docs/Configuration.md). Wrap the whole value in quotes so your shell does not split it on commas.

**`IsReachable` is `false`.**
Check that the node can reach the Redis host and port through any firewalls, that the password is correct, and that `ssl=true` is set if your Redis requires TLS.
Expand Down
Loading