3.3 Upgrading OpenText Identity Console As Docker Container

When a new version of OpenText Identity Console Image is available, the administrator can perform an upgrade procedure to deploy container with the latest version of OpenText Identity Console. Ensure to store all necessary application related data persistently in Docker volumes before performing an upgrade. Perform the following steps to upgrade OpenText Identity Console using Docker Container:

  1. Download and load the latest version of the Docker image from the Software License and Download and perform the steps to install the latest version OpenText Identity Console as mentioned in Installing OpenText Identity Console.

  2. Once the latest Docker image is loaded, stop your current Docker Container using the following command:

    docker stop identityconsole-container-name

    Example:

    docker stop identityconsole-container-1
  3. Delete the existing OpenText Identity Console container by running the following command:

    docker rm identityconsole-container-name

    For example,

    docker rm identityconsole-container-1
  4. (Optional) Delete the obsolete OpenText Identity Console Docker image by running the following command:

    docker rmi identityconsole-image

    Example:

    docker rmi identityconsole:<version>
  5. The image has to be loaded into the local Docker registry. Extract and load the IdentityConsole_<version>_Containers.tar.gz file using the below commands:

    tar -xvf IdentityConsole_version_Containers.tar.gz              
    docker load --input identityconsole.tar.gz
  6. Create the OpenText Identity Console Docker Container using the following command:

    docker create --name identityconsole-container-name --env ACCEPT_EULA=Y --network=network-type --volume volume-name:/config/ identityconsole:version

    For example:

    docker create --name identityconsole-container-2 --env ACCEPT_EULA=Y --network=host --volume IDConsole-volume:/config/ identityconsole:<version>

    NOTE:

    • You can accept the EULA by setting ACCEPT_EULA environment variable to 'Y'. You can also accept the EULA from the on-screen prompt while starting the container by using -it option in the Docker create command for interactive mode.

    • --volume parameter in the above command will create a volume for storing configuration and log data. In this case, we have created a sample volume called IDConsole-volume.

  7. Copy the configuration file (edirapi.conf) from your local file system to the newly created container as /etc/opt/novell/eDirAPI/conf/edirapi.conf using the following command:

    docker cp absolute path of configuration file identityconsole-container-name:/etc/opt/novell/eDirAPI/conf/edirapi.conf

    For example,

    docker cp /home/user/edirapi.conf identityconsole-container-2:/etc/opt/novell/eDirAPI/conf/edirapi.conf

    (OpenText Identity Console 1.9 and later) A sample configuration file is shown below:

    listen = ":9000"
    pfxpassword = "novell"
    bcert = "/etc/opt/novell/eDirAPI/cert/"
    ospmode=false
    auto-fetch=false
    

    NOTE:

    • Remove the edir-hosts parameter from the configuration file and add the auto-fetch parameter.

    • If auto-fetch = false, you must manually copy the CA certificate to cert folder.

    (OpenText Identity Console 1.8 and earlier) A sample configuration file is shown below:

    listen = ":9000"
    pfxpassword = "novell"
    bcert = "/etc/opt/novell/eDirAPI/cert/"
    ospmode=false
    edir-hosts = "<ip_address-1>:636,<ip_address-2>:636"

    NOTE:

    • While upgrading to OpenText Identity Console 1.7.2 and 1.8, it is required to add OpenText eDirectory server IP to edirapi.conf file before copying it to the container.

    • If you want OpenText Identity Console to connect to multiple OpenText eDirectory trees, enter their IP addresses or domain names separated by commas

  8. Start the second container using the following command:

    docker start identityconsole-container-name

    Example:

    docker start identityconsole-container-2
  9. To check status of the running container, run the following command:

    docker ps -a