You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/docs/octopus-cloud/connection-agent.md
+16-18Lines changed: 16 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,10 @@ navOrder: 67
7
7
description: How to set up and manage a Connection Agent to connect your Octopus Cloud instance to privately hosted internal applications
8
8
---
9
9
10
+
:::div{.warning}
11
+
Connection Agent is currently in Alpha, available only to Octopus Cloud Enterprise tier customers. [Contact our support team](https://octopus.com/support) to request access.
12
+
:::
13
+
10
14
Connection Agent lets your Octopus Cloud instance connect to privately hosted internal applications such as Git repositories, package feeds, and SMTP servers without requiring inbound firewall rules or a VPN.
11
15
12
16
A Connection Agent is a container image you deploy within your private network. It establishes outbound WebSocket connections to your Octopus Cloud instance and acts as a proxy, forwarding traffic between Octopus Cloud and your internal applications.
@@ -17,7 +21,7 @@ A Connection Agent is a container image you deploy within your private network.
17
21
18
22
## Supported applications
19
23
20
-
In the current release, Connection Agent supports the following application types:
24
+
Connection Agent supports the following application types:
@@ -32,21 +36,17 @@ In the current release, Connection Agent supports the following application type
32
36
- NuGet Feed
33
37
- OCI Container Registry
34
38
35
-
## How to access this feature
36
-
37
-
Connection Agent is currently in Alpha, available only to Octopus Cloud Enterprise tier customers.
38
-
39
-
If you would like to access this feature, please reach out to [our support team](https://octopus.com/support). By default, you can register up to 5 Connection Agents per instance. If you need more, contact [our support team](https://octopus.com/support) to discuss your requirements.
40
-
41
39
## Prerequisites
42
40
43
-
Before registering a Connection Agent, ensure your Octopus Cloud has Connection Agents enabled. If not, please contact [our support team](https://octopus.com/support).
41
+
Only users with `ConfigureServer` permission (e.g. belonging to the `Octopus Managers` team) can register new Connection Agents. Make sure you're a member of this team, or a team with `ConfigureServer` permission, before proceeding.
44
42
45
43
## 1. Connection Agent registration
46
44
47
-
Only users with `ConfigureServer` permission (e.g. belonging to `Octopus Managers` Team) on your Octopus Cloud instance can register new Connection Agents. Please ensure you are a member of this team or a team with `ConfigureServer` permission before proceeding.
45
+
:::div{.hint}
46
+
By default, you can register up to 5 Connection Agents per instance. [Contact our support team](https://octopus.com/support) if you need more.
47
+
:::
48
48
49
-
1. Decide on a meaningful `Agent Name` that will assist in identifying where the Connection Agent is deployed. This will be used by Octopus to determine which Connection Agent the configured applications will be routed to. Agent Names can be up to 200 characters and may include alphanumeric characters, hyphens (-), and periods (.).
49
+
1. Decide on a meaningful `Agent Name` that will assist in identifying where the Connection Agent is deployed. Octopus uses this to route configured applications to the right Connection Agent. Agent Names can be up to 200 characters and may include alphanumeric characters, hyphens (-), and periods (.).
50
50
51
51
1. Decide on a meaningful `Key Name` that will assist in identifying the private key credential the Connection Agent will use for authentication. Key Names can be up to 200 characters and may include alphanumeric characters, hyphens (-), and periods (.).
52
52
@@ -66,13 +66,11 @@ Only users with `ConfigureServer` permission (e.g. belonging to `Octopus Manager
66
66
67
67
1. [Create an API key](https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key) with a short expiry date on your Octopus Cloud instance. This API key will only be used to register the Connection Agent.
68
68
69
-
1. Register the Connection Agent with your Octopus Cloud instance.
70
-
71
-
This command doesn't need to be run on the same infrastructure you intend to run the Connection Agent on.
69
+
1. Register the Connection Agent with your Octopus Cloud instance. This command doesn't need to be run on the same infrastructure you intend to run the Connection Agent on.
72
70
73
71
Run the following command, substituting the values:
74
72
75
-
- `SERVER_URL` - This will be in the format `https://<dns-prefix>.octopus.app` where `<dns-prefix>` is the hostname of your Cloud Instance
73
+
- `SERVER_URL` - This will be in the format `https://<dns-prefix>.octopus.app` where `<dns-prefix>` is the hostname of your Cloud instance
76
74
- `OCTOPUS_API_KEY` - The API key created above
77
75
78
76
```bash
@@ -106,11 +104,11 @@ Only users with `ConfigureServer` permission (e.g. belonging to `Octopus Manager
For each application hosted over HTTPS with either an internal CAissued or self-signed certificate, add the `--ignore-certificate-validation-errors` option.
107
+
If an application uses an internal CA-issued or self-signed HTTPS certificate, add the `--ignore-certificate-validation-errors` option.
110
108
111
109
## 2. Connection Agent deployment
112
110
113
-
Deploy the [octopusdeploy/connection-agent](https://hub.docker.com/repository/docker/octopusdeploy/connection-agent) container into your desired private network, specifying the following environment variables returned when the Connection Agent was registered:
111
+
Deploy the [octopusdeploy/connection-agent](https://hub.docker.com/repository/docker/octopusdeploy/connection-agent) container into your desired private network, specifying the environment variables you received when you registered the Connection Agent.
114
112
115
113
- `AUTH_SERVER_DOMAIN`
116
114
- `AUTH_SERVER_CLIENT_ID`
@@ -207,9 +205,9 @@ The following commands are available:
207
205
208
206
For full flag listings, append `--help` to any command.
209
207
210
-
### Read-only view of registered Connection Agents
208
+
### View registered Connection Agents
211
209
212
-
You can view the registered Connection Agents in the UI. If you navigate to **Configuration ➜ Connection Agents**, you will see your registered agents.
210
+
You can view the registered Connection Agents by navigating to **Configuration ➜ Connection Agents**.
213
211
214
212
:::figure
215
213

0 commit comments