Docker install and upgrade

This topic describes the steps to install and upgrade PPM in a Docker container.

Before the installation and upgrade

Before installing using Docker images, install the Docker engine and client as described in the Docker documentation.

Install

Follow the steps below to install PPM from the Docker image.

  1. Open a command window on the host machine.

  2. Run the appropriate command based on the database you use:

    • If you use an Oralce database, run this command:

      Copy code 
      docker run  -v <shared_folder>:/home/ppm/shared_dir -it 
      -e JDBC_URL=jdbc:oracle:thin:@xxxx:1521/ORCL
      -e DB_SYSTEM_USER=DB_SYSTEM_USER
      -e DB_SYSTEM_PASSWORD=DB_SYSTEM_PASSWORD
      -e DB_USER=DB_USER
      -e DB_PASSWORD=DB_PASSWORD
      -e RML_DB_USER=RML_DB_USER 
      -e RML_DB_PASSWORD=RML_DB_PASSWORD
      -e REINSTALL=true 
      <PPM_DOCKER_HUB>/ppm/ppmora:<ppm_version> sh install.sh

    • If you use a PostgreSQL database, run this command:

      Copy code 
      docker run  -v <shared_folder>:/home/ppm/shared_dir -it 
      -e JDBC_URL=jdbc:postgresql://xxxxxx:5432/<DB_NAME> 
      -e DB_SYSTEM_USER=DB_SYSTEM_USER 
      -e DB_SYSTEM_PASSWORD=DB_SYSTEM_PASSWORD 
      -e DB_USER=DB_USER
      -e DB_PASSWORD=DB_PASSWORD
      -e REINSTALL=true
      -e TEMPLATE_DB=templateppm
      <PPM_DOCKER_HUB>/ppm/ppmpg:<ppm_version> sh install.sh

    Replace the following variables with your own values:

    Variable Description
    <shared_folder> The folder on the host machine that you want to share with the Docker container.

    JDBC_URL

    		 The Java Database Connectivity URL used to connect to a database.
    DB_NAME

    Name of the database.

    Applicable only when installing with a PostgreSQL database.
    DB_SYSTEM_USER The system account required for authentication when connecting to the database at the system level.
    DB_SYSTEM_PASSWORD The password associated with DB_SYSTEM_USER, required for authentication when connecting to the database at the system level.
    DB_USER The user name required for authentication when connecting to the database.
    DB_PASSWORD The password required for authentication when connecting to the database.
    RML_DB_USER

    The user name required for authentication when connecting to the RML database.

    Applicable only when installing with an Oracle database.

    RML_DB_PASSWORD

    The password required for authentication when connecting to the RML database.

    Applicable only when installing with an Oracle database.
    REINSTALL

    Specifies whether to reinstall PPM.

    Set to true to force re-installation, which will drop the existing schema.
    SERVICES_ENABLED

    Specifies whether a service node is installed or not.

    TEMPLATE_DB The name of the template database. It is automatically created after the configuration
    <ppm_version> The specific version of the Docker image.

View install log

View the installation log from this directory: <shared_folder>/install_logs.

Upgrade

Follow the steps below to update PPM from the Docker image.

  1. Open a command window on the host machine.

  2. Run the appropriate command based on the database you use:

    • If you use an Oracle database, run this command:

      Copy code 
      docker run  -v <shared_folder>:/home/ppm/shared_dir -it
      -e DB_PASSWORD=DB_PASSWORD
      <PPM_DOCKER_HUB>/ppm/ppmora:<ppm_version> sh upgrade.sh

    • If you use a PostgreSQL database, run this command:

      Copy code 
      docker run  -v <shared_folder>:/home/ppm/shared_dir -it
      -e DB_PASSWORD=DB_PASSWORD
      <PPM_DOCKER_HUB>/ppm/ppmpg:<ppm_version> sh upgrade.sh

    Replace the following variables with your own values:

    Variable Description
    <shared_folder> The folder on the host machine that you want to share with the Docker container.
    <ppm_version> The specific version of the Docker image.

View upgrade log

View the upgrade log from this directory: <shared_folder>/upgrade_logs.

Start up

Follow the steps below to start up PPM in the Docker container.

  1. Copy your license file to <shared_folder>/license/, where <shared_folder> is the folder mapped during installation.

    Note:

    • The IP address bound to the license file should match your database sever IP.
    • Make sure the license file has the .dat extension.

  2. Open a command window on the host machine, and run the appropriate command based on the database you use:

    • If you use an Oracle database, run this command:

      Copy code 
      docker run -p <host_port>:8080 -v <shared_folder>:/home/ppm/shared_dir -it 
      -e SERVICES_ENABLED=true
      -e BASE_URL=<your_base_url>:<host_port>
      <PPM_DOCKER_HUB>/ppm/ppmora:<ppm_version> sh startup.sh

    • If you use a PostgreSQL database, run this command:

      Copy code 
      run -p <host_port>:8080 -v <shared_folder>:/home/ppm/shared_dir -it 
      -e SERVICES_ENABLED=true
      -e BASE_URL=<your_base_url>:<host_port>
      <PPM_DOCKER_HUB>/ppm/ppmpg:<ppm_version> sh startup.sh

    Replace the following variables with your own values:

    Variable Description
    <host_port> The port on the host machine through which to access PPM.
    <shared_folder> The folder on the host machine that you want to share with the Docker container.
    SERVICES_ENABLED

    Specifies whether a service node is enabled or not. The default value is false.

    <ppm_version> The specific version of the Docker image.