Deploy with Docker Compose

Neutree supports deploying monitoring components and control plane using Docker Compose. It is recommended to deploy monitoring components and control plane on separate hosts to improve platform availability and performance.

Configure Operating System

Please refer to the following sections to configure the system and install Docker as the container runtime based on your operating system type.

System Configuration

RHEL/Rocky Linux

1. Configure static IP address:

   sudo vi /etc/sysconfig/network-scripts/ifcfg-<interface>

   Replace <interface> with your network interface name, such as eth0.

2. Configure DNS server:

   sudo vi /etc/resolv.conf

3. Disable firewall:

   sudo systemctl stop firewalld && sudo systemctl disable firewalld

4. Disable SELinux:

   echo -e "SELINUX=disabled\nSELINUXTYPE=targeted" | sudo tee /etc/selinux/config
   sudo setenforce 0

Ubuntu

1. Configure static IP address and DNS server:

   sudo vi /etc/netplan/50-cloud-init.yaml

2. Apply the network configuration:

   sudo netplan apply

3. Disable firewall:

   sudo ufw disable

4. Optional: Disable AppArmor as needed:

   sudo systemctl disable apparmor && sudo systemctl stop apparmor

5. Reboot the operating system to apply the configuration:

   sudo reboot

Install Docker

RHEL/Rocky Linux

1. Install Docker CE:

   sudo dnf -y install dnf-plugins-core
   sudo dnf config-manager --add-repo https://download.docker.com/linux/rhel/docker-ce.repo
   sudo dnf -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

2. Start Docker service:

   sudo systemctl enable --now docker

3. Verify Docker installation:

   docker --version

4. Reboot the operating system to apply the configuration:

   sudo reboot

Ubuntu

1. Update package index:

   sudo apt-get update
   sudo apt-get -y install ca-certificates curl

2. Add Docker GPG key:

   sudo install -m 0755 -d /etc/apt/keyrings
   sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
   sudo chmod a+r /etc/apt/keyrings/docker.asc

3. Add Docker repository:

   echo \
    "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
    $(. /etc/os-release && echo "${UBUNTU_CODENAME:-$VERSION_CODENAME}") stable" | \
    sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

4. Install Docker CE:

   sudo apt-get update
   sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

5. Start Docker service:

   sudo systemctl enable --now docker

6. Verify Docker installation:

   docker --version

Deploy Monitoring Components

Log in to the host where you will deploy the monitoring components.

Preparation

1. Download the Neutree CLI from GitHub Releases according to your server’s CPU architecture:

   # For amd64
   curl -LO https://github.com/neutree-ai/neutree/releases/download/v1.0.0/neutree-cli-amd64
   
   # For aarch64
   curl -LO https://github.com/neutree-ai/neutree/releases/download/v1.0.0/neutree-cli-aarch64

2. Rename and grant executable permissions to the CLI:

   mv neutree-cli-<arch> neutree-cli
   chmod +x neutree-cli

   Replace <arch> with your server’s CPU architecture: amd64 or aarch64.

3. Download the control plane offline image file for the specified version from GitHub Releases.

4. Load the control plane offline image using the CLI tool:

   Pull Images Locally

   ./neutree-cli import controlplane \
     --package <controlplane_package> \
     --local

   Parameter	Description
   <controlplane_package>	Control plane offline image filename, format: neutree-controlplane-v1.0.0-<arch>.tar.gz.

   Pull Images from Remote Registry

   ./neutree-cli import controlplane \
     --package <controlplane_package> \
     --mirror-registry <mirror_registry> \
     --registry-username <registry_username> \
     --registry-password <registry_password>

   Parameter	Description
   <controlplane_package>	Control plane offline image filename, format: neutree-controlplane-v1.0.0-<arch>.tar.gz.
   <mirror_registry>	Image registry address.
   <registry_username>	Image registry username with image upload permissions.
   <registry_password>	Image registry login password or access key (e.g., token).

Steps

1. Start the monitoring service:

   Pull Images Locally

   ./neutree-cli launch obs-stack

   Pull Images from Remote Registry

   ./neutree-cli launch obs-stack \
     --mirror-registry <mirror_registry>

   Parameter	Description
   <mirror_registry>	Image registry address.

2. Access http://<obstack_ip>:3030/. If the Grafana login interface appears, the monitoring components have been successfully deployed.

   Replace <obstack_ip> with the IP address of the server where the monitoring components are deployed.

Deploy Control Plane

Log in to the host where you will deploy the control plane.

Preparation

1. Run the following command to generate a random JWT secret:

   openssl rand -base64 32 | tr '+/' '-_' | tr -d '='

   Note

   Neutree uses JWT (JSON Web Token) for authentication and authorization. The JWT secret ensures the security of the JWT.

2. Download the Neutree CLI from GitHub Releases according to your server’s CPU architecture:

   # For amd64
   curl -LO https://github.com/neutree-ai/neutree/releases/download/v1.0.0/neutree-cli-amd64
   
   # For aarch64
   curl -LO https://github.com/neutree-ai/neutree/releases/download/v1.0.0/neutree-cli-aarch64

3. Rename and grant executable permissions to the CLI:

   mv neutree-cli-<arch> neutree-cli
   chmod +x neutree-cli

   Replace <arch> with your server’s CPU architecture: amd64 or aarch64.

4. Download the control plane offline image file for the specified version from GitHub Releases.

5. Load the control plane offline image using the CLI tool:

   Pull Images Locally

   ./neutree-cli import controlplane \
     --package <controlplane_package> \
     --local

   Parameter	Description
   <controlplane_package>	Control plane offline image filename, format: neutree-controlplane-v1.0.0-<arch>.tar.gz.

   Pull Images from Remote Registry

   ./neutree-cli import controlplane \
     --package <controlplane_package> \
     --mirror-registry <mirror_registry> \
     --registry-username <registry_username> \
     --registry-password <registry_password>

   Parameter	Description
   <controlplane_package>	Control plane offline image filename, format: neutree-controlplane-v1.0.0-<arch>.tar.gz.
   <mirror_registry>	Image registry address.
   <registry_username>	Image registry username with image upload permissions.
   <registry_password>	Image registry login password or access key (e.g., token).

Steps

1. Start the control plane service:

   Pull Images Locally

   ./neutree-cli launch neutree-core \
     --version=v1.0.0 \
     --metrics-remote-write-url=http://<obstack_ip>:8480/insert/0/prometheus/ \
     --jwt-secret=<jwt_secret> \
     --grafana-url=http://<obstack_ip>:3030 \
     --admin-password=<admin_password>

   Parameter	Description
   <obstack_ip>	IP address of the server where the monitoring components are deployed.
   <jwt_secret>	JWT secret string generated in the preparation step.
   <admin_password>	Initial password for the Neutree administrator. Optional but recommended to set a custom initial password. If left empty, the system will auto-generate one, which can be retrieved after deployment using kubectl -n neutree logs -l app.kubernetes.io/component=neutree-post-migration-hook-job.

   Pull Images from Remote Registry

   ./neutree-cli launch neutree-core \
     --version=v1.0.0 \
     --metrics-remote-write-url=http://<obstack_ip>:8480/insert/0/prometheus/ \
     --jwt-secret=<jwt_secret> \
     --grafana-url=http://<obstack_ip>:3030 \
     --admin-password=<admin_password> \
     --mirror-registry=<mirror_registry>

   Parameter	Description
   <obstack_ip>	IP address of the server where the monitoring components are deployed.
   <jwt_secret>	JWT secret string generated in the preparation step.
   <admin_password>	Initial password for the Neutree administrator. Optional but recommended to set a custom initial password. If left empty, the system will auto-generate one, which can be retrieved after deployment using kubectl -n neutree logs -l app.kubernetes.io/component=neutree-post-migration-hook-job.
   <mirror_registry>	Image registry address.

2. Check service status:

   docker ps

3. Access http://<control_plane_ip>:3000 using the administrator account admin@neutree.local and the initial password. Successfully accessing the Neutree management interface indicates successful deployment.

   Replace <control_plane_ip> with the IP address of the server where the control plane is deployed.