Skip to content

Offline Upgrade Backup and Restore Module

This page explains how to install or upgrade the backup and restore module after downloading it from the Download Center.

Info

The term 'kcoral' used in the following commands or scripts is the internal development code name for the backup and restore module.

Load Images from Downloaded Package

You can load the images using one of the following two methods. When the container registry exists in the environment, it is recommended to use chart-syncer to synchronize the images to the container registry, as it is more efficient and convenient.

Method 1: Use chart-syncer to Synchronize Images

Using chart-syncer, you can upload the charts and their dependent image packages from the downloaded package to the container registry and Helm repository used by the installer.

First, find a node that can connect to the container registry and Helm repository (such as the Spark node), and create a load-image.yaml configuration file on the node, filling in the configuration information for the container registry and Helm repository.

  1. Create load-image.yaml file

    Note

    All parameters in this YAML file are required.

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

    load-image.yaml
    source:
      intermediateBundlesPath: kcoral # (1)!
    target:
      containerRegistry: 10.16.10.111 # (2)!
      containerRepository: release.daocloud.io/kcoral # (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)!
    
    1. The path where the .tar.gz package is located after using chart-syncer
    2. Container registry address
    3. Container registry path
    4. Helm Chart repository type
    5. Helm repository address
    6. Container registry username
    7. Container registry password
    8. Helm repository username
    9. Helm repository password

    If the current node does not have a helm repo added, chart-syncer also supports exporting the chart as a tgz file and storing it in the specified path.

    load-image.yaml
    source:
      intermediateBundlesPath: kcoral # (1)!
    target:
      containerRegistry: 10.16.10.111 # (2)!
      containerRepository: release.daocloud.io/kcoral # (3)!
      repo:
        kind: LOCAL
        path: ./local-repo # (4)!
      containers:
        auth:
          username: "admin" # (5)!
          password: "Harbor12345" # (6)!
    
    1. The path where the .tar.gz package is located after using chart-syncer
    2. Container registry URL
    3. Container registry path
    4. Local path to the chart
    5. Container registry username
    6. Container registry password
  2. Run the command to synchronize the images.

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

Method 2: Load Images using Docker or containerd

Unpack and load the image files.

  1. Extract the tar package.

    tar xvf kcoral.bundle.tar
    

    After successful extraction, you will get three files:

    • kcoral.bundle.tar
  2. Load the images into Docker or containerd from the local directory.

    docker load -i images.tar
    
    ctr -n k8s.io image import images.tar
    

Note

Each node needs to perform the Docker or containerd image loading operation. After loading is complete, tag the images to ensure consistency with the Registry and Repository used during installation.

Upgrade

There are two upgrade methods. You can choose the appropriate upgrade method based on the preconditions:

  1. Check if the backup and restore Helm repository exists.

    helm repo list | grep kcoral
    

    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
    
  2. Add the backup and restore Helm repository.

    helm repo add kcoral http://{harbor url}/chartrepo/{project}
    
  3. Update the backup and restore Helm repository.

    helm repo update kcoral
    
  4. Select the backup and restore version you want to install (it is recommended to install the latest version version).

    helm search repo kcoral/kcoral --versions
    
    [root@master ~]# helm search repo kcoral/kcoral --versions
    NAME                   CHART VERSION  APP VERSION  DESCRIPTION
    kcoral/kcoral  0.20.0          v0.20.0       A Helm chart for kcoral
    ...
    
  5. Back up the --set parameters.

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

    helm get values kcoral -n kcoral-system -o yaml > bak.yaml
    
  6. Run helm upgrade .

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

    export imageRegistry={your container registry}
    
    helm upgrade kcoral kcoral/kcoral \
      -n kcoral-system \
      -f ./bak.yaml \
      --set global.imageRegistry=$imageRegistry \
      --version 0.5.0
    
  1. Back up the --set parameters.

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

    helm get values kcoral -n k pan da-system -o yaml > bak.yaml
    
  2. Run helm upgrade .

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

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

Comments