Skip to content

NetBox Enterprise Embedded Cluster Installation

Deploying the cluster

The following steps are required for an Embedded Cluster (EC) installation of NetBox Enterprise.

  1. Download the deployment package and license file to your host (the Authorization token should be provided by NetBox Labs):

curl https://replicated.app/embedded/netbox-enterprise/stable -H "Authorization: <provided by NetBox Labs>" -o netbox-enterprise-stable.tgz
2. Uncompress the package and launch the installation:

tar -xvzf netbox-enterprise-unstable.tgz
sudo ./netbox-enterprise install --license license.yaml

You’ll be requested to create a password for the NetBox Enterprise admin console. A Kubernetes cluster will then be deployed, ready to host all the NetBox application components. The deployment of the cluster is complete with this message:

Visit the Admin Console to configure and install netbox-enterprise: http://my.netbox-enterprise.host:30000

Deploying NetBox

Access the NetBox Enterprise admin console and configure NetBox.

Open the provided URL in a browser. A prompt will require the password created in Step 2:

Admin Console

A wizard will guide the configuration of NetBox for the environment:

NetBox Configuration

Configuration information includes:

  • Built-in or external PostgreSQL: Built-in or external PostgreSQL

  • Built-in or external S3-Compatible object store: Built-in or external S3

  • Built-in or external Redis object store: Built-in or external Redis

  • Advanced settings to configure plugins and SSO remote authentication, and IPv4/IPv6 compatibility: Advanced Settings

Finally, accept the terms of service by writing "ACCEPT" (case-insensitive) and you can proceed to the deployment.

Accept TOS

Finish the Deployment

Once you have accepted the terms of service and continued on to the main admin console, deployment will start. The first deployment will take some time, as it brings up all subsystems and runs migrations to initialize the database.

Deployment Started

The Unavailable status will change to Ready once the deployment is complete and NetBox has fully initialized:

Deployment Ready

Verify the Deployment

Once you see Ready, NetBox Enterprise is fully deployed, and available on ports 80 and 443.

  • NetBox Enterprise Login
  • NetBox Enterprise Home