Install Network Connector

There are two steps to install the Network Connector:

• Setting up the Network Connector Server.
• Installing and configuring Network Connector Agents.

Requirements

• 250 concurrent connections per active SNC - 1 GB Memory, 1 VCPU, 1GB NIC.
• 750 concurrent connections per active SNC - 2 GB Memory, 2 VCPU, 1GB NIC.
• 1500 concurrent connections per active SNC - 4 GB Memory, 4 VCPU, 1GB NIC.

The Network Connector Server needs to be set up only once, whereas Connector Agents should be installed and configured in every network not currently connected to senhasegura.

Configure Network Connector Server

To set up your Network Connector Server, run the command orbit network-connector on an instance of senhasegura.

Enter orbit network-connector --help to see all the optional arguments for this command.

Follow the steps below to set up your Network Connector Server:

1. Use the terminal to access each senhasegura instance.
2. Run the following command:

sudo orbit network-connector setup

3. Press Y when asked to confirm and wait for the process to complete.

This process will return either a success or an error message. All possible return messages are listed below.

Add a Network Connector Agent

Now that your Network Connector Server has been set up use senhasegura's web interface to follow the steps below:

1. Go to Devices ➔ Settings ➔ Network Connector ➔ Connectors to find your Connector listed.
2. In the Action column, click the Edit button.
3. Go to the Agents tab.
4. Type the Name and Port of all the Agents you want to add to this Connector. Only use ports between 30000 and 30999.
5. Finally, click the Save button.

Where to Find the Network Connector Fingerprint

Adding new Agents requires the fingerprint that was generated during setup. To find the fingerprint, follow the steps below:

1. Log into senhasegura's web interface.
2. Go to Devices ➔ Settings ➔ Network Connector ➔ Connectors
3. In the Action column, click on Details.
4. This will open a new window. Click the fingerprint icon.
5. Copy the fingerprint displayed.

How to Install a Network Connector Agent

Requirements

To install the Network Connector Agent, follow these steps:

1. Use a Linux machine with Docker installed. Make sure senhasegura has no access to this network.
2. Create a file (vim docker-compose.yml) with the Agent settings.

Standalone Installation

• SENHASEGURA_FINGERPRINT: Refer to the section Where to Find the Network Connector Fingerprint 
• SENHASEGURA_AGENT_PORT: Use a port between 30000 e 30999  that is not currently used.
• SENHASEGURA_AGENT_SECONDARY(optional): Choose true or false to enable or disable a secondary agent. Secondary agents are used when the primary agent is unavailable.
• SENHASEGURA_ADDRESS: the IP address for your senhasegura instance, e.g. “192.168.10.20”

services:
  senhasegura-network-connector-agent:
    image: "registry.senhasegura.io/network-connector/agent-v2:latest"
    restart: unless-stopped
    networks:
      - senhasegura-network-connector
    environment:
      SENHASEGURA_FINGERPRINT: "CHANGE_ME"
      SENHASEGURA_AGENT_PORT: "CHANGE_ME"
      SENHASEGURA_ADDRESSES: "CHANGE_ME"
      SENHASEGURA_AGENT_SECONDARY: "false"

networks:
  senhasegura-network-connector:
    driver: bridge

Cluster Installation

• SENHASEGURA_FINGERPRINT: Refer to the section Where to Find the Network Connector Fingerprint 
• SENHASEGURA_AGENT_PORT: Use a port between 30000 e 30999  that is not currently used.

• SENHASEGURA_AGENT_SECONDARY(optional): Choose true or false to enable or disable a secondary agent. Secondary agents are used when the primary agent is unavailable.
• SENHASEGURA_ADDRESS: the IP address for your senhasegura instance, e.g. “192.168.10.20”
  
  
  Important

  Change the instance number in the SENHASEGURA_ADDRESSES line according to the number of instances in your cluster, separating each IP with a comma.

  
  

services:
  senhasegura-network-connector-agent:
    image: "registry.senhasegura.io/network-connector/agent-v2:latest"
    restart: unless-stopped
    networks:
      - senhasegura-network-connector
    environment:
      SENHASEGURA_FINGERPRINT: "CHANGE_ME"
      SENHASEGURA_AGENT_PORT: "CHANGE_ME"
      SENHASEGURA_ADDRESSES: "CHANGE_ME"
      SENHASEGURA_AGENT_SECONDARY: "false"

networks:
  senhasegura-network-connector:
    driver: bridge

3. To complete, run the command sudo docker-compose up -d to start the Agent container.

Choosing the version of the Agent

You can easily choose which version of the Agent should be used by changing the version of the container image. To change versions, edit the docker-compose.yml file.

Following the examples above, you will have the latest version of the Agent (image: "registry.senhasegura.io/network-connector/agent-v2:latest").

To use the Agent from version 3.26, type image: "registry.senhasegura.io/network- connector/agent-v2:3.26".

To use the Agent from version 3.27, type image: "registry.senhasegura.io/network- connector/agent-v2:3.27".

Use the same "3.XX" format to install Agents from different versions.

Next steps

• Device configuration