Upgrading the management server on zCX

This topic describes how to upgrade the management server on zCX.

Important

The supported upgrade path is from the previous three releases to the latest one. If the installed version is three or more releases older than the latest one, contact BMC Support.

Related topic

Upgrading

Prerequisites

Docker (version 18 or later) or Podman (version 4.4.1 or later)

Upgrading from a specific version

Select the version you need to upgrade from.

Task 1: To obtain the installation files

  2. Using the search bar, search for either BMC AMI Cloud Data or BMC AMI Cloud Vault. Both product files are composed with the same binaries.
  3. Click the version that you want to download. 
  4. On the Product tab, select the files and click Download.

Task 2: To upload the s390x installation zip file

Upload the s390x installation zip to the zCX instance using scp or any other tool in binary mode.

Copy the s390x installation zip from the zCX instance to the alpine container:

docker cp model9-server-package-s390x-4.2.2.zip dummy:/root/model9-server-package-s390x-4.2.2.zip

Task 3: To stop the BMC AMI Cloud application container

Stop the server and remove the BMC AMI Cloud container that is running by using the following commands:

docker stop model9-v4.2.1
docker rm model9-v4.2.1

Task 4: To prepare the installation artifacts

In the Alpine container, open the BMC AMI Cloud artifact: 

# Unzip the installation package.
docker exec -it dummy sh
cd /root
unzip /root/model9-server-package-s390x-4.2.2.zip 'model9*' 'postgres*'

# Verify the existence of the diag directory. Create it if needed.
mkdir diag

# Backup the /conf directory.
tar -czf conf-backup.tar.gz conf

# Exit from the alpine container.
exit

Copy the docker container images from the alpine docker container (the one that was used during the initial installation):

docker cp dummy:/root/model9-server-v4.2.2-s390x.docker ./
docker cp dummy:/root/postgres-16.9-alpine3.22-s390x.docker.gz ./

Task 5: To load the new release artifacts

Load the new release docker containers:

docker load -i model9-server-v4.2.2-s390x.docker
docker load -i postgres-16.9-alpine3.22-s390x.docker.gz

Task 6: To back up the server before the upgrade 

Warning

Back up the local configuration and database volume to avoid loss of data.

Run each command separately and check the results:

fileStamp=$(date +%Y-%m-%d)
docker cp dummy:/root/conf-backup.tar.gz ./conf-$fileStamp.tar.gz
docker exec -it model9db pg_dump -p 5432 -U postgres -d model9 -f /tmp/model9db-$fileStamp.dump
docker cp model9db:/tmp/model9db-$fileStamp.dump ./model9db-$fileStamp.dump
docker exec -ti model9db rm /tmp/model9db-$fileStamp.dump

Task 7: To upgrade the PostgreSQL version

Warning

Make sure that you have backed up the database as described in Task 6: To back up the server before the upgrade.

Run the following commands:

# Stop Postgres container
docker stop model9db

# Remove Postgres container
docker rm model9db

# Start Postgres docker container on zCX issue:
docker run --shm-size=256m -p 127.0.0.1:5432:5432 \
-v model9db:/var/lib/postgresql/data:z \
-v model9db_initdb:/docker-entrypoint-initdb.d:z \
--name model9db --restart unless-stopped \
--network model9network \
-e POSTGRES_PASSWORD=model9 -e POSTGRES_DB=model9 -d postgres:16.9-alpine3.22

Task 8: To start the BMC AMI Cloud server 

Run the new release container using the following command:

docker run -d -p <zCX-VIPA>:443:443 -p <zCX-VIPA>:80:80 \
--sysctl net.ipv4.tcp_keepalive_time=600 \
--sysctl net.ipv4.tcp_keepalive_intvl=30 \
--sysctl net.ipv4.tcp_keepalive_probes=10 \
-v model9:/model9:z -h $(hostname) --restart unless-stopped \
--env-file <user home directory>/model9.env \
--network model9network \
--name model9-v4.2.2 model9:v4.2.2.s390x

Important

Replace <zCX-VIPA> with the zCX instance VIPA.

Warning

By default, BMC AMI Cloud uses ports 80 and 443 for the management server. If these ports are not available for use or you want to use different ports, update the -p parameters to use different ports. For example, to use port 8080 and port 8443, update the parameters as follows:
-p <zCX-VIPA>:8443:443 -p <zCX-VIPA>:8080:80

Task 1: To obtain the installation files

  2. Using the search bar, search for either BMC AMI Cloud Data or BMC AMI Cloud Vault. Both product files are composed with the same binaries.
  3. Click the version that you want to download. 
  4. On the Product tab, select the files and click Download.

Task 2: To upload the s390x installation zip file

Upload the s390x installation zip to the zCX instance using scp or any other tool in binary mode.

Copy the s390x installation zip from the zCX instance to the alpine container:

docker cp model9-server-package-s390x-4.2.2.zip dummy:/root/model9-server-package-s390x-4.2.2.zip

Task 3: To stop the BMC AMI Cloud application container

Stop the server and remove the BMC AMI Cloud container that is running by using the following commands:

docker stop model9-v4.1.1
docker rm model9-v4.1.1

Task 4: To prepare the installation artifacts

In the Alpine container, open the BMC AMI Cloud artifact: 

# Unzip the installation package.
docker exec -it dummy sh
cd /root
unzip /root/model9-server-package-s390x-4.2.2.zip 'model9*' 'postgres*'

# Verify the existence of the diag directory. Create it if needed.
mkdir diag

# Backup the /conf directory.
tar -czf conf-backup.tar.gz conf

# Exit from the alpine container.
exit

Copy the docker container images from the alpine docker container (the one that was used during the initial installation):

docker cp dummy:/root/model9-server-v4.2.2-s390x.docker ./
docker cp dummy:/root/postgres-16.9-alpine3.22-s390x.docker.gz ./

Task 5: To load the new release artifacts

Load the new release docker containers:

docker load -i model9-server-v4.2.2-s390x.docker
docker load -i postgres-16.9-alpine3.22-s390x.docker.gz

Task 6: To back up the server before the upgrade 

Warning

Back up the local configuration and database volume to avoid loss of data.

Run each command separately and check the results:

fileStamp=$(date +%Y-%m-%d)
docker cp dummy:/root/conf-backup.tar.gz ./conf-$fileStamp.tar.gz
docker exec -it model9db pg_dump -p 5432 -U postgres -d model9 -f /tmp/model9db-$fileStamp.dump
docker cp model9db:/tmp/model9db-$fileStamp.dump ./model9db-$fileStamp.dump
docker exec -ti model9db rm /tmp/model9db-$fileStamp.dump

Task 7: To upgrade the PostgreSQL version

Warning

Make sure that you have backed up the database as described in Task 6: To back up the server before the upgrade.

Run the following commands:

# Stop Postgres container
docker stop model9db

# Remove Postgres container
docker rm model9db

# Start Postgres docker container on zCX issue:
docker run --shm-size=256m -p 127.0.0.1:5432:5432 \
-v model9db:/var/lib/postgresql/data:z \
-v model9db_initdb:/docker-entrypoint-initdb.d:z \
--name model9db --restart unless-stopped \
--network model9network \
-e POSTGRES_PASSWORD=model9 -e POSTGRES_DB=model9 -d postgres:16.9-alpine3.22

Task 8: To start the BMC AMI Cloud server 

Run the new release container using the following command:

docker run -d -p <zCX-VIPA>:443:443 -p <zCX-VIPA>:80:80 \
--sysctl net.ipv4.tcp_keepalive_time=600 \
--sysctl net.ipv4.tcp_keepalive_intvl=30 \
--sysctl net.ipv4.tcp_keepalive_probes=10 \
-v model9:/model9:z -h $(hostname) --restart unless-stopped \
--env-file <user home directory>/model9.env \
--network model9network \
--name model9-v4.2.2 model9:v4.2.2.s390x

Important

Replace <zCX-VIPA> with the zCX instance VIPA.

Warning

By default, BMC AMI Cloud uses ports 80 and 443 for the management server. If these ports are not available for use or you want to use different ports, update the -p parameters to use different ports. For example, to use port 8080 and port 8443, update the parameters as follows:
-p <zCX-VIPA>:8443:443 -p <zCX-VIPA>:8080:80

Task 1: To obtain the installation files

  2. Using the search bar, search for either BMC AMI Cloud Data or BMC AMI Cloud Vault. Both product files are composed with the same binaries.
  3. Click the version that you want to download. 
  4. On the Product tab, select the files and click Download.

Task 2: To upload the s390x installation zip file

Upload the s390x installation zip to the zCX instance using scp or any other tool in binary mode.

Copy the s390x installation zip from the zCX instance to the alpine container:

docker cp model9-server-package-s390x-4.2.2.zip dummy:/root/model9-server-package-s390x-4.2.2.zip

Task 3: To stop the BMC AMI Cloud application container

Stop the server and remove the BMC AMI Cloud container that is running by using the following commands:

docker stop model9-v4.0.1
docker rm model9-v4.0.1

Task 4: To prepare the installation artifacts

In the Alpine container, open the BMC AMI Cloud artifact:

# Unzip the installation package.
docker exec -it dummy sh
cd /root
unzip /root/model9-server-package-s390x-4.2.2.zip 'model9*' 'postgres*'

# Verify the existence of the diag directory. Create it if needed.
mkdir diag

# Backup the /conf directory.
tar -czf conf-backup.tar.gz conf

# Exit from the alpine container.
exit

Copy the docker container images from the alpine docker container (the one that was used during the initial installation):

docker cp dummy:/root/model9-server-v4.2.2-s390x.docker ./
docker cp dummy:/root/postgres-16.9-alpine3.22-s390x.docker.gz ./

Task 5: To load the new release artifacts

Load the new release docker containers:

docker load -i model9-server-v4.2.2-s390x.docker
docker load -i postgres-16.9-alpine3.22-s390x.docker.gz

Task 6: To back up the server before the upgrade 

Warning

Back up the local configuration and database volume to avoid loss of data.

Run each command separately and check the results:

fileStamp=$(date +%Y-%m-%d)
docker cp dummy:/root/conf-backup.tar.gz ./conf-$fileStamp.tar.gz
docker exec -it model9db pg_dump -p 5432 -U postgres -d model9 -f /tmp/model9db-$fileStamp.dump
docker cp model9db:/tmp/model9db-$fileStamp.dump ./model9db-$fileStamp.dump
docker exec -ti model9db rm /tmp/model9db-$fileStamp.dump

Task 7: To upgrade the PostgreSQL version

Warning

Make sure that you have backed up the database as described in Task 6: To back up the server before the upgrade.

Run the following commands:

# Stop Postgres container
docker stop model9db

# Remove Postgres container
docker rm model9db

# Start Postgres docker container on zCX issue:
docker run --shm-size=256m -p 127.0.0.1:5432:5432 \
-v model9db:/var/lib/postgresql/data:z \
-v model9db_initdb:/docker-entrypoint-initdb.d:z \
--name model9db --restart unless-stopped \
--network model9network \
-e POSTGRES_PASSWORD=model9 -e POSTGRES_DB=model9 -d postgres:16.9-alpine3.22

Task 8: To start the BMC AMI Cloud server

Run the new release container using the following command:

docker run -d -p <zCX-VIPA>:443:443 -p <zCX-VIPA>:80:80 \
--sysctl net.ipv4.tcp_keepalive_time=600 \
--sysctl net.ipv4.tcp_keepalive_intvl=30 \
--sysctl net.ipv4.tcp_keepalive_probes=10 \
-v model9:/model9:z -h $(hostname) --restart unless-stopped \
--env-file <user home directory>/model9.env \
--network model9network \
--name model9-v4.2.2 model9:v4.2.2.s390x

Important

Replace <zCX-VIPA> with the zCX instance VIPA.

Warning

By default, BMC AMI Cloud uses ports 80 and 443 for the management server. If these ports are not available for use or you want to use different ports, update the -p parameters to use different ports. For example, to use port 8080 and port 8443, update the parameters as follows:
-p <zCX-VIPA>:8443:443 -p <zCX-VIPA>:8080:80

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*