Installation Guide

Deployment Description

WAAS Booster is a dynamic load-based scheduling tool designed for containerized environments. Depending on deployment environments, WAAS Booster can be deployed using either RPM or Kubernetes pods. The following describes the differences between the two deployment modes and their application scenarios.

Using RPM
1. Applies to environments with a small number of service nodes, such as small enterprises or startups. In these environments, complex resource management and scheduling are usually not required.
2. Applies to environments where Kubernetes is not adopted for containerized management. These environments may use traditional VMs or physical machines to deploy applications.
3. Applies to scenarios where the O&M automation requirements are not high and manual maintenance and debugging are not frequent. RPM physical machine deployment reduces the dependency on automatic O&M tools and simplifies O&M.
Using Kubernetes pods
1. Applies to environments with many service nodes, such as large enterprises or Internet companies. These environments usually require efficient resource management and scheduling capabilities.
2. Applies to environments where Kubernetes is adopted for containerized management. In these environments, Kubernetes' automatic deployment, expansion, and management functions can be utilized.
3. Applies to scenarios where high O&M automation is required. This deployment mode allows for centrally creating, managing, and deleting WAAS Booster service pods on primary nodes, improving system reliability and availability.

When selecting a deployment mode, you should consider the preceding features and application scenarios based on your service requirements, technology stack, and O&M capabilities.

NOTE: Primary nodes refer to the management nodes in a Kubernetes cluster, and service nodes refer to the nodes deployed with specific services in a Kubernetes cluster.

Environment Requirements

This document provides guidance based on the openEuler OS. Before performing operations, ensure that your hardware and software meet the requirements.

OS and Software Requirements

Table 1 lists the OS and software requirements.

Table 1 OS and software requirements

Item	Version	How to Obtain
OS	openEuler 20.03 LTS SP3	Link
OS	openEuler 22.03 LTS SP4	Link
Python	3.9.9 or later	Link
Miniconda3	py310_25.1.1-2-Linux-aarch64	Link
Dependencies required by WAAS Booster	Versions specified in the installation guide	Install them using a Yum repository and pip source.
WAAS Booster open source package	1.0.0	Link

NOTE: WAAS Booster can be deployed only on service nodes.

This document provides guidance based on the openEuler OS. Before performing operations, ensure that your hardware and software meet the requirements.

Deploying WAAS Booster Using RPM

Installing the Operating Environment

Install the required dependencies to provide the environment for deploying WAAS Booster.

NOTE: For the root user, directly run the following commands. For a common user, add sudo before the following commands to elevate the permission.

Install the dependencies required for running the software.
```
yum install -y python rpm-build cpio
```
Download the Miniconda3 installation script.

Install Miniconda3 with default configuration.

sh Miniconda3-py310_25.1.1-2-Linux-aarch64.sh

Configure the path to the Miniconda3 binary in /etc/profile.
1. Open the file.
```
vim /etc/profile
```
2. Press i to enter the insert mode and add the following content to the end of the file:
```
export PATH=$PATH:/root/miniconda3/bin/
```
3. Press Esc to exit the insert mode. Type :wq! and press Enter to save the file and exit.
4. Make the file take effect.
```
source /etc/profile
```
Initialize the conda environment.
```
conda init
```
Exit the current SSH window and reconnect to the SSH window to ensure that conda takes effect.

NOTE: If the base environment is displayed after you re-enter the SSH window, run the conda deactivate command to exit the base environment. If the base environment is not displayed, no operation is required.
Use conda to create a Python environment, for example, waasbooster_env.
1. Add the conda-forge channel.
```
conda config --add channels conda-forge
```
2. Use conda-forge to create a Python environment.
```
conda create -n waasbooster_env python=3.9.9 -c conda-forge
```
Check the waasbooster_env environment path.
```
conda env list
```
The command output is as follows:
NOTE:
- If the waasbooster_env path in the command output in step 8 is not /usr/local/waasbooster/bin/python3, copy the path and use it to modify the configuration file after WAAS Booster is deployed.
- If the returned content is /usr/local/waasbooster/bin/python3, skip this modification.
Run the following command to go to the specified virtual environment:
```
conda activate waasbooster_env
```
Obtain the WAAS Booster open source package waas-waasbooster.zip. For details about how to obtain the package, see OS and Software Requirements. Upload waas-waasbooster.zip to a custom directory on the server and decompress the package.
```
unzip waas-waasbooster.zip
```
Run the following command to install the dependencies:
```
pip3 install -r waas-waasbooster/requirements.txt
```

Install the required dependencies to provide the environment for deploying WAAS Booster.

Creating a WAAS Booster RPM Package

Create a WAAS Booster RPM package.

Compile and build the WAAS Booster RPM package.

sh waas-waasbooster/build.sh build_booster_package

After the compilation is complete, go to the waas-waasbooster/output directory to check whether the RPM package is successfully built. If the waasbooster-1.0.0.aarch64.rpm file exists, the RPM package is successfully built.

Create a WAAS Booster RPM package.

Deploying WAAS Booster

This operation includes installing the WAAS Booster installation package and setting environment variables.

Install WAAS Booster.

NOTE: For the root user, directly run the following commands. For a common user, add sudo before the following commands to elevate the permission.
```
rpm -ivh waasbooster-1.0.0.aarch64.rpm
```
If the installation is successful, the following information will be displayed.
Modify the service file of WAAS Booster.
1. Check the waasbooster_env environment path.
```
conda env list
```
  For example, the returned value of waasbooster_env is /root/miniconda3/envs/waasbooster_env.
2. Open the /usr/lib/systemd/system/waasbooster.service file.
```
vim /usr/lib/systemd/system/waasbooster.service
```
3. Press i to enter the insert mode and modify the startup script.
  
  Change
```
ExecStart=/usr/local/waasbooster/bin/python3 /usr/local/waasbooster/cpu_booster.py
```
  to
```
ExecStart=/root/miniconda3/envs/waasbooster_env/bin/python3 /usr/local/waasbooster/waas_booster.py
```
  That is, change /usr/local/waasbooster in /usr/local/waasbooster/bin/python3 to the waasbooster_env path in the conda env list command output.
4. Press Esc to exit the insert mode. Type :wq! and press Enter to save the file and exit.
Reload the daemon of systemctl.
```
systemctl daemon-reload
```

This operation includes installing the WAAS Booster installation package and setting environment variables.

Running WAAS Booster

After WAAS Booster is installed, you need to start WAAS Booster before using the WAAS Booster functions.

NOTE: For the root user, directly run the following commands. For a common user, add sudo before the following commands to elevate the permission.

Starting WAAS Booster

Log in to the WAAS Booster installation node using an administrator account.
Start WAAS Booster on the installation node.
```
systemctl start waasbooster
```
Check the status of WAAS Booster.
```
systemctl status waasbooster
```
If information similar to the following (Active: active (running)) is displayed, WAAS Booster is started successfully.

Stopping WAAS Booster

NOTICE: Before stopping WAAS Booster, ensure that all running tuning tasks have been stopped.

Log in to the WAAS Booster node using an administrator account.
Stop WAAS Booster on the installation node.
```
systemctl stop waasbooster
```
Check whether WAAS Booster is stopped.
```
systemctl status waasbooster
```
If information similar to the following (Active: inactive (dead)) is displayed, WAAS Booster is stopped successfully.

After WAAS Booster is installed, you need to start WAAS Booster before using the WAAS Booster functions.

(Optional) Uninstalling WAAS Booster

You can uninstall WAAS Booster when it is not required.

NOTICE:

This operation is not mandatory for the deployment.

The default installation path of WAAS Booster is /usr/local/waasbooster/. After WAAS Booster is uninstalled, all files in this path are deleted.

After the uninstallation is complete, you are advised to manually delete the installation packages and logs located in /var/log/waasbooster.log.

Stop WAAS Booster.
```
systemctl stop waasbooster
```
Uninstall WAAS Booster.
```
rpm -e waasbooster
```

You can uninstall WAAS Booster when it is not required.

(Optional) Creating an Independent WAAS Booster RPM Package

Some deployment environments do not support network connections. As a result, the dependencies required by WAAS Booster cannot be installed. This section describes how to create an environment-independent RPM package.

NOTE:

The host where the RPM package is created must be able to access the external network.

For the root user, directly run the following commands. For a common user, add sudo before the following commands to elevate the permission.

Install the dependencies required for running the software.
```
yum install -y python rpm-build cpio
```
Download the Miniconda3 installation script.

Install Miniconda3 with default configuration.

sh Miniconda3-py310_25.1.1-2-Linux-aarch64.sh

Configure the path to the Miniconda3 binary in /etc/profile.
1. Open the file.
```
vim /etc/profile
```
2. Add the following content to the end of the file:
```
export PATH=$PATH:/root/miniconda3/bin/
```
3. Press Esc to exit the insert mode. Type :wq! and press Enter to save the file and exit.
4. Make the file take effect.
```
source /etc/profile
```
Initialize the created conda environment.
```
conda init
```
Exit the current SSH window and reconnect to the SSH window to ensure that conda takes effect.

NOTE: If the base environment is displayed after you re-enter the SSH window, run the conda deactivate command to exit the base environment. If the base environment is not displayed, no operation is required.
Use conda to create a Python environment, for example, waasbooster_env.
1. Add the conda-forge channel.
```
conda config --add channels conda-forge
```
2. Use conda-forge to create a Python environment.
```
conda create -n waasbooster_env python=3.9.9 -c conda-forge
```
Check the waasbooster_env environment path.
```
conda env list
```
The command output is as follows:
Run the following command to go to the specified virtual environment:
```
conda activate waasbooster_env
```
Create and go to the WAAS Booster RPM compilation path, for example, /home/waasbooster_rpm_build.
1. Create a path.
```
mkdir /home/waasbooster_rpm_build
```
2. Access the path.
```
cd /home/waasbooster_rpm_build
```

Copy the conda environment file to the RPM compilation path.

cp -r /root/miniconda3/envs/waasbooster_env/ /home/waasbooster_rpm_build/

Obtain and decompress the WAAS software installation package waas-waasbooster.zip.

For details about how to obtain the package, see OS and Software Requirements.
```
unzip waas-waasbooster.zip
```
Run the following command to install the dependencies:
```
pip3 install -r waas-waasbooster/requirements.txt
```

Copy the main program folder waasbooster.

cp -r waas-waasbooster/src/waasbooster/ /home/waasbooster_rpm_build/

Modify the waasbooster.service file.

Open the waasbooster.service file.

vim /home/waasbooster_rpm_build/waasbooster/waasbooster.service

Press i to enter the insert mode.

Change

ExecStart=/usr/local/waasbooster/bin/python3 /usr/local/waasbooster/waas_booster.py

ExecStart=/usr/local/waasbooster/waasbooster_env/bin/python3 /usr/local/waasbooster/waas_booster.py

Press Esc to exit the insert mode. Type :wq! and press Enter to save the file and exit.

Create files and save the specified content.

NOTE: For the root user, directly run the following commands. For a common user, add sudo before the following commands to elevate the permission.

Create a build.sh file and add the following content to the file:

#!/bin/bash
# ******************************************************************************** #
# Copyright Huawei Technologies Co., Ltd. 2023-2024. All rights reserved.
# File Name: build.sh
# Description: main script to be called for compilation and building
# Usage: sh build.sh clean --> Clean the environment.
#        sh build.sh build_debug --> Deploy the debugging environment. (You need to install the server and configure the WAAS_HOME environment variable first.)
#        sh build.sh build_package --> Perform packaging.
# ******************************************************************************** #
CURRENT_DIR=$(dirname $(readlink -f "$0"))
BUILD_DIR=${CURRENT_DIR}/build
mkdir -p ${BUILD_DIR}
mkdir -p ${CURRENT_DIR}/output
function clean() {
    rm -rf ${BUILD_DIR}/rpmbuild/*
    rm -rf ${CURRENT_DIR}/build
    rm -rf ${CURRENT_DIR}/output
    rm -rf ${CURRENT_DIR}/debug
}
function build_booster_package() {
    clean
    cd ${CURRENT_DIR}/
    mkdir -p ${BUILD_DIR}/rpmbuild/{BUILD,BUILDROOT,RPMS,SOURCES,SPECS,SRPMS}
    rm -rf build/rpmbuild/BUILDROOT/*
    cp -rf waasbooster_env ${BUILD_DIR}/rpmbuild/SOURCES
    build_waas_booster
}
function build_waas_booster() {
    mkdir -p ${CURRENT_DIR}/output
    cp waas_booster.spec ${BUILD_DIR}/rpmbuild/SPECS/
    find waasbooster -name '__pycache__' | xargs rm -rf
    zip -r ${BUILD_DIR}/rpmbuild/SOURCES/waasbooster.zip \
        waasbooster/* \
        waasbooster_env/*
    rpmbuild --define "_topdir ${BUILD_DIR}/rpmbuild" -v -ba ${BUILD_DIR}/rpmbuild/SPECS/waas_booster.spec --undefine=py_auto_byte_compile
    cp ${BUILD_DIR}/rpmbuild/RPMS/aarch64/waasbooster-1.0.0-1.aarch64.rpm ./output/waasbooster-1.0.0-1.aarch64.rpm
}
main() {
    item=$1
    eval ${item}
}
main "$@"
exit $?

Create a waas_booster.spec file and add the following content to the file:

%define projectdir /usr/local/waasbooster

Name:     waasbooster
Version:  1.0.0
Release:  1%{?dist}
Summary: Load awareness
License:    FIXME
BuildArch: %{_build_arch}
Vendor:     Huawei

Provides: waasbooster = 1.0.0

%description
WAAS Booster is an online container quota tuning tool.

%prep
unzip %{_sourcedir}/waasbooster.zip

%build


%install
mkdir -p %{buildroot}/usr/lib/systemd/system/
mkdir -p %{buildroot}/usr/bin/
mkdir -p %{buildroot}/%{projectdir}
cp %{_builddir}/waasbooster/* %{buildroot}/%{projectdir}

install -m 444 waasbooster/waasbooster.service %{buildroot}/usr/lib/systemd/system/waasbooster.service
cp -r %{_sourcedir}/waasbooster_env %{buildroot}/usr/local/waasbooster


%files
%dir %attr(644, waas, waas) %{projectdir}
%defattr (0440, waas, waas)
%{projectdir}/*
%dir %attr(644, waas, waas) %{projectdir}
%attr(644, root, root) /usr/lib/systemd/system/waasbooster.service
%dir %attr(750, waas, waas) /usr/local/waasbooster/waasbooster_env
%{projectdir}/waasbooster_env/*

#=======The preceding script is executed during packaging.========
#=======The following script is executed during installation and uninstallation.========

%pre -p /bin/sh
getent group waas &> /dev/null || \
groupadd -r waas &> /dev/null
getent passwd waas &> /dev/null || \
useradd -r -g waas -d /usr/local/waasbooster -s /sbin/nologin \
-c 'Waas booster' waas &> /dev/null
if [ $SUDO_USER ]; then
    usermod -a -G waas $SUDO_USER
elif [ $USER ]; then
    usermod -a -G waas $USER
else
    usermod -a -G waas `whoami`
fi
exit 0

%post -p /bin/sh
mkdir -p /var/waasbooster
chown waas:waas /var/waasbooster
chmod 750 /var/waasbooster
mkdir -p /var/run/waasbooster_manager
systemctl enable waasbooster.service
chmod +x /usr/local/waasbooster/waasbooster_env/bin/python3
exit 0

%preun -p /bin/sh
exit 0

%postun -p /bin/sh
rm -rf /usr/local/waasbooster
rm -rf /var/waasbooster
rm -rf /var/run/waasbooster_manager
exit 0

Compile the RPM package.
```
sh build.sh build_booster_package
```
The compilation result is output to the output folder in the compilation path, for example, /home/waasbooster_rpm_build/output/.
Install the independent RPM package.
NOTE:
- You can deploy and run the installation package without installing the WAAS Booster operating environment.
- Add the --nodeps command when installing the RPM package. Otherwise, the RPM package cannot be installed.
```
rpm -ivh --nodeps /home/waasbooster_rpm_build/output/waasbooster-1.0.0-1.aarch64.rpm
```
(Optional) Uninstall the independent RPM package.
```
rpm -e --nodeps waasbooster
```

Deploying WAAS Booster Using Kubernetes Pods

Building an Image

Pull and import the base Python image.

NOTE: You need to be able to access Docker Hub to pull images and use pip to pull dependencies.
1. Pull the python:3.9.9-slim image.
```
docker pull python:3.9.9-slim
```
2. View the image list.
```
docker images
```
  If the pull is successful, the following information is displayed:
Download the WAAS Booster open source package. For details, see OS and Software Requirements.

If you choose to pull the image, run the following command:
```
git clone -b waasbooster https://gitcode.com/boostkit/waas.git
```
Build the image.
1. Go to the waas folder.
```
cd waas
```
2. Build the image.
```
docker build -t waasbooster:1.0.0 .
```
  In the command, waasbooster is the name of the built image, and 1.0.0 is the image tag.
  
  Note that you need to use pip to pull dependencies. If you need to use the pip proxy, run the following command to specify a proxy server:
```
docker build --build-arg PIP_PROXY=http://username:password@http.example.com:8080 -t waasbooster:1.0.0 .
```
  If a specific pip image source is available, run the following command to specify the pip image source:
```
docker build \     
  --build-arg PIP_MIRROR=http://mirror.example.com/pypi/simple \     
  --build-arg PIP_TRUST_HOST=http://mirror.example.com \     
  -t waasbooster:1.0.0 .
```
3. View the image list.
```
docker images
```
  If the information similar to the following is displayed, the image is successfully built.
  
  NOTE: Import the built image to the image repository that can be accessed by service nodes, or manually import the image to each service node.
(Optional) Import the image into the containerd environment.

If the target cluster is implemented based on containerd, you need to export the waasbooster image built by Docker and import the image into the containerd environment.
1. Run the following command to export the container image and name it waasbooster.tar:
```
docker save -o waasbooster.tar waasbooster:1.0.0
```
2. Run the following command to import waasbooster.tar:
```
ctr -n k8s.io image import waasbooster.tar
```
3. Run the following command to check whether the image is successfully imported:
```
ctr -n k8s.io images list
```
  If the information similar to the following is displayed, the image is successfully imported.

Deploying Pods

Before the deployment, ensure that the deployment node has or can pull the built WAAS Booster image.

Copy the deployment file.

Copy the waasbooster.yaml file in the waas-waasbooster/deployment directory to the primary node of Kubernetes.
Create the waasbooster pod.
```
kubectl apply -f waasbooster.yaml
```
If the following information is displayed, the pod is created successfully.

NOTE: After a pod is created, the WAAS Booster service is automatically started.

Before the deployment, ensure that the deployment node has or can pull the built WAAS Booster image.

(Optional) Deleting Pods

To stop the WAAS Booster service in a cluster, you need to delete the pods. After the pods are deleted, the WAAS Booster service automatically stops, and the quota of all service pods is restored to the initial setting.

View pods.
```
kubectl get pods
```
If the following information is displayed, the waasbooster pods are running:
Delete the pods.
```
kubectl delete -f waasbooster.yaml
```
If the following information is displayed, the pods are deleted successfully.