Unix Server Tech Knowledge Base

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== High Availability in opnSense ======

This is just notes on how we built one. Both of our routers are virtuals, running under the KVM hypervisor. That allowed a bunch of shortcuts, such as defining vlans at the hypervisor levels and replicating a running router for the second one. We used two separate machines; the hypervisor was mainly so we could put some additional low resource virtuals on the same physical machine.

We'll need one share IP for each interface, so one IP for each router, and one shared one, so a total of 3 IP's set aside for the set.

===== Initial =====

  - Define network bridges to be used by the router, one per vlan to be used
  - Create one router (hint, tell the hypervisor to use the FreeBSD predefined)
    - Don't need much disk space; 10G appears to be just fine
    - In our machine, we did not have AES, so we increased processors to 4 and RAM to 8G
  - Do standard install, defining the network interfaces, etc...
  - Shut down virtual (router)
  - replicate configuration and storage to second machine
    - Reconfigure name
    - Reconfigure MAC addresses for virtual
  - Bring up second machine (first one still down). Connect and change name and IP's on all interfaces
  - Bring up first machine

You should now have two virtually identical installations, with only the name, IP's and MAC addresses different.

===== Configure HA =====

I did NOT set up as recommended with an additional interface only for CARP. Instead, I used the LAN interface for that.

  - Verify LAN interface accepts CARP. By default, it is set to accept all traffic from the LAN, but make sure this is the case (see Firewall | Rules | LAN)
  - On the primary router
    - Interfaces | Virtual IPs | Settings
      - Add
      - Mode: CARP
      - Interface: Choose one of the interfaces
      - Address: the shared IP address for that interface
      - Virtual IP Password: Choose a random password
      - VHID Group: push button for Select and unassigned VHID
      - Advertising Frequency:
        - Base: 1
        - Skew: 0
      - Description: make it simple. I use VIP "interface name", ie VIP WAN or VIP LAN. The VIP is for Virtual IP.
      - Save
      - Repeat for all other interfaces (hint, you can clone an interface, then change the Interface, Address, VHID Group and Description).
    - For each subnet which will be routing through the firewall, do the following. For example, if you have a subnet that only provides resources for other subnets, don't do this. But, for LAN, or anything else that will directly access the 'net. **You are setting outbound to use the CARP interface**:
      - Firewall | NAT | outbound
      - Change existing rules to use the CARP IP
      - Create new rules for any other subnets (hint, clone the LAN, then make the changes needed)

===== Additional =====

  - Change DHCP server to set the gateway to the Virtual IP
  - Change DHCP server to set DNS to correct value (if not using defaults)

===== Set up sync =====

  - On master router
    - System | High Availability | Settings
      - Synchronize States: check
      - Synchronize Interface: The interface it will communicate on
      - Synchronize Peer IP: the IP address of the backup router
      - Synchronize Conifig to IP: The same IP (IP of the backup router)
      - Remote System Username: A user on the backup router with full admin privileges
      - Remote System Password: Password for that user
      - Put a check mark in every system you want sync'd. At the very least, you need
        - Users and Groups
        - Certificates
        - Firewall Rules
        - Firewall Schedules
        - Firewall Categories
        - Aliases
        - NAT
        - DHCPD (well, I want them sync'd)
        - Virtual IP's (you MUST have this)
        - Static Router
        - OpenVPN, if you're going to use that
        - Firewall Groups
        - Unbound DNS (again, I want that)
      - Click Save
    - On backup Router
      - System | High Availability | Settings
        - Synchronize States: Check
        - Interface: Select correct interface
        - Synchronize Peer IP: IP of Master router
        - Save (Do **not** put any additional information in)
    - Reboot both firewalls if you want. Sometimes avoids problems
    - On master router
      - System | High Availability | Status
      - Click the little round thing at the bottom, where it says all(*)
      - Wait until it is done
    - Log into backup router
      - Look and ensure all services/rules/whatever have changed

===== Other Information =====

==== Do maintenance ====
One thing you can do with this setup is perform maintenance, with a fallback if something goes bump.
  - Update backup router
  - Open Primary Router
    - Firewall | Virtual IPs | Status
      - Click Enter Persistent CARP Maintenance Mode
      - Your backup router is now master
  - Test everything on the new update. If it all works, update the master router, then turn off the CARP Maintenance Mode
  - **Note**: Persistent Mode survives a reboot. You must manually turn it off

==== Testing ====

===== Links =====
  * https://docs.opnsense.org/manual/how-tos/carp.html