Skip to content
Brane Logo Brane

Deploy Proxy Node

Deploy Proxy Node

Section titled “Deploy Proxy Node”

Proxy nodes are optional components that allow communication between domains that cannot directly reach each other, typically when nodes are behind firewalls or NAT.

When to Use a Proxy

Section titled “When to Use a Proxy”

You need a proxy node when:

  • Worker nodes are behind corporate firewalls
  • Direct connections between nodes are blocked by network policy
  • You want a DMZ-based relay for security

If your nodes can communicate directly, you can skip proxy deployment.

Setup

Section titled “Setup”

The proxy node setup follows the same pattern as other nodes:

1. Download Images

Section titled “1. Download Images”
Terminal window
branectl download services proxy -f

2. Generate Configuration

Section titled “2. Generate Configuration”
Terminal window
branectl generate proxy -f -p ./config/proxy.yml
branectl generate node -f proxy <PROXY_HOSTNAME>

Replace <PROXY_HOSTNAME> with the address where other nodes can reach this proxy.

3. Configure Certificates

Section titled “3. Configure Certificates”

The proxy needs certificates for secure communication, similar to worker nodes. See the certificates guide.

4. Start

Section titled “4. Start”
Terminal window
branectl start proxy

Connecting Through a Proxy

Section titled “Connecting Through a Proxy”

To route a node’s traffic through a proxy, update the proxy.yml on the node that needs proxying. Refer to branectl generate proxy --help for available options.

Next Steps

Section titled “Next Steps”