Skip to content

Latest commit

 

History

History
159 lines (97 loc) · 8.77 KB

README.md

File metadata and controls

159 lines (97 loc) · 8.77 KB
Raw

Oracle Data Integrator on Docker

Sample Docker configurations to facilitate installation, configuration, and environment setup for Docker users. This project includes quick start dockerfiles for ODI 12.2.1.2.6 and 12.2.1.3.0 based on Oracle Linux 7, Oracle JRE 8 (Server).

At the end of this configuration there will be 2 containers running : 1) DB Container 2) ODI Agent.

Prerequisites

  1. Mount a host directory as a data volume

Data volumes are designed to persist data, independent of the container’s lifecycle. The default location of the volume in container is under "/var/lib/docker/volumes". There is an option to mount a directory from your Docker engine’s host into a container as volume. In this project we will use that option for the data volume. The volume will be used to store Database datafiles and ODI domain files.

Since the volume is created as "root" user, provide read/write/execute permissions to "oracle" user (by providing permissions to "others"), as all operations inside the container happens with "oracle" user login.

    $ mkdir /scratch/DockerVolume/ODIVolume/DB
    $ mkdir /scratch/DockerVolume/ODIVolume/ODI
    $ chmod -R 777 /scratch/DockerVolume/ODIVolume
  1. Database

You need to have a running database container or a database running on any machine. The database connection details are required for creating ODI specific RCU schemas while configuring ODI domain. While using a 12.2.0.1 CDB/PDB DB, ensure PDB is used to load the schemas. RCU loading on CDB is not supported.

The Oracle Database image can be pulled from the Docker Store or the Oracle Container Registry or you can build your own using the Dockerfiles and scripts in GitHub Location

Create an environment file db.env.list

    ORACLE_SID=<DB SID>
    ORACLE_PDB=<PDB ID>
    ORACLE_PWD=<password>

Sample data should look similar to:

    ORACLE_SID=odidb
    ORACLE_PDB=odipdb
    ORACLE_PWD=Welcome1

Sample command to start the Database container:

     $ docker run --name ODIDatabase  -p 1521:1521 -p 5500:5500 -v /scratch/DockerVolume/ODIVolume/DB:/opt/oracle/oradata --env-file ./db.env.list  oracle/database:12.2.0.1-ee

The above command starts a DB container mounting a host directory as /opt/oracle/oradata for persistence. It maps the containers 1521 and 5500 port to respective host port such that the services can be accessible outside of localhost.

ODI Docker image Creation and Running

To build the ODI image, you will need the Oracle JDK (Server JRE) image as a base image. You either need to pull the Oracle JDK (Server JRE) image from the Docker Store or the Oracle Container Registry, or build the image manually using below information.

If you plan to use the available Oracle JDK image, skip the next step and continue with "Building Docker Image for ODI".

Building the Oracle JDK (Server JRE) image

You can build your own Oracle JDK (Server JRE) image using the Dockerfiles and scripts in GitHub Location. For more information, visit the OracleJava folder's README file.

Building Docker Image for ODI

IMPORTANT: you have to download the binary of ODI and put it in dockerfiles/<version> (see .download files inside dockerfiles/<version>).

To build the Docker Image for ODI, follow the steps below:

  1. Go into the dockerfiles folder and run the buildDockerImage.sh script.

    $ sh buildDockerImage.sh -h

Usage: buildDockerImage.sh -v [version] [-s]
Builds a Docker Image for Oracle Data Integrator.

Parameters:
   -v: Release version to build. Required.
        Choose one of: 12.2.1.2.6  12.2.1.3.0
   -s: skips the MD5 check of packages

Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.

$ sh buildDockerImage.sh -v 12.2.1.3.0

  2. Verify you now have the image oracle/odi:<version> in place with

    $ docker images

IMPORTANT: The resulting images will NOT have a domain pre-configured. But, it has the scripts to create and configure a ODI domain while creating a container out of the image.

Running ODI in Docker container

Create an environment file odi.env.list

    CONNECTION_STRING=<Database Host Name>:<port#>/<ORACLE_PDB>
    RCUPREFIX=<RCU_Prefix>
    DB_PASSWORD=<database_password>
    DB_SCHEMA_PASSWORD=<RCU schema Password>
    SUPERVISOR_PASSWORD=<Password for SUPERVISOR>
    WORK_REPO_NAME=<Name for WORK repository>
    WORK_REPO_PASSWORD=<Password for WORK repository>
    HOST_NAME=<Hostname where docker is running>

Sample data should look similar to:

    CONNECTION_STRING=<Database Host Name>:1521/odipdb
    RCUPREFIX=ODI1
    DB_PASSWORD=Welcome1
    DB_SCHEMA_PASSWORD=Welcome1
    SUPERVISOR_PASSWORD=Welcome1
    WORK_REPO_NAME=WORKREP
    WORK_REPO_PASSWORD=Welcome1
    HOST_NAME=<Hostname where ODI docker container is running>

To start a container with an ODI domain and agent, run the following command:

     $ docker run -t -i --name ODIContainer --env-file ./odi.env.list -v /scratch/DockerVolume/ODIVolume/ODI:/u01/oracle/user_projects -p 20910:20910 oracle/odi:12.2.1.3.0

The options "-i -t" in the above command runs the container in interactive mode and you will be able to see the commands running in the container. This includes the command for RCU creation, domain creation and configuration followed by starting ODI Agent. Mapping container port 20910 to host port 20910 enables accessing of the Agent outside of the local host.

Once the ODI container is created logs will be tailed and displayed to keep the container running.

Now you can access the Agent at http://< host name >:20910/oraclediagent

NOTES:

  1. If DB_SCHEMA_PASSWORD, SUPERVISOR_PASSWORD, WORK_REPO_PASSWORD are not provided in odi.env.list then it will generate random password and use it while running RCU. It will display generated random password on console. If you need to find the passwords at a later time, grep for "password" in the Docker logs generated during the startup of the container. To look at the Docker Container logs run:

     $ docker logs --details <Container-id>

  2. Studio is required to be used in conjunction with docker image for ODI.

  3. ODI docker image supports only Oracle Database as the repository database.

  4. For all other supported matrix information, please refer to ODI documentation. The supported database for repository mentioned above supersede the configuration matrix for ODI.

  5. As a prerequisite (Only for ODI 12.2.1.2.6), "Maximum number of sessions" field needs to be overwritten in Studio UI for the Agent created by the ODI Container. Post docker configuration, "Maximum number of sessions" is set as null in the repository database, but the Studio UI render 1000 as the default value set. User is required to explicitly overwrite the "Maximum number of sessions" value to force an update in the repository. If this step is not performed, all sessions will continue to wait in the queue and will not be processed.

    Steps to overwrite the "Maximum number of sessions" value in Studio UI

    • Login to ODI Studio
    • In Topology Navigator expand the Agents node in the Physical Architecture navigation tree
    • Select the Agent created by the ODI Container
    • Right-click and select View
    • In the Definition tab, for the field “Maximum number of sessions”, overwrite the value again to 5 and click Save button. Then again overwrite the value to 1000 and click Save button.

License

To download and run Oracle Data Integrator 12c Distribution regardless of inside or outside a Docker container, and regardless of the distribution, you must download the binaries from Oracle website and accept the license indicated at that page.

To download and run Oracle JDK regardless of inside or outside a Docker container, you must download the binary from Oracle website and accept the license indicated at that pge.

All scripts and files hosted in this project and GitHub docker-images/OracleDataIntegrator repository required to build the Docker images are, unless otherwise noted, released under the Universal Permissive License v1.0.

Copyright

Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.