Skip to content

Microservice Engine Management Components

Deployment Structure of Microservice Engine Management Components

The chart inside the blue box represents the skoala component, which needs to be installed in the control plane cluster, specifically the global cluster kpanda-global-cluster of DCE 5.0. For details, refer to the deployment architecture of DCE 5.0.

After installing the skoala component, you can see the Microservice Engine module in the primary navigation bar of DCE 5.0. Also, please note that before installing skoala, you need to install the required common-mysql component for resource storage.

Online Install

If you need to install the Microservice Engine, it is recommended to use the installation package of DCE 5.0 Enterprise Package for installation. The Enterprise Package allows you to install all modules of DCE at once.

This tutorial is intended to supplement the scenario of manually installing the Microservice Engine module separately online. The term skoala used in the following text is the internal development code name for the Microservice Engine.

Note

This document provides instructions for online installation. If you have deployed the offline Enterprise Package, it is recommended to refer to Offline Upgrade of Microservice Engine for offline installation or upgrade of the Microservice Engine.

Install Enterprise Package

When installing the Microservice Engine management components using the Enterprise Package, pay attention to the version number of the Enterprise Package (click here to view the latest version). Different operations need to be performed for different versions.

When the version number of the Enterprise Package is ≥ v0.3.29, the Microservice Engine management components will be installed by default. However, it is still recommended to check the manifest.yaml file to confirm that the value of components/skoala/enable is set to true and that the Helm version is specified.

The Enterprise Package installs the latest tested version by default. Unless there are special circumstances, it is not recommended to modify the default Helm version.

If Enterprise Package ≤ v0.3.28, click here for the corresponding instructions

This note only applies to Enterprise Package ≤ v0.3.28. In most cases, your version will be higher than this version.

By default, the Microservice Engine is not installed when executing the installation command. You need to modify the manifest.yaml file as shown below to allow the installation of the Microservice Engine.

Modified file:

./dce5-installer install-app -m /sample/manifest.yaml

Modified content:

...
components:
  skoala:
    enable: true
    helmVersion: v0.12.2 # Replace with the latest version number
    variables:
...

Check if the Microservice Engine is Installed

Check if the following resources exist in the skoala-system namespace. If there are no resources, it means that the Microservice Engine is not currently installed.

$ kubectl -n skoala-system get pods
NAME                                   READY   STATUS    RESTARTS        AGE
hive-8548cd9b59-948j2                  2/2     Running   0               3h48m
sesame-5955c878c6-jz8cd                2/2     Running   0               3h48m
skoala-ui-75b8f8c776-nbw9d             2/2     Running   0               3h48m

$ helm -n skoala-system list
NAME        NAMESPACE       REVISION    UPDATED                                 STATUS      CHART               APP VERSION
skoala      skoala-system   2           2023-11-03 10:23:22.373053803 +0800 CST deployed    skoala-0.28.1       0.28.1

Check the Dependent Storage Component

When installing the Microservice Engine, the common-mysql component is required for storing configurations. Therefore, make sure that this component exists. Additionally, check if there is a database named skoala in the common-mysql namespace.

$ kubectl -n mcamel-system get statefulset
NAME                                          READY   AGE
mcamel-common-mysql-cluster-mysql             2/2     7d23h

It is recommended to use the following parameters to configure the database information for the Microservice Engine:

  • Host: mcamel-common-mysql-cluster-mysql-master.mcamel-system.svc.cluster.local
  • Port: 3306
  • Database: skoala
  • User: skoala
  • Password:

Note

If common-mysql is not installed, you can use a custom database. Fill in the above parameters according to your actual situation.

Check the Dependent Monitoring Component

The Microservice Engine relies on the capabilities of the DCE 5.0 Insight module. If you need to monitor various metrics and trace the service calls of your microservices, you need to install the corresponding insight-agent in your cluster. For detailed instructions, refer to Installing the insight-agent.

Manual Installation Process

Once everything is ready, you can proceed with the formal installation of the Microservice Engine management components. The specific steps are as follows:

Note

  • If you are installing a version of skoala-release/skoala below v0.17.1, you need to manually initialize the database tables.
  • If you are installing skoala-release/skoala v0.17.1 or above, the database tables will be automatically initialized by the system and manual intervention is not required.
If the initialization fails, check if the following 3 data tables exist in the skoala database and if the corresponding SQL statements are all effective. 
mysql> desc api;
+------------------+-----------------+------+-----+-------------------+-----------------------------------------------+
| Field            | Type            | Null | Key | Default           | Extra                                         |
+------------------+-----------------+------+-----+-------------------+-----------------------------------------------+
| id               | bigint unsigned | NO   | PRI | NULL              | auto_increment                                |
| is_hosted        | tinyint         | YES  |     | 0                 |                                               |
| registry         | varchar(50)     | NO   | MUL | NULL              |                                               |
| service_name     | varchar(200)    | NO   |     | NULL              |                                               |
| nacos_namespace  | varchar(200)    | NO   |     | NULL              |                                               |
| nacos_group_name | varchar(200)    | NO   |     | NULL              |                                               |
| data_type        | varchar(100)    | NO   |     | NULL              |                                               |
| detail           | mediumtext      | NO   |     | NULL              |                                               |
| deleted_at       | timestamp       | YES  |     | NULL              |                                               |
| created_at       | timestamp       | NO   |     | CURRENT_TIMESTAMP | DEFAULT_GENERATED                             |
| updated_at       | timestamp       | NO   |     | CURRENT_TIMESTAMP | DEFAULT_GENERATED on update CURRENT_TIMESTAMP |
+------------------+-----------------+------+-----+-------------------+-----------------------------------------------+

mysql> desc book;
+-------------+------------------+------+-----+-------------------+-----------------------------------------------+
| Field       | Type             | Null | Key | Default           | Extra                                         |
+-------------+------------------+------+-----+-------------------+-----------------------------------------------+
| id          | bigint unsigned  | NO   | PRI | NULL              | auto_increment                                |
| uid         | varchar(32)      | YES  | UNI | NULL              |                                               |
| name        | varchar(50)      | NO   | UNI | NULL              |                                               |
| author      | varchar(32)      | NO   |     | NULL              |                                               |
| status      | int              | YES  |     | 1                 |                                               |
| isPublished | tinyint unsigned | NO   |     | 1                 |                                               |
| publishedAt | timestamp        | YES  |     | NULL              |                                               |
| deleted_at  | timestamp        | YES  |     | NULL              |                                               |
| createdAt   | timestamp        | NO   |     | CURRENT_TIMESTAMP | DEFAULT_GENERATED                             |
| updatedAt   | timestamp        | NO   |     | CURRENT_TIMESTAMP | DEFAULT_GENERATED on update CURRENT_TIMESTAMP |
+-------------+------------------+------+-----+-------------------+-----------------------------------------------+
10 rows in set (0.00 sec)

mysql> desc registry;
+--------------+-----------------+------+-----+-------------------+-----------------------------------------------+
| Field        | Type            | Null | Key | Default           | Extra                                         |
+--------------+-----------------+------+-----+-------------------+-----------------------------------------------+
| id           | bigint unsigned | NO   | PRI | NULL              | auto_increment                                |
| uid          | varchar(32)     | YES  | UNI | NULL              |                                               |
| workspace_id | varchar(50)     | NO   |     | default           |                                               |
| ext_id       | varchar(50)     | YES  |     | NULL              |                                               |
| name         | varchar(50)     | NO   | MUL | NULL              |                                               |
| type         | varchar(50)     | NO   |     | NULL              |                                               |
| addresses    | varchar(1000)   | NO   |     | NULL              |                                               |
| namespaces   | varchar(2000)   | NO   |     | NULL              |                                               |
| is_hosted    | tinyint         | NO   |     | 0                 |                                               |
| deleted_at   | timestamp       | YES  |     | NULL              |                                               |
| created_at   | timestamp       | NO   |     | CURRENT_TIMESTAMP | DEFAULT_GENERATED                             |
| updated_at   | timestamp       | NO   |     | CURRENT_TIMESTAMP | DEFAULT_GENERATED on update CURRENT_TIMESTAMP |
+--------------+-----------------+------+-----+-------------------+-----------------------------------------------+
12 rows in set (0.00 sec)

Configure Skoala Helm Repository

To configure the Skoala repository, you can view and obtain Skoala's application chart by following these steps:

helm repo add skoala-release https://release.daocloud.io/chartrepo/skoala
helm repo update

Note: Helm needs to be installed beforehand.

After adding the Skoala-release repository, there are typically two charts that you should pay attention to:

Skoala is the control-side service of the Microservice Engine:

  • Once installed, you can see the entry point for the Microservice Engine on the DCE 5.0 platform.
  • It includes three components: skoala-ui, hive, and sesame.
  • It needs to be installed in the global management cluster.

By default, after installing Skoala in the kpanda-global-cluster (global management cluster), you will be able to see the corresponding entry point for the Microservice Engine in the sidebar.

Check the Latest Version of the Microservice Engine Management Components

To check the latest version of Skoala in the global management cluster, you can use the helm command to retrieve version information directly:

$ helm repo update skoala-release
$ helm search repo skoala-release/skoala --versions
NAME                        CHART VERSION   APP VERSION DESCRIPTION
skoala-release/skoala       0.28.1          0.28.1      The helm chart for Skoala
skoala-release/skoala       0.28.0          0.28.0      The helm chart for Skoala
skoala-release/skoala       0.27.2          0.27.2      The helm chart for Skoala
skoala-release/skoala       0.27.1          0.27.1      The helm chart for Skoala
......

Perform Deployment (Also Applicable for Upgrades)

Run the following command, making sure to replace the version number accordingly:

$ helm upgrade --install skoala --create-namespace -n skoala-system --cleanup-on-fail \
    --set ui.image.tag=v0.19.0 \
    --set hive.configMap.database[0].driver="mysql" \
    --set hive.configMap.database[0].dsn="skoala:xxx@tcp(mcamel-common-mysql-cluster-mysql-master.mcamel-system.svc.cluster.local:3306)/skoala?charset=utf8&parseTime=true&loc=Local&timeout=10s" \
    skoala-release/skoala \
    --version 0.28.1

Check if the Pods have started successfully:

$ kubectl -n skoala-system get pods
NAME                                   READY   STATUS    RESTARTS        AGE
hive-8548cd9b59-948j2                  2/2     Running   0               3h48m
sesame-5955c878c6-jz8cd                2/2     Running   0               3h48m
skoala-ui-7c9f5b7b67-9rpzc             2/2     Running   0               3h48m

Online Upgrade

Before starting the upgrade process, it's helpful to understand the deployment architecture of the Microservice Engine.

The Microservice Engine consists of two components:

  • The skoala component is installed in the control plane cluster and is responsible for loading the Microservice Engine modules in the DCE 5.0 primary navigation bar.
  • The skoala-init component is installed in the workspace cluster and provides core functionalities of the Microservice Engine, such as creating registry instances and gateway instances.

Note

  • When upgrading the Microservice Engine, both of these components need to be upgraded simultaneously to avoid version incompatibility.
  • For information on version updates of the Microservice Engine, refer to the release notes.

Since the skoala component is installed in the control plane cluster, the following steps need to be performed in the control plane cluster.

  1. Run the following command to back up the existing data:

    helm -n skoala-system get values skoala > skoala.yaml

  2. Add the Helm repository for the Microservice Engine:

    helm repo add skoala https://release.daocloud.io/chartrepo/skoala

  3. Update the Helm repository for the Microservice Engine:

    helm repo update

  4. Run the helm upgrade command:

    helm --kubeconfig /tmp/deploy-kube-config upgrade --install --create-namespace -n skoala-system skoala skoala/skoala --version=0.28.1 --set hive.image.tag=v0.28.1 --set sesame.image.tag=v0.28.1 --set ui.image.tag=v0.19.0 -f skoala.yaml

    You need to adjust the values of the version, hive.image.tag, sesame.image.tag, and ui.image.tag parameters to the version of the Microservice Engine you want to upgrade to.

Offline Upgrade

DCE 5.0 modules are loosely coupled and support independent installation and upgrade of each module. This document is applicable to offline upgrades performed after installing the Microservice Engine.

Synchronize Images

After downloading the images to your local nodes, you need to synchronize the latest version of the images to your container registry using chart-syncer or container runtime. It is recommended to use chart-syncer for image synchronization as it is more efficient and convenient.

Synchronize Images with chart-syncer

  1. Create a load-image.yaml file with the following content as the configuration file for chart-syncer.

    All parameters in the load-image.yaml file are required. You need a private container registry and modify the configurations according to the instructions below. For detailed explanations of the chart-syncer configuration file, refer to its official documentation.

    If you have already installed a chart repo in the current environment, you can use the following configuration to synchronize the images directly.

    source:
  intermediateBundlesPath: skoala-offline # (1)
target:
  containerRegistry: 10.16.23.145 # (2)
  containerRepository: release.daocloud.io/skoala # (3)
  repo:
    kind: HARBOR # (4)
    url: http://10.16.23.145/chartrepo/release.daocloud.io # (5)
    auth:
      username: "admin" # (6)
      password: "Harbor12345" # (7)
  containers:
    auth:
      username: "admin" # (8)
      password: "Harbor12345" # (9)
    1. The relative path to the execution of the charts-syncer command, not the relative path between this YAML file and the offline package
    2. Change it to your container registry URL
    3. Change it to your container registry
    4. It can also be any other supported Helm Chart repository type
    5. Change it to the chart repo URL
    6. Your container registry username
    7. Your container registry password
    8. Your container registry username
    9. Your container registry password

    If you have not installed a chart repo in the current environment, chart-syncer also supports exporting the chart as a tgz file and storing it in a specified path.

    source:
  intermediateBundlesPath: skoala-offline # (1)
target:
  containerRegistry: 10.16.23.145 # (2)
  containerRepository: release.daocloud.io/skoala # (3)
  repo:
    kind: LOCAL
    path: ./local-repo # (4)
  containers:
    auth:
      username: "admin" # (5)
      password: "Harbor12345" # (6)
    1. The relative path to the execution of the charts-syncer command, not the relative path between this YAML file and the offline package
    2. Change it to your container registry URL
    3. Change it to your container registry
    4. Local path of the chart
    5. Your container registry username
    6. Your container registry password

  2. Run the command to synchronize the images.

charts-syncer sync --config load-image.yaml

Synchronize Images with Docker/containerd

  1. Extract the tar archive.
tar xvf skoala.bundle.tar

After successful extraction, you will have three files:

  • hints.yaml
  • images.tar

  • original-chart

  • Load the images from the local directory to Docker or containerd.

=== "Docker"

   ```shell
   docker load -i images.tar
   ```

=== "containerd"

   ```shell
   ctr -n k8s.io image import images.tar
   ```

!!! note

   - You need to load the images via Docker or containerd on each node.
   - After loading, remember to tag the images to match the Registry and Repository used during installation.

Start the Upgrade

After completing the image synchronization, you can start upgrading the Microservice Engine.

  1. Check if the Microservice Engine Helm repository exists.
helm repo list | grep skoala

If the result is empty or shows the following prompt, proceed to the next step. Otherwise, skip the next step.

Error: no repositories to show
  1. Add the Microservice Engine Helm repository.
helm repo add skoala-release http://{harbor url}/chartrepo/{project}
  1. Update the Microservice Engine Helm repository.
helm repo update skoala-release # (1)

  1. If the helm version is too low and the update fails, try executing helm update repo.

  2. Choose the version of the Microservice Engine you want to install (it is recommended to install the latest version).

helm search repo skoala-release/skoala --versions

NAME                   CHART VERSION  APP VERSION  DESCRIPTION
skoala-release/skoala  0.14.0          v0.14.0       A Helm chart for Skoala
...
  1. Backup the --set parameters.

Before upgrading the Microservice Engine version, it is recommended to run the following command to back up the --set parameters of the old version.

helm get values skoala -n skoala-system -o yaml > bak.yaml
  1. Run helm upgrade.

Before upgrading, it is recommended to update the global.imageRegistry field in the bak.yaml file with the address of the container registry you are currently using.

export imageRegistry={your container registry}

helm upgrade skoala skoala-release/skoala \
-n skoala-system \
-f ./bak.yaml \
--set global.imageRegistry=$imageRegistry \
--version 0.14.0
  1. Backup the --set parameters.

Before upgrading the Microservice Engine version, it is recommended to run the following command to back up the --set parameters of the old version.

helm get values skoala -n skoala-system -o yaml > bak.yaml
  1. Run helm upgrade.

Before upgrading, it is recommended to update the global.imageRegistry field in the bak.yaml file with the address of the container registry you are currently using.

export imageRegistry={your container registry}

helm upgrade skoala . \
-n skoala-system \
-f ./bak.yaml \
--set global.imageRegistry=$imageRegistry

Uninstall Microservice Engine Management Components

helm uninstall skoala -n skoala-system

Comments