Offline Upgrade Global Management Module¶
This page explains how to install or upgrade the Global Management module after downloading it from Download Center.
Info
ghippo
appearing in the commands or scripts below is the internally developed code name for the Global Management module.
Load images from the installation package¶
You can load images using one of the two methods below. When an container registry is available in the environment, it is recommended to use chart-syncer to synchronize images to the repository, as this method is more efficient and convenient.
Sync images with the container registry¶
-
Create load-image.yaml
Note
All parameters in this YAML file are required. You need a private container registry and modify the relevant configurations.
If the current environment has installed a chart repo, chart-syncer also supports exporting the chart as a tgz file.
load-image.yamlsource: intermediateBundlesPath: ghippo-offline # (1)! target: containerRegistry: 10.16.10.111 # (2)! containerRepository: release.daocloud.io/ghippo # (3)! repo: kind: HARBOR # (4)! url: http://10.16.10.111/chartrepo/release.daocloud.io # (5)! auth: username: "admin" # (6)! password: "Harbor12345" # (7)! containers: auth: username: "admin" # (8)! password: "Harbor12345" # (9)!
- Path relative to where the charts-syncer command is executed, not relative to this YAML file and the offline package
- Change to your container registry URL
- Change to your container registry
- Can also be any other supported Helm Chart repository type
- Change to the chart repo URL
- Your container registry username
- Your container registry password
- Your container registry username
- Your container registry password
If the current environment does not have a chart repo installed, chart-syncer also supports exporting the chart as a tgz file and storing it in a specified path.
load-image.yamlsource: intermediateBundlesPath: ghippo-offline # (1)! target: containerRegistry: 10.16.10.111 # (2)! containerRepository: release.daocloud.io/ghippo # (3)! repo: kind: LOCAL path: ./local-repo # (4)! containers: auth: username: "admin" # (5)! password: "Harbor12345" # (6)!
- Path relative to where the charts-syncer command is executed, not relative to this YAML file and the offline package
- Change to your container registry URL
- Change to your container registry
- Local path of the chart
- Your container registry username
- Your container registry password
-
Run the synchronous image command.
Load directly with Docker or containerd¶
Unzip and load the image file.
-
Unzip the tar archive.
After successful decompression, you will get 3 files:
- hints.yaml
- images.tar
- original-chart
-
Load the image locally to Docker or containerd.
Note
After the loading is complete, the tag image is required to keep the Registry and Repository consistent with the installation.
Upgrade¶
Upgrade Notes:
When upgrading from v0.11.x (or lower versions) to v0.12.0 (or higher versions), it is necessary to change all keycloak keys in bak.yaml to keycloakx.
Replace the key:
with:
When upgrading from v0.15.x (or lower versions) to v0.16.0 (or higher versions), you need to modify the database connection parameters.
Replace the key:
USER-SUPPLIED VALUES:
global:
database:
host: 127.0.0.1
port: 3306
apiserver:
dbname: ghippo
password: passowrd
user: ghippo
keycloakx:
dbname: keycloak
password: passowrd
user: keycloak
auditDatabase:
auditserver:
dbname: audit
password: passowrd
user: audit
host: 127.0.0.1
port: 3306
with:
USER-SUPPLIED VALUES:
global:
storage:
ghippo:
- driver: mysql
accessType: readwrite
dsn: {global.database.apiserver.user}:{global.database.apiserver.password}@tcp({global.database.host}:{global.database.port})/{global.database.apiserver.dbname}?charset=utf8mb4&multiStatements=true&parseTime=true
audit:
- driver: mysql
accessType: readwrite
dsn: {global.auditDatabase.auditserver.user}:{global.auditDatabase.auditserver.password}@tcp({global.auditDatabase.host}:{global.auditDatabase.port})/{global.auditDatabase.auditserver.dbname}?charset=utf8mb4&multiStatements=true&parseTime=true
keycloak:
- driver: mysql
accessType: readwrite
dsn: {global.database.keycloakx.user}:{global.database.keycloakx.password}@tcp({global.database.host}:{global.database.port})/{global.database.keycloakx.dbname}?charset=utf8mb4
There are two upgrade methods. You can choose the proper upgrade plan based on the above operations:
-
Check whether the Global Management Helm repository exists.
If the returned result is empty or as prompted, proceed to the next step; otherwise, skip the next step.
-
Add the Global Mnagement Helm repository.
-
Update the Global Mnagement Helm repository.
- If the Helm version is too low, it will fail. If it fails, please try to run Helm update repo
-
Select the version of Global Management you want to install (the latest version is recommended).
-
Back up the
--set
parameter.Before upgrading the Global Management version, it is recommended that you run the following command to back up the
--set
parameter of the old version. -
Update Ghippo CRD.
-
Run
helm upgrade
.Before upgrading, it is recommended that you override the global.imageRegistry field in bak.yaml to the address of the currently used container registry.
-
Back up the
--set
parameter.Before upgrading the Global Management version, it is recommended that you run the following command to back up the
--set
parameter of the old version. -
Update Ghippo CRD:
-
Run
helm upgrade
.Before upgrading, it is recommended that you overwrite global.imageRegistry in bak.yaml to the address of the current container registry.