SSH Proxies provide bastion host-like functionality in non-transitive network segments where the Buttonwood Automation virtual appliance doesn't have direct connectivity to manage deployed workloads. The Automation appliance utilises SSH to configure a virtual machine node during a blueprint deployment (eg. run scripts, upload files, etc.).
SSH Proxies are deployed by an organisation into a network segment which will accept SSH commands from the Automation appliance. The SSH Proxy also has connectivity to deployed workloads and relays the SSH commands on behalf of the Automation appliance.
This article describes the steps required to manage SSH Proxies.
Prerequisites
- Administrative access to the Automation UI
- A deployed SSH server which will accept SSH connectivity from the Automation appliance and has connectivity to SSH on the deployed workloads, which is installed automatically during deployment
- Credentials configured with SSH keys to access the SSH Proxy host
Creating a SSH Proxy
This section describes the steps required to create a new SSH Proxy.
- Log into the Automation UI as an administrative user
- Navigate to Admin > Control Panel
- Select the SSH Proxies tile
- A list of existing SSH Proxies is displayed
- Click Add
- In the Add SSH Proxy screen, enter the following information:
- Description: A description for the SSH Proxy
- On the Add SSH Proxy - Scope Rule tab, select the scope where this SSH Proxy will be utilised
- On the Add SSH Proxy - Definition tab, enter the following information:
- Hostname/Address: Host name or IP Address of the SSH Proxy
- Credentials: The configured Credentials to access the SSH Proxy
- Port: The network port which the SSH Proxy host is listening on
- Click Add
- The SSH Proxy has been added
- If required, the configured SSH Proxies can be re-ordered by drag-and-drop functionality
Note: The SSH Proxy which is first matched during a deployment will be used
Removing an SSH Proxy
This section describes the steps required to remove an SSH Proxy.
- Log into the Automation UI as an administrative user
- Navigate to Admin > Control Panel
- Select the SSH Proxies tile
- A list of existing SSH Proxies is displayed
- On the SSH Proxy to be removed, select the Edit drop down list
Click Remove - Click Remove
- The SSH Proxy has been removed