Skip to content

Commit 8b959eb

Browse files
committed
Content updates
1 parent c1c3634 commit 8b959eb

1 file changed

Lines changed: 16 additions & 18 deletions

File tree

src/pages/docs/octopus-cloud/connection-agent.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ navOrder: 67
77
description: How to set up and manage a Connection Agent to connect your Octopus Cloud instance to privately hosted internal applications
88
---
99

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+
1014
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.
1115

1216
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.
1721

1822
## Supported applications
1923

20-
In the current release, Connection Agent supports the following application types:
24+
Connection Agent supports the following application types:
2125

2226
- Git repositories (e.g. GitHub Enterprise, Bitbucket)
2327
- SMTP servers
@@ -32,21 +36,17 @@ In the current release, Connection Agent supports the following application type
3236
- NuGet Feed
3337
- OCI Container Registry
3438

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-
4139
## Prerequisites
4240

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.
4442

4543
## 1. Connection Agent registration
4644

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+
:::
4848

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 (.).
5050

5151
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 (.).
5252

@@ -66,13 +66,11 @@ Only users with `ConfigureServer` permission (e.g. belonging to `Octopus Manager
6666

6767
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.
6868

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.
7270
7371
Run the following command, substituting the values:
7472
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
7674
- `OCTOPUS_API_KEY` - The API key created above
7775
7876
```bash
@@ -106,11 +104,11 @@ Only users with `ConfigureServer` permission (e.g. belonging to `Octopus Manager
106104
add-fqdn --server-url $SERVER_URL --server-api-key $OCTOPUS_API_KEY --agent-name $AGENT_NAME --fqdn $FQDN
107105
```
108106
109-
For each application hosted over HTTPS with either an internal CA issued 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.
110108
111109
## 2. Connection Agent deployment
112110
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.
114112
115113
- `AUTH_SERVER_DOMAIN`
116114
- `AUTH_SERVER_CLIENT_ID`
@@ -207,9 +205,9 @@ The following commands are available:
207205
208206
For full flag listings, append `--help` to any command.
209207
210-
### Read-only view of registered Connection Agents
208+
### View registered Connection Agents
211209
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**.
213211
214212
:::figure
215213
![A screenshot of the Octopus UI showing registered Connection Agents](/docs/img/octopus-cloud/images/registered-connection-agents.png)

0 commit comments

Comments
 (0)