UpgradeLink

English

简体中文

English

简体中文

Appearance

UpgradeLink Cluster Deployment ​

This guide helps you quickly deploy and use UpgradeLink in Docker containers through UpgradeLink project image examples.

Before you begin, we hope you have the following experience:

  • Familiar with Docker containerized deployment.
  • Familiar with MySQL database.
  • Familiar with Redis cache.
  • Familiar with backend project deployment.
  • Read the project module introduction to understand the functions of each module. Project Module Introduction

1. Environment Preparation ​

You need to install Docker.

2. Download the Project ​

2.1. Download the project from GitHub ​

shell
git clone https://github.com/toolsetlink/upgradelink

3. Modify the configurations of MySQL and Redis to replace with your own database-related information. ​

Note 1: If an independent MySQL/Redis environment is used, the configuration needs to be adjusted; if the environment is deployed with Docker-Compose in one click, no modification is required.

Note 2: [Critical] If the database is deployed on the host machine (physical machine/virtual machine) but the application runs in a Docker container:

  • Do NOT fill in 127.0.0.1 (127.0.0.1 inside the container points to the container itself and cannot access the host machine);
  • It needs to be replaced with the actual intranet IP of the host machine (e.g., 192.168.1.100, 10.0.0.5, etc.).

Note 3: Path of MySQL initialization script: development/upgrade-20251209.sql.

How to query the intranet IP of the host machine? ​

  • Linux/macOS: Execute ip addr (or ifconfig), and check the inet field of network cards such as eth0/en0;
  • Windows: Execute ipconfig, and check the IPv4 address under "Ethernet/WLAN".

Adjust the configuration file below ​

upgradelink-admin-core/server/api/etc/core-api.yaml

upgradelink-admin-core/server/rpc/etc/core-rpc.yaml

upgradelink-admin-file/server/etc/fms.yaml

upgradelink-admin-message/server/etc/mcms.yaml

upgradelink-admin-upgrade/server/etc/upgrade.yaml

upgradelink-admin-task/server/etc/task.yaml

upgradelink-api/server/api/etc/api.yaml

4. Build Docker Images ​

4.1 Build Docker images for the corresponding modules ​

Dockerfile references:

upgradelink-admin-core/build/Dockerfile-api
upgradelink-admin-core/build/Dockerfile-rpc
upgradelink-admin-file/build/Dockerfile
upgradelink-admin-message/build/Dockerfile
upgradelink-admin-upgrade/build/Dockerfile
upgradelink-admin-task/build/Dockerfile
upgradelink-admin-ui/build/Dockerfile

upgradelink-api/build/Dockerfile

6. Adjust the Nginx configuration file for the upgradelink-admin-ui frontend project ​

Related to the backend management system

Adjust location /sys-api/ to point to the address of the upgradelink-admin-core-api module Adjust location /fms-api/ to point to the address of the upgradelink-admin-file module Adjust location /upgrade/ to point to the address of the upgradelink-admin-upgrade module

7. Start UpgradeLink ​

Project Module Introduction

Startup Sequence

  1. Start the upgradelink-admin-core-rpc module
  2. Start the upgradelink-admin-file module
  3. Start the upgradelink-admin-message module
  4. Start the upgradelink-admin-upgrade module
  5. Start the upgradelink-admin-core-api module
  6. Start the upgradelink-admin-task module
  7. Start the upgradelink-admin-ui module
  8. Start the upgradelink-api module

8. Access the UpgradeLink Backend Management System ​

You can quickly test the functionality of UpgradeLink through the following services.

8.1 UpgradeLink Console Page ​

Open any browser and enter the address: http://127.0.0.1:80 to access the UpgradeLink console page.

Note: The default account password is admin simple-admin

8.2 api ​

The api service address is http://127.0.0.1:8888, You can refer to the api documentation replacement address for testing.

toolsetlink@163.com