Basic Installation

The NetBox Labs Enterprise Portal provides a guided installation experience that is strongly recommended for most NetBox Enterprise deployments.

Overview

The Enterprise Portal installation wizard:

• Guides you through configuration choices
• Automatically generates customized installation commands
• Provides environment-specific instructions
• Ensures best practices and optimal settings

Prerequisites

Before starting, ensure you have:

• Access to the NetBox Labs Enterprise Portal
• A Kubernetes cluster meeting the prerequisites
• A default storage class configured in your cluster (critical requirement)
• Helm 3.17.3+ installed on your workstation
• kubectl configured to access your cluster

Quick Check: Verify your cluster has a default storage class:

kubectl get storageclass
# Should show one storage class with "(default)" suffix

Installation Steps

Step 1: Access the Enterprise Portal

1. Log in to the NetBox Labs Enterprise Portal with your account credentials
2. Navigate to the "Install" tab

Step 2: Configure Your Installation

The portal presents configuration options tailored to your deployment needs:

Key configuration options include:

• Instance Name: A descriptive name for your installation
• Kubernetes Distribution: Select your platform (Amazon EKS, Azure AKS, Google GKE, OpenShift, Rancher, or Vanilla Kubernetes)
• Cluster Network Availability:
  • Outbound requests allowed (standard deployment)
  • Outbound requests require HTTPS Proxy (for restricted environments)
• Registry Access:
  • Full access from workstation (standard)
  • Limited access requiring offline transfer

Step 3: Follow Generated Instructions

After clicking "Continue", the portal generates customized installation instructions based on your selections.

The instructions include:

1. Version selection - Choose the NetBox Enterprise version to install (latest: 1.11.4)
2. Export credentials and log in - Commands to authenticate with the registry
3. Create values override file - Instructions for any customizations
4. Install the chart - Complete Helm commands for installation

The generated instructions will vary based on your configuration choices, such as:

• Additional steps for gathering images to private repositories
• Proxy configuration commands for restricted networks

Step 4: Execute Installation

Example installation commands (generated by Enterprise Portal):

# Export credentials
export SERVICE_ACCOUNT_TOKEN="your-service-account-token"
export USERNAME="your-email@company.com"

# Login to registries
docker login proxy.netboxlabs.com -u $USERNAME -p $SERVICE_ACCOUNT_TOKEN
helm registry login registry.netboxlabs.com -u $USERNAME -p $SERVICE_ACCOUNT_TOKEN

# Install NetBox Enterprise
helm install netbox-enterprise \
  oci://registry.netboxlabs.com/netbox-enterprise/beta/netbox-enterprise \
  --values netbox-enterprise-values.yaml \
  --version 1.11.4 \
  --create-namespace \
  --namespace netbox-enterprise

Installation in Environments with Restricted Connectivity

For environments with restricted internet access, follow these additional steps:

Step 1: Mirror Images to Private Registry

# Set your private registry URL
export MY_REGISTRY="mycompany.jfrog.io/nbe"

# Pull all required images (see complete list in prerequisites)
docker pull proxy.enterprise.netboxlabs.com/proxy/netbox-enterprise/ghcr.io/netboxlabs/nbe-core:4.2.9_main-90
# ... (complete list in prerequisites section)

# Tag and push to your registry
docker tag proxy.enterprise.netboxlabs.com/proxy/netbox-enterprise/ghcr.io/netboxlabs/nbe-core:4.2.9_main-90 \
  $MY_REGISTRY/netbox-enterprise/nbe-core:4.2.9_main-90
docker push $MY_REGISTRY/netbox-enterprise/nbe-core:4.2.9_main-90
# ... (repeat for all images)

Step 2: Create Private Registry Configuration

Download and customize the private registry template:

# Download the template
curl -O https://netboxlabs.com/docs/files/private-registry.yaml

# Update with your registry URL
sed -e 's|MY_REGISTRY|mycompany.jfrog.io/nbe|g' private-registry.yaml > my-private-registry.yaml

Step 3: Install with Private Registry

# Download Helm charts for offline installation
helm pull oci://registry.netboxlabs.com/netbox-enterprise/beta/netbox-enterprise --version 1.11.4

# Install with private registry configuration
helm install netbox-enterprise ./netbox-enterprise-1.11.4.tgz \
  --values netbox-enterprise-values.yaml \
  --values my-private-registry.yaml \
  --create-namespace \
  --namespace netbox-enterprise

Verify Installation

After running the installation commands, verify your deployment:

Check Pod Status

# View all pods
kubectl get pods -n netbox-enterprise

# Expected output should show all pods as Running

Access NetBox Enterprise

Retrieve the admin password:

kubectl -n netbox-enterprise get secret netbox-enterprise-secret-config -o jsonpath='{.data.password}' | base64 -d

Access the application:

# Port forward to access NetBox
kubectl port-forward -n netbox-enterprise svc/netbox-enterprise 8080:80

# Access at http://localhost:8080
# Username: admin
# Password: (from command above)

Next Steps

For additional verification steps or if you encounter issues:

• Troubleshooting - Common issues and solutions

For advanced configuration and day-2 operations:

• Advanced Installation - Custom configuration options