Upgrading IDPV Server

This section describes the procedure to update the IDPV server.

It is recommended to back up your database and HSM keys before starting the upgrade process.

Server Upgrade Path

• Upgrade from IDPV server v2.1 onwards is supported.

  If you have IDPV server v2.0 installed, then it is recommended to uninstall the IDPrimeVirtualServer database instance before installing v2.1 or higher versions.

• Upgrade from IDPV server v2.3 onwards.

  Make sure Appsettings.yml and idp-configuration.json are updated before proceeding with the upgrade. Similarly after updating the idp-configuration.json run the update tenant command in order to read the new parameters from the file. Restart the container to reflect the changes immediately.

  There are no specific changes between 2.3 server and 2.4 server. However, to use the -u functionality in tenant creation, you need to run update tenant commands. Backward compatibility is not supported. If the server is upgraded, the client must be updated as well.

Upgrading Version

To upgrade from evaluation (trial) version to full version, you need the full version delivery package, which contains the Docker image file. For example, idprimevirtual_server_full:2.x.x.x.tar.gz.

Before upgrading the server version, ensure to take backups of the database and HSM user keys.

If already have a running solution on a trial version, it is not required to configure all the files again. Instead, copy the full version image file on the host machine, and perform the following steps:

1. Unzip the provided image of full version as a TAR, by executing the following command:

   
     gzip -d <image-name.tar.gz>
   
   
   

2. After unzipping the file, load the image in the Docker registry by executing the following command:

   
     docker load –i <image-name.tar>
   
   
   

   For RHEL 8 or 9 with podman environment, the command is:

   
     podman load –i <image-name.tar>
   
   
   

3. If you have the IDPV Server Docker image in the Docker repository, pull the image from there using the following command:

   
     docker pull <docker-registry/repository/image-name:tag>
   
   
   

   For RHEL 8 or 9 with podman environment, the command is:

   
     podman pull repository/image:tag
   
   
   

4. Perform the following steps as per your deployment:

   For Docker

   1. Remove the existing running container using the below command:

      
      docker rm idprimevirtualserver –f
      

      For RHEL 8 or 9 with podman environment, the commands are:

      • Stop the container, by running the following command:

        
        podman stop idprimevirtualserver
        

      • Remove the container, by running the following command:

        
        podman rm idprimevirtualserver
        

      You can find the name of the existing container using the following command:

      
      docker ps –a
      

      For RHEL 8 or 9 with podman environment, the command is:

      
      podman ps -a
      

   2. Run the following command to run the new container with a new image:

      
         docker run -d --name idprimvirtualserver -it -v/var/thales/config:/publish/Config/ -v /var/thales/hsm:/usr/local/hsm/ -p<host-https-port>:5001 idprimevirtual_server:2.x
      
      
      

      For RHEL 8 or 9 with podman environment, the command is:

      
      podman run -d --name idprimevirtualserver -it --mount 'type=bind,src=/var/thales/config,dst=/publish/Config/,relabel=shared,U' -- mount 'type=bind,src=/var/thales/hsm,dst=/usr/local/hsm/,relabel=shared,U' - p :5001 idprimevirtual_server_full:2.x
      

      Where,

      • idprimvirtualserver is the name of server container and can be any string you choose.
      • /var/thales/config and /var/thales/hsm directories contain the server configuration files.
      • host-https-port can be any custom port on host which are not currently being used by any other application.

      For more information about the parameters, refer to Running IDPV Server.

   For Kubernetes

   1. Push the latest image to your Docker registry, as mentioned in step 3 of Deploying IDPV Server in Kubernetes.

   2. Open the already configured Kubernetes-Deployment.yaml, which is used to deploy the trial version. Find key name image; update its value as below, and then save the file.

      image: <docker-registry/repository/image-name:tag>

   3. Run the following command to update the deployment:

      
      kubectl apply -f Kubernetes-Deployment.yaml
      

   The deployment is now updated with a new Docker image.