Skip to content

Offline upgrade global management module

This page explains how to install or upgrade the global management module after downloading it from Download Center.

Info

The word ghippo appearing in the commands or scripts below is the internally developed code name for the global management module.

Synchronize image to the container registry

First, synchronize the image to the specified container registry through chart-syncer.

  1. Create load-image.yaml

    Note

    All parameters in this YAML file are required. You need a private container registry and modify related configurations.

    If the current environment has installed the chart repo, chart-syncer also supports exporting the chart as a tgz file.

    source:
    intermediateBundlesPath: ghippo-offline # relative path to charts-syncer
                                    # But not the relative path between this YAML file and the offline package
    target:
    containerRegistry: 10.16.10.111 # need to be changed to your container registry url
    containerRepository: release.daocloud.io/ghippo # need to be changed to your container registry
    repo:
      kind: HARBOR # Can also be any other supported Helm Chart repository class
      url: http://10.16.10.111/chartrepo/release.daocloud.io # need to change to chart repo url
      auth:
      username: "admin" # Your container registry username
      password: "Harbor12345" # Your container registry password
    containers:
      auth:
      username: "admin" # Your container registry username
      password: "Harbor12345" # Your container registry password
    

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

    source:
    intermediateBundlesPath: ghippo-offline # relative path to charts-syncer
                                # But not the relative path between this YAML file and the offline package
    target:
    containerRegistry: 10.16.10.111 # need to be changed to your container registry url
    containerRepository: release.daocloud.io/ghippo # need to be changed to your container registry
    repo:
      kind: LOCAL
      path: ./local-repo # chart local path
    containers:
      auth:
      username: "admin" # Your container registry username
      password: "Harbor12345" # Your container registry password
    
  2. Execute the synchronous image command.

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

Load image file

Unzip and load the image file.

  1. Unzip the tar archive.

    tar xvf ghippo.bundle.tar
    

    After successful decompression, you will get 3 files:

    • hints.yaml
    • images.tar
    • original-chart
  2. Load the image locally to Docker or containerd.

    docker load -i images.tar
    
    ctr image import images.tar
    

Note

After the loading is complete, the tag image is required to keep the Registry and Repository consistent with the installation.

upgrade

There are two ways to upgrade. You can choose the corresponding upgrade plan according to the pre-operations:

Note

When upgrading from v0.11.x (or lower) to v0.12.0 (or higher), you need to change all keycloak keys in bak.yaml to keycloakx.

Example modification of this key:

USER-SUPPLIED VALUES:
keycloak:
    ...

change into:

USER-SUPPLIED VALUES:
keycloakx:
    ...
  1. Check whether the global management helm repository exists.

    helm repo list | grep ghippo
    

    If the returned result is empty or as prompted, proceed to the next step; otherwise, skip the next step.

    Error: no repositories to show
    
  2. Add the globally managed helm repository.

    helm repo add ghippo http://{harbor url}/chartrepo/{project}
    
  3. Update the globally managed helm repository.

    helm repo update ghippo # If the helm version is too low, it will fail. If it fails, please try to execute helm update repo
    
  4. Select the version of Global Management you want to install (the latest version is recommended).

    helm search repo ghippo/ghippo --versions
    
    [root@master ~]# helm search repo ghippo/ghippo --versions
    NAME CHART VERSION APP VERSION DESCRIPTION
    ghippo/ghippo 0.9.0 v0.9.0 A Helm chart for GHippo
    ...
    
  5. 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.

    helm get values ​​ghippo -n ghippo-system -o yaml > bak.yaml
    
  6. Execute 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.

    export imageRegistry={your container registry}
    
    helm upgrade ghippo ghippo/ghippo \
    -n ghippo-system\
    -f ./bak.yaml \
    --set global.imageRegistry=$imageRegistry
    --version 0.9.0
    
  1. 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.

    helm get values ​​ghippo -n ghippo-system -o yaml > bak.yaml
    
  2. Execute helm upgrade.

    Before upgrading, it is recommended that you overwrite global.imageRegistry in bak.yaml to the address of the current image registry.

    export imageRegistry={your container registry}
    
    helm upgrade ghippo .\
    -n ghippo-system\
    -f ./bak.yaml \
    --set global.imageRegistry=$imageRegistry
    

Comments