Add `NetBox Getting Started`

[abhi1693]

Change Type

Addition

Proposed Changes

Add a sub-category called NetBox Getting Started. This shouls have the following sections/files

• [x] Overview
• [x] System Requirements
• [x] Installation

Resolve By

2024-01-11

[abhi1693]

Overview

NetBox is a comprehensive solution for network automation, blending traditional IP address management (IPAM) and datacenter infrastructure management (DCIM) with robust APIs and extensions. As an open-source tool under the Apache 2.0 license, NetBox is essential for network automation in many organizations.

Key Features:

• Physical Infrastructure: Model everything from global regions to individual racks.
• Modern IPAM: Standard IPAM functionality plus advanced features like VRF tracking.
• Data Circuits: Seamlessly manage circuits alongside your infrastructure.
• Power Tracking: Detailed mapping of power distribution.
• Organization: Native management of tenant and contact assignments.
• Powerful Search: A global search function for quick access to resources.
• Comprehensive Logging: Track network changes and growth.
• Endless Customization: Custom fields, links, tags, and more.
• Flexible Permissions: Advanced, delegable permissions system.
• Integrations: REST & GraphQL APIs for easy connection to other tools.
• Plugins: Extend functionality with community or Onemind Services plugins.

Installation Components

The installation of NetBox on CloudMyDC includes:

NetBox Container

This is the core component where the NetBox application runs. It's packaged as a container, meaning all the necessary dependencies and the application code are bundled together to run in an isolated environment. This container interacts with other services to manage and document network setups.

NetBox Worker Containers

These are additional containers running services that handle background processing tasks for NetBox. They ensure that tasks such as handling webhooks, running custom scripts, and generating reports don't interfere with the main application's responsiveness by processing these tasks asynchronously.

PostgreSQL

PostgreSQL is the relational database system used by NetBox to store all its data. It is known for its robustness, performance, and compliance with SQL standards. Within the NetBox context, PostgreSQL stores information about network infrastructure, IP addresses, and all other data NetBox manages.

Redis

Redis is an in-memory data store used by NetBox as a cache and for queuing operations. It helps in speeding up the application by storing frequently accessed data in memory and by managing background tasks (which are handled by the worker containers).

NGINX Load Balancer

NGINX acts as a reverse proxy and load balancer. In a CloudMyDC environment, it can be used to distribute incoming network traffic across multiple NetBox instances, improving the application's scalability and reliability. It can also handle SSL termination, offloading the encryption/decryption workload from the application containers.

These components together form the infrastructure needed to deploy NetBox on a platform like CloudMyDC efficiently. Each plays a specific role in ensuring the application is scalable, reliable, and responsive.

[abhi1693]

System Requirements

The minimum and optimal consumption of RAM, CPU, and storage depends on the cluster size, installed components, active workload, etc.

Resources	Development	Production
NetBox Cloudlets	8	2 x 16
Worker Cloudlets	8	8
Postgresql Cloudlets	32	2 x 16
Redis Cloudlets	8	8
NGINX Cloudlets	8	8

Note (success):

• Measurements were performed on the bare development and production clusters without any additional load. Thus, the specified values are minimum system requirements, which can be much higher for the loaded clusters (especially production one).
• Development cluster topology includes:
  • 1 NetBox container
  • 1 worker (default queue)
  • 1 Redis
  • 1 PostgreSQL
  • 1 NGINX
  • 1 shared load balancer with built-in SSL
• Production cluster topology includes:
  • 2 NetBox containers
  • 1 worker (default queue)
  • 1 Redis
  • 2 PostgreSQL with 1 pgpool running in a master-slave configuration
  • 1 NGINX with public IP

The development cluster is recommended only as a sandbox environment. For production purposes, a highly available topology with PostgreSQL clustered setup is recommended. Depending on the expected load, the required number of workers can be added manually, or appropriate automatic horizontal scaling can be configured.

[abhi1693]

NetBox Installation

The NetBox application is available for automatic installation via the platform Marketplace under the Dev and Admin Tools section (or use the Search function to locate it). Note that this application is available for billing customers only.

Within the opened installation frame, customize the available options to get a cluster specifically tailored for your needs:

• Deployment Type: Select Development for a non-critical testing environment or Production for a stable, live deployment.
• NetBox Version: By default, the installation is set to the latest release version.
• Log Level: Preconfigured to INFO to capture routine operational data. Modify as needed to increase or decrease the detail in logs.
• Queue Configuration: Determine the number of tasks for the High Priority Queue, Default Priority Queue, and Low Priority Queue. The system defaults to a minimum of 1 for the Default Priority Queue.
• Database Disk Size: Initially allocated 10 GB for database storage. Consider expanding for larger datasets.
• Redis Disk Size: Set at 10 GB by default for caching and queuing. Adjust according to your caching needs.
• Environment Name: Designate a unique name for your environment to distinguish it within CloudMyDC.
• Display Name: Choose an alias for your NetBox deployment for easier identification.
• Region: Opt for a deployment region that aligns with your user base or specific geographic requirements.
• Scaling Strategy: (Only applicable for Production deployment type) Configure how the system scales in response to load changes:
  • Low Load: Adds 1 NetBox node when CPU usage exceeds 70% and removes it when CPU falls below 20%.
  • Medium Load: Increases nodes when CPU usage goes over 50% and scales down when it drops below 20%.
  • High Load: Scales up with a CPU usage over 30% and decreases when CPU is under 10%.

The default scaling strategy is set to Low Load, providing a conservative approach to scaling that suits most environments with regular traffic patterns.

Development Type

Production Type

Click the Install button and wait a few minutes for the platform to automatically configure your NetBox cluster.

[VKumar786]

NetBox Getting Started what will be its position in side bar menu of documentation