Getting Started with the Load Balancer Models App

This guide walks you through the initial setup and core functionality of the Nautobot Load Balancer Models App. The primary function of this app is to extend Nautobot's core data model to accurately represent load balancing environments, enabling effective management and integration within Nautobot.

For detailed installation instructions, see the Installation Guide.

Initial Configuration

After installation, your initial task is populating the Load Balancer App data model. This includes setting up essential data elements like Virtual Servers, Load Balancer Pools, Load Balancer Pool Members, Health Check Monitors, and Certificate Profiles. This data will serve as the foundation for managing load balancing configurations within Nautobot.

Looking for a full example?

This page walks you through creating each data model step-by-step. If you prefer to start with real-world data and configuration output, check out the F5 Simple Use Case or the F5 Advanced Use Case.

High-Level Steps for Data Population

Follow these general steps to properly configure and use the Load Balancer Models App:

1. IP Address and Subnet Preparation

• Ensure IP Addresses or Prefixes are already created within Nautobot’s IP Address Management (IPAM) module.
• Virtual Servers require unique IP Addresses (VIPs) sourced from IPAM.
• If you haven't already configured your IPAM, follow these instructions.

2. Creating Virtual Servers

• Navigate to the Load Balancer module within Nautobot's UI.
• Define a Virtual Server by assigning it a unique VIP from Nautobot’s IPAM module. Each Virtual Server represents a managed IP endpoint used to distribute incoming traffic to backend Pool Members.
• Select the protocol (TCP, UDP, HTTP, HTTPS, etc.) from available predefined choices.
• Associate the Virtual Server directly with a LoadBalancerPool.

3. Configuring Load Balancer Pools

• Set up LoadBalancerPools that can be associated with Virtual Servers.
• Define load balancing algorithms (e.g., round-robin, least connections).
• Optionally associate the pool with a Health Check Monitor to maintain high availability and performance.

4. Adding Load Balancer Pool Members

• Populate LoadBalancerPools with Pool Members by specifying individual IP Addresses, port numbers, and optional labels for easy identification.
• Pool Members represent backend servers responsible for processing client requests distributed by the pool.

5. Health Check Configuration

• Define Health Checks independently using the HealthCheckMonitor model.
• After creation, associate Health Checks with Pools and/or Pool Members to monitor their operational status, ensuring reliability and automatically disabling unhealthy servers.

6. Certificate Profile Configuration

• Certificate Profiles manage SSL/TLS settings, including the paths to certificate files, chain files, and private keys.
• Set certificate expiration dates and proactively manage renewals within Nautobot.
• Attach Certificate Profiles to Virtual Servers to handle secure communications effectively.

Key Features and Functionality

The Load Balancer App provides extensive features supporting complex, multi-vendor load balancing environments, including:

• Multi-vendor Support: Native compatibility with popular load balancing vendors including F5, Citrix NetScaler, A10 Networks, and Fortinet.
• CRUD Operations: Manage Load Balancer resources directly within Nautobot UI, REST API, and GraphQL.
• Integration and Extensibility: Leverage Nautobot’s extensibility framework for deeper integration with other applications and automation systems.
• Configuration Management: Generate basic load balancing configurations directly from stored data models.

Screenshots Showcasing Load Balancer Data Model

Here’s a complete screenshot block you can append to the "Screenshots Showcasing Load Balancer Data Model" section. It uses full GitHub-hosted paths (consistent with the other pages), includes clear ordering, and brief descriptions based on the data model and the data loaded in your Simple + Advanced use cases:

---

Screenshots Showcasing Load Balancer Data Model

A list view of all configured Virtual Servers, including name, load balancer type, protocol, and associated pools.

Detailed view of a single Virtual Server, showing the VIP, port, protocol, associated Certificate Profile, and linked Load Balancer Pool.

A list view of Load Balancer Pools, showing pool names and algorithms.

Detailed view of a specific Load Balancer Pool, including load balancing algorithm, associated pool members, and associated Health Check Monitor.

A list view of Load Balancer Pool Members, displaying IP Addresses, ports, and status.

Detailed view of an individual Load Balancer Pool Member, including its linked pool, port, health check monitor configuration, and certificate profile.

A list view of a Health Check Monitor showing health check types, port, interval, retry and timeout settings.

Detailed view of a Health Check Monitor including interval, timeout, and target port.

A list view of available Certificate Profiles used for SSL/TLS termination, showing certificate type and other optional fields.

Detailed view for a Certificate Profile, including certificate type, certificate file path, and key file paths.

Next Steps

For additional examples, advanced scenarios, and detailed configuration cases, see the Use Cases documentation.