Logo slack_icon Join Slack
Search — Netris Documentation

General Information

  • Definitions
  • Introduction to Netris
  • Netris Supported Functionality & Platforms Matrix
    • Switch Fabric Management Functions
    • Monitoring & Telemetry
    • External Routing Functions
    • Cloud Networking Functions & Constructs
    • Overlay Network Functions
    • AI Specific Functions
    • Compute Platform Integrations
    • Security
    • Netris Controller Administration
    • Management Interfaces
    • Hypervisor/Worker node specific functionality
  • SoftGate Data Plane Variations
  • Netris and NOS versions compatibility matrix
  • Hardware Requirements
    • Netris Controller
    • Netris SoftGate HS (Multi-VPC version)
  • Supported Switch Hardware
    • Nvidia
    • Dell
    • EdgeCore
    • Arista
  • Netris Architecture
    • Netris Controller
    • Netris Switch Agent
    • Netris SoftGate

Try & Learn Netris

  • Netris Try & Learn
    • Netris Infrastructure Simulation Platform
    • Netris Test Controller & Infrastructure Simulation
      • Web Console
      • SSH
      • Netris Init Modules
      • Start/Stop a Simulation
    • Lab Scenario: GPU-as-a-Service network with NVIDIA Spectrum-X architecture
      • Initialize the Netris controller
      • Start a simulation
      • Monitoring Dashboard
      • Topology
      • SSH to Switches
      • SSH to GPU servers
      • NHN (Netris host networking plugin)
      • Server Cluster Template
      • Server Cluster
      • Checking the connectivity
      • Cleanup the Controller

Detailed Installation

  • Controller Installation
    • Netris Controller installation on a generic Linux host
      • Linux Host requirements
      • Installation
        • Installation with the specific host name
        • Installation with the Let’s Encrypt SSL
        • Installation with the Custom SSL Issuer
      • Upgrading
      • Uninstalling
      • Backup and Restore
        • Backup
        • Restore
    • Helm Chart Installation
      • Requirements
      • Get Repo Info
      • Installing the Chart
      • Uninstalling the Chart
      • Chart Configuration
    • Netris Local Repository Setup
      • When & Why to Use the Local Repository?
      • How to Enable the Local Repository on the Netris Controller?
      • How to consume local repository
      • Upgrade Local-Repo Cache
    • Installing Netris Controller in Air-Gapped Environments
      • Why Air-Gapped Installation?
      • How to Install the Netris Controller
        • Prerequisites
        • Steps to Install
      • After Installation
      • How to consume local repository
    • Installing HA Netris Controller in Air-Gapped Environments
      • Why Air-Gapped Installation?
      • Why a High Availability (HA) Cluster?
      • Prerequisites
      • Obtain the Installation File
      • Steps to Install
        • 1. Preparing Each Node
        • 2. Install K3s on All Nodes
        • 3. Import Necessary Container Images
        • 4. Configure kube-vip for KubeAPI High Availability
        • 5. Add Helm Chart Packages to K3s
        • 6. Verify and Scale Core K3s Components
        • 7. Deploy Kube-VIP Cloud Controller
        • 8. Install Traefik Proxy
        • 9. Deploy the Netris Controller
        • 10. (Optional) Enable SSL with cert-manager
        • 11. Set Up the Local Netris Repository
        • 12. Validate Your Deployment
      • After Installation
      • How to consume local repository
    • Upgrading HA Netris Controller in Air-Gapped Environments
      • Obtain the Upgrade File
      • 1. Preparing Each Node
        • 1.1 Transfer the File to the Servers
        • 1.2 Extract the Tarball
        • 1.3 Navigate to the Installation Directory
      • 2. Steps to Upgrade Controller
        • 2.1 Import Necessary Container Images
        • 2.2 Add Helm Chart Packages Upgrades to K3s
        • 2.3 Upgrade Netris Controller
      • 3. Steps to Upgrade the Local Netris Repository
    • Maintenance Procedures
      • Node Maintenance Best Practices
        • Individual Node Maintenance (Recommended Approach)
        • Full Cluster Maintenance (When All Nodes Need Simultaneous Maintenance)
      • Verifying MariaDB Cluster Health
      • Maintenance Best Practices
  • Network Switch Initial Setup
    • Nvidia Cumulus v5.9+ Switch Initial Setup
    • Nvidia Cumulus v5 Switch Initial Setup
    • Ubuntu SwitchDev Switch Initial Setup
    • EdgeCore SONiC Switch Initial Setup
    • Dell SONiC Switch Initial Setup
    • Nvidia Cumulus v3.7 Switch Initial Setup
  • SoftGate HS Installation
    • Minimum Hardware Requirements
    • Provision Netris SoftGate software
  • SoftGate PRO Installation
    • Minimum Hardware Requirements
    • BIOS Configuration
    • Install the Netris Agent

Fabric Management

  • Inventory
    • Inventory Profiles
    • Adding Switches
    • Adding SoftGates
    • Viewing Inventory
  • Topology Manager
    • Adding Links
  • VPC
    • Adding new VPC
  • IP Address Management
    • Allocations and Subnets
    • IPAM Tree View
    • Add an Allocation
    • Add a Subnet
  • Basic BGP
    • Adding BGP Peers
  • Advanced BGP
    • BGP Objects
      • IPv4 Prefix
      • IPv6 Prefix
      • Community
    • BGP route-maps
    • eBGP Importing Non-Default Routes into a VPC
      • How to Import Non-Default Prefixes
  • Static Routing
  • NAT
    • Enabling NAT
    • Defining NAT rules
  • Looking Glass
  • Switch Ports
  • Link Aggregation (LAG)
    • Automatic LAG with EVPN Multi-homing
    • Custom LAG
  • Graph Boards
    • Graph Boards
    • API Logs
    • Dashboard
  • Maintenance Mode
    • Overview
    • Maintenance Mode for Softgate - What’s happening behind the scenes?
    • Maintenance Mode for Switch - What’s happening behind the scenes?
  • Upgrade and Rollback
    • Netris upgrade Procedure
      • Backup current database
      • Stop Netris Agents
      • Check your current version
      • Upgrade the Controller
      • Check the upgraded version
      • Upgrade Switches and SoftGate nodes
    • Rollback Procedure
      • Stop Netris Agents
      • Restore The Database
      • Downgrade the Controller Software
      • Downgrade Netris Agent Software

Services

  • V-Net
    • Introduction
    • L2VPN V-Nets
      • DHCP
      • DHCP Relay
        • Example:
      • V-Net Fields explained
      • Advanced V-Net Fields explained
      • Multisite V-Nets
      • Link Aggregation and Multihoming
        • Ethernet VPN Multi-Homing (EVPN-MH)
        • MC-LAG
      • Labels
        • How labels work
        • Rules and limits
        • When to use labels
    • L3VPN
      • Creating an L3VPN V-Net
      • Rules and limits
    • Verification Tools
      • UI Tools
  • Server Cluster
    • Introduction
    • Server Cluster Template
      • Server Cluster Template Examples:
        • Ethernet-only Fabric Example
        • Infiniband Fabric Example
        • IPv6 Example
      • Template Fields Explained:
      • Adding a Server Cluster Template
      • Advanced Uses
        • Non-overlapping subnets
        • Specify gateway
    • Creating Server Cluster
      • Adding a Server Cluster
      • Shared Endpoints
        • Untagged VLAN on Shared Endpoints
      • Server Cluster Fields Explained:
  • L4 Load Balancer (L4LB)
    • Enabling L4LB service
    • Consuming L4LB service
  • Access Control Lists (ACL)
    • ACL Default Policy
    • ACL Rules
    • ACL Approval Workflow
    • ACL Processing Order

Netris Integrations

  • NVIDIA UFM Integration Plugin for Netris Controller
    • Overview
      • Key Benefits
    • Architecture
    • Prerequisites
    • UFM Configuration Requirements
    • Installation
      • Option 1: Deploy within an existing Netris Controller Kubernetes cluster
      • Option 2: Deploy as a standalone Docker container
    • Configuration Parameters
      • Netris Controller Configuration
      • NVIDIA UFM Configuration
      • Agent Configuration
    • Usage Guide
      • 1. Server Configuration in Netris
      • 2. Create a Server Cluster Template
      • 4. Create Server Clusters
      • 3. Verification
      • 4. Monitoring Integration Status
    • Functional Workflow
    • Monitoring and Troubleshooting
      • Viewing Logs
      • Common Issues and Solutions
        • Connection Issues to Netris Controller or UFM
        • PKey Assignment Issues
        • SHARP Reservation Issues
        • Synchronization Delays
    • Version Compatibility
    • Getting Started Guide
      • Quick Setup Example
    • Additional Resources
  • Kubernetes Integration
    • Install Netris Operator
      • Helm Chart Method
      • Regular Manifest Method
    • Using Type ‘LoadBalancer’
    • Using Netris Custom Resources
      • Introduction to Netris Custom Resources
      • L4LB Custom Resource
      • V-Net Custom Resource
      • BGP Custom Resource
      • Importing existing resources from Netris Controller to Kubernetes
      • Reclaim Policy
    • Calico CNI Integration
      • Disabling Netris-Calico Integration
  • Netris-CloudStack Integration
    • High-Level Concept of Integration
      • How It Works
      • Challenges Addressed
      • Benefits
      • Use Cases
    • Compute and Network Architecture
      • Diagram Overview
      • Network Flow
    • Prerequisites
      • Step-by-Step Configuration Instructions for the Netris Controller
      • IPAM Setup
        • Create an Allocation
        • Create Subnets
      • Inventory Setup
        • Adding Servers
        • Creating Servers’ Links
        • Optimize BGP Overlay for Hypervisor
        • Adding Subnets for CloudStack Cluster
        • Enabling Internet Connectivity for ACS Servers
        • Enabling Access to CloudStack Management GUI
        • Creating CloudStack Networks
    • Server Configuration and Software Installation
      • Configuring Network on CloudStack Management Server (Server 1)
        • Understanding the Network Layout
        • Netplan Configuration
      • Install Netris-CloudStack Agent on Hypervisor Servers
        • Bringing Up NICs Before Installation
        • Pre-Installation Steps (For Deployments Without OOB)
        • Key Functions of the Netris-CloudStack Agent
        • Installation Steps
        • Example Successful Output of One-Liner Script
        • Verification Steps
        • Checking Network Connectivity
        • Finalizing the Network Setup
        • Keeping the Temporary OOB VNet for Emergency Access
        • Managing Additional NICs on the Server
      • Install CloudStack Management Service
        • Installation Steps
    • Configuring CloudStack for Netris Integration
      • Enabling the Netris Plugin in CloudStack
      • Initializing CloudStack Setup
        • Steps to Initialize CloudStack
    • Using CloudStack with Netris Isolation Method
      • Creating a VPC
      • Creating a Network Tier
      • Port Forwarding
        • Seamless Integration Between CloudStack and Netris
        • Step-by-Step Process for Configuring Port Forwarding in CloudStack with Netris
        • Key Notes:
      • Configuring Static NAT in CloudStack
        • How Static NAT Works with CloudStack and Netris
        • Steps to Configure Static NAT:
        • How CloudStack and Netris Work Together
        • Final Notes
  • Terraform: Netris provider
    • Install Terraform
    • Create a directory for Terraform files
    • Configure a provider
    • Prepare an infrastructure plan
    • Create resources
    • Delete resources

Monitoring & Observability

  • Monitoring & Observability
    • Topology & Wiring Validation
      • Switch-to-switch and Switch-to-SoftGate
      • Switch-to-Server
    • NVIDIA NetQ Integration
      • Topology Blueprint Activation

Tutorials

  • NHN - Netris Host Networking Plugin
    • Installation
      • Step 1: Install the Netris NHN Plugin
      • Step 2: Upload Required Packages
      • Step 3: Configure DPU Parameters
      • Step 5: Verify the Netris NHN Service
  • Netris VPC
    • Sites
    • IPAM
    • V-Nets
    • External connections
    • SiteMesh connections
    • NAT services
    • Load-balancing service
    • Access lists
    • Working with Netris VPC
  • Netris Generic Tutorials
    • Installing a Netris Controller
      • Security Matters
    • Upgrade and Rollback
      • Netris upgrade Procedure
        • Backup current database
        • Stop Netris Agents
        • Check your current version
        • Upgrade the Controller
        • Check the upgraded version
        • Upgrade Switches and SoftGate nodes
      • Rollback Procedure
        • Stop Netris Agents
        • Restore The Database
        • Downgrade the Controller Software
        • Downgrade Netris Agent Software
  • Getting Started with Switch-Fabric Manager & VPC
    • Netris managed fabric Overview
      • Introduction
      • Concept
    • Install a Netris Controller
      • Requirements and Installation steps
      • Security Matters
    • New Site setup
    • VPC setup
    • IPAM setup
    • Inventory setup
    • Topology setup
    • SoftGate software provisioning
      • SoftGate PRO (100G) software provisioning
      • SoftGate (1G, 10G) software provisioning
    • Netris Switch Agent Installation
    • Connecting Netris managed fabric to an ISP
    • Connecting servers to the Netris managed fabric
    • Enabling NAT services
    • Enabling Load-balancing services
    • More features

Miscellaneous

  • Accounts
    • Users
    • Tenants
    • Permission Groups
    • User Roles
  • SoftGate Performance
  • Learn Netris Operations with Kubernetes
    • Intro
    • Install Netris Operator
    • Deploy an Application with an On-Demand Netris Load Balancer
    • Using Netris Custom Resources
      • Introduction to Netris Custom Resources
      • L4LB Custom Resource
      • V-Net Custom Resource
      • BGP Custom Resource
      • Importing Existing Resources from Netris Controller to Kubernetes
      • Reclaim Policy
    • Netris Calico CNI Integration
      • Disabling Netris-Calico Integration
Netris docs
  • Search

© Copyright 2022, Netris.

Built with Sphinx using a theme provided by Read the Docs.
Alternate Versions v: 4.5.4
Versions
2.9
3.0
3.4
4.5.3
4.5.4
latest
Free theme by Read the Docs.