Quick Start

Configure Operating System

Please refer to this section to complete system configuration on the virtual machine or physical server to be deployed, and install Docker as the container runtime.

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

Download Deployment Tool

Install the Neutree CLI on the virtual machine or physical server to be deployed and grant it executable permissions. This CLI tool is used to deploy the monitoring components and control plane of Neutree.

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.

Deploy Monitoring Components

Use the Neutree CLI to deploy the OBSStack monitoring component to provide system monitoring and observability support for the platform.

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. If the monitoring service fails to start, check the monitoring service logs to troubleshoot:

   docker compose -f ./neutree-deploy/obs-stack/docker-compose.yml logs

Deploy Control Plane

Use the Neutree CLI to deploy the control plane with simplified configuration, providing the management interface.

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

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

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

2. 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 component is 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 component is 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.

3. If the control plane service fails to start, check the control plane service logs to troubleshoot:

   docker compose -f ./neutree-deploy/neutree-core/docker-compose.yml logs

Verify Deployment

After all services have started, verify the deployment.

1. Check all service statuses:

   docker ps

2. Access the Neutree management interface at http://<control_plane_ip>:3000 using the administrator account admin@neutree.local and the initial password.

   If you cannot access the Neutree management interface, please verify that the Docker service is running properly.