Skip to main content

Updating XClarity Administrator v4.0 to v4.1 as a container

When running Lenovo XClarity Administrator as a Docker container, use this update procedure to install the latest software as a new container and bind the volumes of the original container to the new container.

Before you begin

Updating XClarity Administrator from v4.0 to v4.1 as a container requires a special update script to make certain non-persistent file persistent.

The log level is restored to the default after the update completes.

Ensure that a non-root Linux user exists on the host system and that the non-root user can run Docker commands. If not, add the user to the Docker group by running the following commands.
bash
sudo groupadd docker
sudo gpasswd -a $USER docker
newgrp docker
docker ps

About this task

Note
XClarity Administratoris not run as a privileged container.

Procedure

To update an XClarity Administrator container, complete the following steps.

  1. Switch to the non-root user in the Docker group.
  2. Download the XClarity Administrator container image file (do-container-update.sh, docker-compose.env, docker-compose.yml, lnvgy_sw_lxca_ *.tar.gz) from the XClarity Administrator download webpage to your local system in a new directory. Log on to the Web site, and then use the access key that was given to you to download the image.
  3. Import the XClarity Administrator container image into your Docker host by running the following command.
    docker load -i <CONTAINER-IMAGE-FILENAME>
    For example:
    docker load -i lnvgy_sw_lxca_110-4.1.0_anyos_noarch
  4. Edit the new docker-compose.env file, and update the following environment variables to match the values in the original docker-compose.env file.

    The following is an example environment file.

    CONTAINER_NAME="LXCA-400"
    ADDRESS="192.0.2.0"
    BACKUP_MOUNT="/mnt/backup_share"
    FIRMWARE_MOUNT="/mnt/fw_share"
  5. Edit the new docker-compose.yml file. Update the image property at the top of the file to the file name of the new docker image, and update the networks configurations settings (subnet, gateway, and DNS) to match the values in the original docker-compose.yml file.

    The following shows an example yml file.

    version: '3.8'

    services:

    lxca:
    image: lenovo/lxca:4.1.0-124
    container_name: ${CONTAINER_NAME}
    tty: true
    stop_grace_period: 60s
    volumes:
    #bind mount example
    - /home/<HOST_MOUNT_POINT_FOR_BACKUP>:${BACKUP_MOUNT}
    - /home/<HOST_MOUNT_POINT_FOR_FW_SHARE>:${FIRMWARE_MOUNT}
    #docker volume mount
    - data:/opt/lenovo/lxca/data
    - postgresql:/var/lib/postgresql
    - log:/var/log
    - confluent-etc:/etc/confluent
    - confluent-log:/var/log/confluent
    - confluent:/var/lib/confluent
    - propconf:/opt/lenovo/lxca/bin/conf
    - ssh:/etc/ssh
    - xcat:/etc/xcat
    networks:
    lan:
    ipv4_address: ${ADDRESS}
    dns: 192.0.30.10
    192.0.30.11
    deploy:
    resources:
    limits:
    cpus: "2.0"
    memory: "8g"

    volumes:
    data:
    name: ${CONTAINER_NAME}-data
    postgresql:
    name: ${CONTAINER_NAME}-postgresql
    log:
    name: ${CONTAINER_NAME}-log
    confluent-etc:
    name: ${CONTAINER_NAME}-confluent-etc
    confluent-log:
    name: ${CONTAINER_NAME}-confluent-log
    confluent:
    name: ${CONTAINER_NAME}-confluent
    propconf:
    name: ${CONTAINER_NAME}-propconf
    ssh:
    name: ${CONTAINER_NAME}-ssh
    xcat:
    name: ${CONTAINER_NAME}-xcat
    networks:
    lan:
    name: lan
    driver: macvlan
    driver_opts:
    parent: eth0
    ipam:
    config:
    - subnet: 192.0.0.0/19
    gateway: 192.0.30.1
  6. Upgrade the container image in docker by running the following command, where <ORIGINAL-CONTAINER-IMAGE-PATH> the location of the original container files and, and <NEW-CONTAINER-IMAGE-PATH> is the location where you downloaded the new container image files in step 2.
    bash do-container-update.sh <ORIGINAL-CONTAINER-IMAGE-PATH> <NEW-CONTAINER-IMAGE-PATH>
    For example:
    bash do-container-update.sh /home/$USER/lxca-400 /home/$USER/lxca-410
    Note
    During the upgrade process, you are prompted to enter the password for the sudo command. You must enter the password to continue.