{"id":12844,"date":"2019-10-01T21:31:36","date_gmt":"2019-10-01T19:31:36","guid":{"rendered":"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/"},"modified":"2025-10-24T09:32:12","modified_gmt":"2025-10-24T07:32:12","slug":"a-small-footprint-container-with-idql-iapi-clients","status":"publish","type":"post","link":"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/","title":{"rendered":"A Small Footprint Docker Container with Documentum command-line Tools"},"content":{"rendered":"

The aim here is to have a minimalist container with the usual Documentum clients idql, iapi, dmawk and dmqdocbroker.
\nDocumentum Administrator (DA) could also be a useful addition to our toolbox. We will show how to containerize it in a future article. A word of warning is in order here: the title’s catchy “small footprint” qualifier is relative. Don’t forget that said container will contain a certified O\/S, a JRE, the DFCs and a few support shared libraries. Under these conditions, at more than 600 Mb, it is as small as it can get.
\nSince those clients are part of the content server (CS) and not packaged separately, we must first start with a full installation of the content server binaries and next we’ll remove all the non-essential parts. We chose the latest available CS version, currently v16.4.
\nThe cute little utility dctm-wrapper discussed in Connecting to a Repository via a Dynamically Edited dfc.properties File (part I)<\/a> is also included because it makes it unnecessary to manually edit the container’s dfc.properties file each time a new repository on a different machine needs to be accessed; this will be done dynamically by the utility itself.
\nThe instructions to create the image are given in a dockerfile. We chose to base the image on the Centos distribution because as a Red Hat derivative it is implicitly certified and does not require any subscription. However, any other Documentum-certified Linux distribution such as RedHat, Suze or Ubuntu will do. Some adaptation may be in order though, e.g. adding libraries to $LD_LIBRARY_PATH or syminking libraries under another version suffix. Check the installation manual for details.
\nThe working directory is quite flat:
\n
\ndmadmin@dmclient:~\/builds\/documentum\/clients$ ll -R
\n.:
\ntotal 24
\n-rw-rw-r-- 1 dmadmin dmadmin 68 Aug 1 10:28 dctm-secrets
\ndrwxrwxr-x 2 dmadmin dmadmin 4096 Aug 2 11:55 files
\n-rw-rw-r-- 1 dmadmin dmadmin 7107 Aug 28 23:49 Dockerfile
\n 
\n.\/files:
\ntotal 2151304
\n-rw-rw-r-- 1 dmadmin dmadmin 872 Aug 1 10:28 linux_install_properties
\n-rwxrwxr-x 1 dmadmin dmadmin 1393568256 Aug 1 10:28 content_server_16.4_linux64_oracle.tar
\n-rwxrwxr-x 1 dmadmin dmadmin 809339975 Aug 1 10:28 CS_16.4.0080.0129_linux_ora_P08.tar.gz
\n-rw-rw-r-- 1 dmadmin dmadmin 349 Aug 1 10:28 CS_patch08.properties
\n-rwxrwxr-x 1 dmadmin dmadmin 7090 Aug 2 11:55 dctm-wrapper
\n<\/code>
\nThere is only one sub-directory, files. Read on for more details.<\/p>\n

The clients dockerfile<\/h2>\n

Let’s take a look at the clients dockerfile:<\/p>\n

\n# syntax = docker\/dockerfile:1.0-experimental\n# we are using the secret mount type;\n# cec - dbi-services - July 2019\n\nFROM centos:latest\nMAINTAINER \"cec@dbi\"\n\nRUN yum install -y sudo less unzip gunzip tar iputils hostname gawk wget bind-utils net-tools && yum clean all\n\nARG soft_repo\nARG INSTALL_OWNER\nARG INSTALL_OWNER_UID\nARG INSTALL_OWNER_GROUP\nARG INSTALL_OWNER_GID\nARG INSTALL_HOME\nARG INSTALL_TMP\nARG PRODUCT_MAJOR_VERSION\nARG JBOSS\nARG DOCUMENTUM\nARG DOCUMENTUM_SHARED\nARG DM_HOME\nARG MNT_SHARED_FOLDER\nARG SCRIPTS_DIR\n\nENV LC_ALL C\n\nUSER root\nRUN mkdir -p ${INSTALL_TMP} ${SCRIPTS_DIR} ${DOCUMENTUM} ${MNT_SHARED_FOLDER}\n\n# copy the uncompressed files;\nCOPY ${soft_repo}\/CS_patch08.properties ${soft_repo}\/linux_install_properties ${soft_repo}\/dctm-wrapper ${INSTALL_TMP}\/.\n\n# copy and expand the packages;\nADD ${soft_repo}\/content_server_16.4_linux64_oracle.tar ${INSTALL_TMP}\/.\nADD ${soft_repo}\/CS_16.4.0080.0129_linux_ora_P08.tar.gz ${INSTALL_TMP}\/.\n\nRUN groupadd --gid ${INSTALL_OWNER_GID} ${INSTALL_OWNER_GROUP}                                                                                       && \n    useradd --uid ${INSTALL_OWNER_UID} --gid ${INSTALL_OWNER_GID} --shell \/bin\/bash --home-dir \/home\/${INSTALL_OWNER} --create-home ${INSTALL_OWNER} && \n    usermod -a -G wheel ${INSTALL_OWNER}                                                                                                             && \n    chown -R ${INSTALL_OWNER}:${INSTALL_OWNER_GROUP} ${INSTALL_HOME} ${INSTALL_TMP} ${SCRIPTS_DIR} ${DOCUMENTUM} ${MNT_SHARED_FOLDER}                && \n    chmod 775 ${INSTALL_HOME} ${INSTALL_TMP} ${SCRIPTS_DIR} ${DOCUMENTUM} ${MNT_SHARED_FOLDER}\n\n# set the $INSTALL_OWNER's password passed in the secret file;\nRUN --mount=type=secret,id=dctm-secrets,dst=\/dctm-secrets . \/dctm-secrets && echo ${INSTALL_OWNER}:\"${INSTALL_OWNER_PASSWORD}\" | \/usr\/sbin\/chpasswd\nRUN rm \/tmp\/dctm-secrets\n\n# make the CLI comfortable again;\nUSER ${INSTALL_OWNER}\nRUN echo >> ${HOME}\/.bash_profile                                          && \n    echo \"set -o vi\" >> ${HOME}\/.bash_profile                              && \n    echo \"alias ll='ls -alrt'\" >> ${HOME}\/.bash_profile                    && \n    echo \"alias psg='ps -ef | grep -i'\" >> ${HOME}\/.bash_profile           && \n    echo \"export DM_HOME=${DM_HOME}\"           >> ${HOME}\/.bash_profile    && \n    echo \"export DOCUMENTUM=${DOCUMENTUM}\"     >> ${HOME}\/.bash_profile    && \n    echo \"export PATH=.:${SCRIPTS_DIR}:$PATH\" >> ${HOME}\/.bash_profile    && \n    echo >> ${HOME}\/.bash_profile                                          && \n    echo \"[[ -f ${DM_HOME}\/bin\/dm_set_server_env.sh ]] && . ${DM_HOME}\/bin\/dm_set_server_env.sh 2>&1 > \/dev\/null || true\" >> ${HOME}\/.bash_profile && \n    echo >> ${HOME}\/.bash_profile                                          && \n    mv ${INSTALL_TMP}\/dctm-wrapper ${SCRIPTS_DIR}\/. && chmod +x ${SCRIPTS_DIR}\/dctm-wrapper && \n    ln -s ${SCRIPTS_DIR}\/dctm-wrapper ${SCRIPTS_DIR}\/widql && ln -s ${SCRIPTS_DIR}\/dctm-wrapper ${SCRIPTS_DIR}\/wiapi && ln -s ${SCRIPTS_DIR}\/dctm-wrapper ${SCRIPTS_DIR}\/wdmawk\n\n# install and then cleanup useless stuff from image;\nWORKDIR ${DOCUMENTUM}\nRUN . ${HOME}\/.bash_profile && cd ${INSTALL_TMP} && .\/serverSetup.bin -f .\/linux_install_properties && echo $? && \n    tar xvf CS_16.4.0080.0129_linux_ora_P08.tar && \n    chmod +x .\/patch.bin && .\/patch.bin LAX_VM $DOCUMENTUM\/java64\/JAVA_LINK\/jre\/bin\/java -f CS_patch08.properties && echo $? && \n    cd ${DOCUMENTUM} && rm -r ${INSTALL_TMP} \/tmp\/install* && \n    rm -r tcf && rm -r tools && rm -r ${JBOSS} && rm -r jmsTools && rm -r uninstall && rm -r dba && rm -r java64\/1.8.0_152\/db && rm -r java64\/1.8.0_152\/include && rm java64\/1.8.0_152\/javafx-src.zip && \n    rm java64\/1.8.0_152\/src.zip && rm -r java64\/1.8.0_152\/man && rm -r temp\/* && \n    cd ${DOCUMENTUM}\/product\/16.4\/ && \n    rm -r diagtools && rm -r lib && rm -r convert && rm -r unsupported && rm -r oracle && rm -r install && mkdir smaller_bin && mv bin\/dm_set_server_env.sh smaller_bin\/. && mv bin\/iapi* smaller_bin\/. && \n    mv bin\/idql* smaller_bin\/. && mv bin\/dmqdocbroker* smaller_bin\/. && mv bin\/dmawk* smaller_bin\/. && mv bin\/libkmclient_shared.so* smaller_bin\/. && mv bin\/libdmcl*.so* smaller_bin\/. && \n    mv bin\/libsm_sms.so* smaller_bin\/. && mv bin\/libsm_clsapi.so* smaller_bin\/. && mv bin\/libsm_env.so* smaller_bin\/. && mv bin\/java.ini smaller_bin\/. && rm -r bin && mv smaller_bin bin && \n    cd ${DOCUMENTUM}\/dfc\/ && for f in *; do mv $f _${f}; done && mv _aspectjrt.jar aspectjrt.jar && mv _commons-lang-2.6.jar commons-lang-2.6.jar && mv _dfc.jar dfc.jar && mv _log4j.jar log4j.jar && rm -r _* \n\n# keep the container rolling;\nCMD bash -c \"while true; do sleep 60; done\"\n\n# build the image;\n# copy\/paste the commented lines below starting with the cat command uncommented:\n# cat - <<'eot' | gawk '{gsub(\/#+ *\/, ""); print}'\n# export INSTALL_OWNER=dmadmin\n# export INSTALL_OWNER_UID=1000 \n# export INSTALL_OWNER_GROUP=${INSTALL_OWNER}\n# export INSTALL_OWNER_GID=1000\n# export INSTALL_HOME=\/app\n# export INSTALL_TMP=${INSTALL_HOME}\/tmp\n# export SCRIPTS_DIR=${INSTALL_HOME}\/scripts\n# export PRODUCT_MAJOR_VERSION=16.4\n# export JBOSS=wildfly9.0.1\n# export DOCUMENTUM=${INSTALL_HOME}\/dctm \n# export DOCUMENTUM_SHARED=${DOCUMENTUM}\n# export DM_HOME=${DOCUMENTUM}\/product\/${PRODUCT_MAJOR_VERSION}\n# export MNT_SHARED_FOLDER=${INSTALL_HOME}\/shared\n# time DOCKER_BUILDKIT=1 docker build --squash --no-cache --progress=plain --secret id=dctm-secrets,src=.\/dctm-secrets \n#  --build-arg soft_repo=.\/files                              \n#  --build-arg INSTALL_OWNER=${INSTALL_OWNER}                 \n#  --build-arg INSTALL_OWNER_UID=${INSTALL_OWNER_UID}         \n#  --build-arg INSTALL_OWNER_GROUP=${INSTALL_OWNER_GROUP}     \n#  --build-arg INSTALL_OWNER_GID=${INSTALL_OWNER_GID}         \n#  --build-arg INSTALL_HOME=${INSTALL_HOME}                   \n#  --build-arg INSTALL_TMP=${INSTALL_TMP}                     \n#  --build-arg PRODUCT_MAJOR_VERSION=${PRODUCT_MAJOR_VERSION} \n#  --build-arg JBOSS=${JBOSS}                                 \n#  --build-arg DOCUMENTUM=${DOCUMENTUM}                       \n#  --build-arg DOCUMENTUM_SHARED=${DOCUMENTUM_SHARED}         \n#  --build-arg DM_HOME=${DM_HOME}                             \n#  --build-arg MNT_SHARED_FOLDER=${MNT_SHARED_FOLDER}         \n#  --build-arg SCRIPTS_DIR=${SCRIPTS_DIR}                     \n#  --tag="dbi\/dctm-clients:v1.0"                              \n#  .\n# eot\n# retag the squashed image as it has not tag:\n# docker tag <image_id> dbi\/dctm-clients:v1.0\n\n# run the image and remove the container on exit;\n# docker run -d --rm --hostname=container-clients dbi\/dctm-clients:v1.0\n\n# run the image and keep the container on exit;\n# docker run -d --name container-clients --hostname=container-clients dbi\/dctm-clients:v1.0\n\n# for trans-host container access, connect the container to an existing overlay or macvlan network, e.g.:\n# docker network connect dctmolnet01 container-clients\n<\/pre>\n
The pragma on line 1 says that we will be using an experimental feature that needs a special syntax, see below for details.
\nOn line 5, we access the docker on-line registry to download an image of Centos and base our own image on it. We will also throw in a few utilities that can be helpful later.
\nOn lines 10 to 23 we use ARG to receive the parameters passed to the build. We could have used ENV instead and hard-coded them in the dockerfile but the problem with that alternative is that those environment variables would have persisted in the containers derived from the image and since they are not used outside the build, they would just unnecessarily pollute the environment. Docker has currently no way to remove environment variables. They can be set to an empty value though, but this is not enough.
\nOn line 31, the needed files, the CS and patch installation archives along with their property files plus anything else, are imported into the image from the local host’s directory ${soft_repo}. This directory must be local to the current one and both should only contain the exact needed files in order to keep the build context small. In effect, during the context creation, the current directory and everything under it will be recursively read, which is quite a slow process.
\nOn line 39, the user dmadmin is added to the wheel group. This is a convenient trick in Centos to make dmadmin a sudoer of any command.
\nOn line 44, the experimental feature “secrets” is finally used. This enhancement lets us pass a file containing confidential information, typically passwords, without leaving any traces in the image’s overlay filesystems. The RUN statement is executed atomically and, at the end, the mounted file is dismounted silently. Outside that RUN statement, it is like nothing had happened but we quietly managed to change dmadmin user’s password. Here is its content:
\n
\ndmadmin@dmclient:~\/builds\/documentum\/da$ cat dctm-secrets
\nexport INSTALL_OWNER=dmadmin
\nexport INSTALL_OWNER_PASSWORD=dmadmin
\n<\/code>
\nIt is a bash file that is sourced in the RUN statement to give access to the key-value tuples through environment variables.
\nOn lines 59 and 60, dctm-wrapper is installed as explained in the aforementioned article, i.e. by symlinking it to widql, wiapi and wdmawk. When any of these programs is executed, it will be resolved to the wrapper, which knows what to do next. Please, refer to that article for details.
\nOn lines 64, the Documentum content server is installed in silent mode; the parameter file is the default sample one:
\n
\ndmadmin@dmclient:~\/builds\/documentum\/clients$ cat files\/linux_install_properties
\n# silent install response file
\n# used to install the binaries;
\n 
\nINSTALLER_UI=silent
\nKEEP_TEMP_FILE=false
\n 
\n####installation
\n##default documentum home directory, on linux, this attribute is supposed to be set in the env so don't need
\n##SERVER.DOCUMENTUM=\/opt\/documentum
\n##app server port
\nAPPSERVER.SERVER_HTTP_PORT=9080
\n##app server password
\nAPPSERVER.SECURE.PASSWORD=jboss
\n##enable cas as default
\nSERVER.CAS_LICENSE=XXXXXXXXX
\n 
\n# provide the lockboxpassphrase for existing lockbox files. the file name and lockboxpassphrase must be start with 1 and sequentially increased and cannot skip any number
\n# for example, SERVER.LOCKBOX_FILE_NAME1=lockbox1.lb, SERVER.LOCKBOX_FILE_NAME2=lockbox2.lb, SERVER.LOCKBOX_FILE_NAME3=lockbox3.lb
\n# same rule applies to SERVER.LOCKBOX_PASSPHRASE.PASSWORD=
\nSERVER.LOCKBOX_FILE_NAME1=lockbox.lb
\nSERVER.LOCKBOX_PASSPHRASE.PASSWORD1=
\n<\/code>
\nSince we do not create repositories but just use a minimalist set of files needed by the clients, that file could be simplified to:
\n
\n# silent install response file
\nINSTALLER_UI=silent
\nKEEP_TEMP_FILE=false
\n<\/code>
\nOn line 66, the patch P08, the latest available one for CS v16.4 as of this writing, is extracted and on the next line it is installed in silent mode too. Its edited property file CS_patch08.properties looks like this:
\n
\ndmadmin@dmclient:~\/builds\/documentum\/clients$ cat files\/CS_patch08.properties
\n# Sun Apr 28 13:24:15 CEST 2019
\n# Replay feature output
\n# ---------------------
\n# This file was built by the Replay feature of InstallAnywhere.
\n# It contains variables that were set by Panels, Consoles or Custom Code.
\n 
\n#all
\n#---
\nINSTALLER_UI=silent
\nUSER_SELECTED_PATCH_ZIP_FILE=CS_16.4.0080.0129_linux_ora.tar.gz
\ncommon.installLocation=\/app\/dctm
\n<\/code>
\nLines 68 to 74 delete all the files from the content server package that are not used by the clients. Small files are not worth the effort so they are left behind.
\nThe DFCs have been empirically kept to a minimum. Normally, there should not be any surprise because the iapi, idql and dmawk are legacy clients that only scratch the surface of the DFCs and don’t use any other jars.
\nOn line 77, an endless loop is defined in order to keep the container running. In effect, if no process is (no longer) running inside a container, that container will be shut down. Here, the container does nothing per se, it just provides tools to be invoked externally and would exit immediately if it weren’t for the sleeping loop.
\nStarting with line 79, the commented out instructions to build and run the image are listed, for we feel it is handy to have them all in one place. They could also be wrapped up into a script file if this is more convenient.<\/p>\n
Building the image<\/h2>\n
To build the image, use the command below:<\/p>\n
\nexport INSTALL_OWNER=dmadmin\nexport INSTALL_OWNER_UID=1000\nexport INSTALL_OWNER_GROUP=${INSTALL_OWNER}\nexport INSTALL_OWNER_GID=1000\nexport INSTALL_HOME=\/app\nexport INSTALL_TMP=${INSTALL_HOME}\/tmp\nexport SCRIPTS_DIR=${INSTALL_HOME}\/scripts\nexport PRODUCT_MAJOR_VERSION=16.4\nexport JBOSS=wildfly9.0.1\nexport DOCUMENTUM=${INSTALL_HOME}\/dctm\nexport DOCUMENTUM_SHARED=${DOCUMENTUM}\nexport DM_HOME=${DOCUMENTUM}\/product\/${PRODUCT_MAJOR_VERSION}\nexport MNT_SHARED_FOLDER=${INSTALL_HOME}\/shared\ntime DOCKER_BUILDKIT=1 docker build --squash --no-cache --progress=plain --secret id=dctm-secrets,src=.\/dctm-secrets \n--build-arg soft_repo=.\/files                              \n--build-arg INSTALL_OWNER=${INSTALL_OWNER}                 \n--build-arg INSTALL_OWNER_UID=${INSTALL_OWNER_UID}         \n--build-arg INSTALL_OWNER_GROUP=${INSTALL_OWNER_GROUP}     \n--build-arg INSTALL_OWNER_GID=${INSTALL_OWNER_GID}         \n--build-arg INSTALL_HOME=${INSTALL_HOME}                   \n--build-arg INSTALL_TMP=${INSTALL_TMP}                     \n--build-arg PRODUCT_MAJOR_VERSION=${PRODUCT_MAJOR_VERSION} \n--build-arg JBOSS=${JBOSS}                                 \n--build-arg DOCUMENTUM=${DOCUMENTUM}                       \n--build-arg DOCUMENTUM_SHARED=${DOCUMENTUM_SHARED}         \n--build-arg DM_HOME=${DM_HOME}                             \n--build-arg MNT_SHARED_FOLDER=${MNT_SHARED_FOLDER}         \n--build-arg SCRIPTS_DIR=${SCRIPTS_DIR}                     \n--tag=\"dbi\/dctm-clients:v1.0\"                              \n.\n<\/pre>\n
Don’t forget the tiny little dot at the bottom \ud83d\ude09
\nThe instructions are given on lines 81 to 112 in the dockfile too. Just uncomment the first line (the cat command), copy\/paste all the lines up to the dot included and add a line containing only the word “eot” to close the here-document; afterwards, copy\/paste all the generated text on the shell and Bob’s your uncle.
\nThe image creation takes up a little under 5.5 minutes on my old, faithful machine, mostly taken up by the Documentum installer (3mn) and next by the ––squash option on line 14 (42s). This too is an experimental option that merges together all the file system layers into a single one and removes deleted files. The net result is a much more compact image, it goes from 5.06 Gb down to 625 Mb. We *have* to use it here otherwise there would be no point in going through the effort of removing unnecessary files to produce an as compact as possible image.
\nThe resulting size is now exactly the one effectively taken up by all the files in the image as shown from within a running image:
\n
\n[dmadmin@container-clients dctm]$ sudo du -ms \/
\n...
\n622\t\/
\n<\/code>
\nThere are pros and cons of using ––squash but that option has no perceptible drawbacks in our case.
\nLet’s now look at the produced images’sizes from the outside:<\/p>\n
\ndmadmin@dmclient:~\/builds\/documentum\/clients$ docker image ls\nREPOSITORY            TAG                 IMAGE ID            CREATED             SIZE\n<none>                <none>              85b59eb66c00        3 minutes ago       625MB\ndbi\/dctm-clients      v1.0                bb0038f8a577        4 minutes ago       5.06GB\n<\/pre>\n
Note that the ––squash option produced a new image, here with the id 85b59eb66c00. We’d expect it to replace the original image instead of creating a new one but it’s OK too, we have both now, the original one and the squashed one. Note also how that image’s size has shrunk almost ten-fold. Let’s tag it the way it should have been:<\/p>\n
\ndmadmin@dmclient:~\/builds\/documentum\/clients$ docker tag 85b59eb66c00 dbi\/dctm-clients:v1.0\ndmadmin@dmclient:~\/builds\/documentum\/clients$ docker image ls\nREPOSITORY            TAG                 IMAGE ID            CREATED             SIZE\ndbi\/dctm-clients      v1.0                85b59eb66c00        About an hour ago   625MB\n...\n<\/pre>\n
Running the image<\/h2>\n
To run the image as a temporary container, use the command below:
\n
\ndmadmin@dmclient:~\/builds\/documentum\/clients$ docker run -d --rm<\/strong> --hostname=container-clients dbi\/dctm-clients:v1.0
\n<\/code>
\nTo run the image and keep the container under the name container-clients on exit:<\/p>\n
\ndmadmin@dmclient:~\/builds\/documentum\/clients$ docker run -d --name container-clients<\/strong> --hostname=container-clients dbi\/dctm-clients:v1.0\n# check it:\ndmadmin@dmclient:~\/builds\/documentum\/clients$ docker container ls\nCONTAINER ID        IMAGE                   COMMAND                  CREATED             STATUS              PORTS                    NAMES\n97dd2f14e3ef        dbi\/dctm-clients:v1.0   \"\/bin\/sh -c 'bash -c\u2026\"   5 seconds ago       Up 3 seconds                                 container-clients\n...\n<\/pre>\n
Good. Let’s now move on and test the container. Note that usually we specify a network the container should be connected into, either when starting it or later, as shown in the example below with a custom bridge network named dctmbrnet:
\n
\n# connect the container to a custom bridge network after it has been started:
\ndocker network connect dctmbrnet container-client
\n 
\n# connect the container to a custom bridge network when starting it up:
\ndmadmin@dmclient:~\/builds\/documentum\/clients$ docker run -d --name container-clients --hostname=container-clients --network dctmbrnet dbi\/dctm-clients:v1.0
\n<\/code><\/p>\n
Testing the container-clients container from the inside<\/h2>\n
In this scenario, we need first to enter the container and then to run the usual command-line clients.
\nLet’s suppose the container is connected to some network that allows it to access remote containerized repositories. Such network can be a simple bridge network if the repositories’ containers and the container-client’s container are on the same host. Or it can be an overlay network or a macvlan network if the containers are distributed across several hosts. Or it can be any non docker network, e.g. managed by Kubernetes. So, let’s first enter the container-client’s container and then test the tools:
\n
\n# enter container-client from its host:
\ndmadmin@dmclient:~\/builds\/documentum\/clients$ docker exec -it container-client \/bin\/bash -l
\n 
\n# connect to the container02's dmtest02 repository:
\n[dmadmin@container-clients dctm]$ widql dmtest02:container02:1489 -Udmadmin -Pdmadmin
\n 
\n 
\n\tOpenText Documentum idql - Interactive document query interface
\n\tCopyright (c) 2018. OpenText Corporation
\n\tAll rights reserved.
\n\tClient Library Release 16.4.0070.0035
\n 
\n 
\nConnecting to Server using docbase dmtest02
\n[DM_SESSION_I_SESSION_START]info:  \"Session 0100c35080002a52 started for user dmadmin.\"
\n 
\n 
\nConnected to OpenText Documentum Server running Release 16.4.0080.0129  Linux64.Oracle
\n1> quit
\nBye
\nConnection to dmclient closed.
\n<\/code>
\nRemember that widql\/wiapi\/etc… end up calling the native Documentum tools idql\/iapi\/etc… So, the containerized clients do work as expected.<\/p>\n
Testing the container-clients container from its host<\/h2>\n
Since we are logged on the container’s host, we can pass commands to the container on the command-line, as show below:
\n
\ndmadmin@dmclient:~\/builds\/documentum\/clients$ docker exec -it container-clients bash -l widql dmtest02:container02:1489 -Udmadmin -Pdmadmin
\n...
\nConnected to OpenText Documentum Server running Release 16.4.0080.0129  Linux64.Oracle
\n1> quit
\nBye
\nConnection to dmclient closed.
\n<\/code>
\nNote that we use widql here because we don’t want to manually edit in advance the container-clients’ dfc.properties file; widql will do it on-the-fly for us.
\nThe above command can be shortened by defining the following aliases:
\n
\nalias widqlc='docker exec -it container-clients bash -l widql'
\nalias wiapic='docker exec -it container-clients bash -l wiapi'
\nalias dmawkc=\"docker exec -it container-clients bash -l wdmawk\"
\nalias wdmqc='docker exec -it container-clients bash -l dmqdocbroker'
\n<\/code>
\nTheir usage would be as simple as:
\n
\ndmadmin@dmclient:~\/builds\/documentum\/clients$ widqlc dmtest02:container02:1489 -Udmadmin -Pdmadmin
\ndmadmin@dmclient:~\/builds\/documentum\/clients$ wdmqc -t container02 -p 1489 -i
\ndmadmin@dmclient:~\/builds\/documentum\/clients$ dmawkc -v dmtest02:container02:1489 '{print}' ~\/.bash_profile
\n<\/code>
\ncontainer-clients will do the connection to the repositories on the host’s behalf. As such, container-clients works as a proxy for the host. <\/p>\n
Testing the container-clients container from a different host<\/h2>\n
In this scenario, we are logged on a machine different from the container’s host. Since we did not install ssh in the container, it is not possible to run something like “ssh dmadmin@container-clients widql dmtest02:container02:1489”, even supposing that the container is accessible through the network (we’d need to connect it to a macvlan network for example). But, if allowed to, we could access its host via ssh and ask it politely to send a command to the container, as examplified below:
\n
\ndmadmin@dmclient2:~$ ssh -t dmadmin@dmclient docker exec -it container-clients bash -l widql dmtest02:container02:1489 -Udmadmin -Pdmadmin
\n...
\nConnecting to Server using docbase dmtest02
\n[DM_SESSION_I_SESSION_START]info:  \"Session 0100c35080002b1a started for user dmadmin.\"
\n 
\n 
\nConnected to OpenText Documentum Server running Release 16.4.0080.0129  Linux64.Oracle
\n1> quit
\nBye
\nConnection to dmclient closed.
\n<\/code>
\nwhich again could be simplified through a local alias:
\n
\nalias widqlc=\"ssh -t dmadmin@dmclient docker exec -it container-clients bash -l widql\"
\n<\/code>
\nand invoked thusly:
\n
\ndmadmin@dmclient2:~$ widqlc dmtest02:container02:1489 -Udmadmin -Pdmadmin
\n...
\nConnected to OpenText Documentum Server running Release 16.4.0080.0129  Linux64.Oracle
\n1> quit
\nBye
\nConnection to dmclient closed.
\n<\/code><\/p>\n
Testing the container-clients container from another container<\/h2>\n
A similar scenario would be for a container (instead of a normal host) to use the container-clients to access a remote repository. In this case, the ssh client is needed on the source container and ssh server on the host dmclient (which generally has it already) and, supposing it has been installed, the same “ssh -t dmadmin@dmclient docker exec…” command as above, or an alias thereof, could be used.
\nOf course, if container-client has the whole ssh package installed and enabled, there is no need any more to go through its host machine to invoke the tools; a command like “ssh -t dmadmin@container-clients widql dmtest02:container02:1489” could be used directly or, again, a shortcut for it, from any node on the network, be it a container or a traditional host. The dmadmin account’s credentials are now needed but this is not a big deal.<\/p>\n
Conclusion<\/h2>\n
The container-clients container allows to avoid having to install the Documentum clients over and over again on administrative machines, when that is possible at all. Having such a container available also avoids having to log on servers just to use their clients locally, again if that is possible at all, for less risks to pollute or corrupt the installation. We have used it only with containers so far but, network permitting, it could also be used to access remote, non containerized repositories just as easily and transparently. Although quite useful as-is, it could be made even more so by adding Documentum Administrator in it. This is shown in the next article here Documentum Administrator in a container<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
The aim here is to have a minimalist container with the usual Documentum clients idql, iapi, dmawk and dmqdocbroker. Documentum Administrator (DA) could also be a useful addition to our toolbox. We will show how to containerize it in a future article. A word of warning is in order here: the title’s catchy “small footprint” […]<\/p>\n","protected":false},"author":40,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[229],"tags":[],"type_dbi":[],"class_list":["post-12844","post","type-post","status-publish","format-standard","hentry","category-database-administration-monitoring"],"acf":[],"yoast_head":"\nA Small Footprint Docker Container with Documentum command-line Tools - dbi Blog<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"A Small Footprint Docker Container with Documentum command-line Tools\" \/>\n<meta property=\"og:description\" content=\"The aim here is to have a minimalist container with the usual Documentum clients idql, iapi, dmawk and dmqdocbroker. Documentum Administrator (DA) could also be a useful addition to our toolbox. We will show how to containerize it in a future article. A word of warning is in order here: the title’s catchy “small footprint” […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/\" \/>\n<meta property=\"og:site_name\" content=\"dbi Blog\" \/>\n<meta property=\"article:published_time\" content=\"2019-10-01T19:31:36+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-10-24T07:32:12+00:00\" \/>\n<meta name=\"author\" content=\"Middleware Team\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Middleware Team\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"19 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/\"},\"author\":{\"name\":\"Middleware Team\",\"@id\":\"https:\/\/www.dbi-services.com\/blog\/#\/schema\/person\/8d8563acfc6e604cce6507f45bac0ea1\"},\"headline\":\"A Small Footprint Docker Container with Documentum command-line Tools\",\"datePublished\":\"2019-10-01T19:31:36+00:00\",\"dateModified\":\"2025-10-24T07:32:12+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/\"},\"wordCount\":1949,\"commentCount\":0,\"articleSection\":[\"Database Administration & Monitoring\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/\",\"url\":\"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/\",\"name\":\"A Small Footprint Docker Container with Documentum command-line Tools - dbi Blog\",\"isPartOf\":{\"@id\":\"https:\/\/www.dbi-services.com\/blog\/#website\"},\"datePublished\":\"2019-10-01T19:31:36+00:00\",\"dateModified\":\"2025-10-24T07:32:12+00:00\",\"author\":{\"@id\":\"https:\/\/www.dbi-services.com\/blog\/#\/schema\/person\/8d8563acfc6e604cce6507f45bac0ea1\"},\"breadcrumb\":{\"@id\":\"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accueil\",\"item\":\"https:\/\/www.dbi-services.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"A Small Footprint Docker Container with Documentum command-line Tools\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.dbi-services.com\/blog\/#website\",\"url\":\"https:\/\/www.dbi-services.com\/blog\/\",\"name\":\"dbi Blog\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.dbi-services.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.dbi-services.com\/blog\/#\/schema\/person\/8d8563acfc6e604cce6507f45bac0ea1\",\"name\":\"Middleware Team\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/secure.gravatar.com\/avatar\/ddcae7ba0f9d1a0e7ae707f0e689e4a9c95bb48ec49c8e6d9cc86d43f4121cb6?s=96&d=mm&r=g\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/ddcae7ba0f9d1a0e7ae707f0e689e4a9c95bb48ec49c8e6d9cc86d43f4121cb6?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/ddcae7ba0f9d1a0e7ae707f0e689e4a9c95bb48ec49c8e6d9cc86d43f4121cb6?s=96&d=mm&r=g\",\"caption\":\"Middleware Team\"},\"url\":\"https:\/\/www.dbi-services.com\/blog\/author\/middleware-team\/\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"A Small Footprint Docker Container with Documentum command-line Tools - dbi Blog","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/","og_locale":"en_US","og_type":"article","og_title":"A Small Footprint Docker Container with Documentum command-line Tools","og_description":"The aim here is to have a minimalist container with the usual Documentum clients idql, iapi, dmawk and dmqdocbroker. Documentum Administrator (DA) could also be a useful addition to our toolbox. We will show how to containerize it in a future article. A word of warning is in order here: the title’s catchy “small footprint” […]","og_url":"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/","og_site_name":"dbi Blog","article_published_time":"2019-10-01T19:31:36+00:00","article_modified_time":"2025-10-24T07:32:12+00:00","author":"Middleware Team","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Middleware Team","Est. reading time":"19 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/#article","isPartOf":{"@id":"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/"},"author":{"name":"Middleware Team","@id":"https:\/\/www.dbi-services.com\/blog\/#\/schema\/person\/8d8563acfc6e604cce6507f45bac0ea1"},"headline":"A Small Footprint Docker Container with Documentum command-line Tools","datePublished":"2019-10-01T19:31:36+00:00","dateModified":"2025-10-24T07:32:12+00:00","mainEntityOfPage":{"@id":"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/"},"wordCount":1949,"commentCount":0,"articleSection":["Database Administration & Monitoring"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/","url":"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/","name":"A Small Footprint Docker Container with Documentum command-line Tools - dbi Blog","isPartOf":{"@id":"https:\/\/www.dbi-services.com\/blog\/#website"},"datePublished":"2019-10-01T19:31:36+00:00","dateModified":"2025-10-24T07:32:12+00:00","author":{"@id":"https:\/\/www.dbi-services.com\/blog\/#\/schema\/person\/8d8563acfc6e604cce6507f45bac0ea1"},"breadcrumb":{"@id":"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.dbi-services.com\/blog\/a-small-footprint-container-with-idql-iapi-clients\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Accueil","item":"https:\/\/www.dbi-services.com\/blog\/"},{"@type":"ListItem","position":2,"name":"A Small Footprint Docker Container with Documentum command-line Tools"}]},{"@type":"WebSite","@id":"https:\/\/www.dbi-services.com\/blog\/#website","url":"https:\/\/www.dbi-services.com\/blog\/","name":"dbi Blog","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.dbi-services.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/www.dbi-services.com\/blog\/#\/schema\/person\/8d8563acfc6e604cce6507f45bac0ea1","name":"Middleware Team","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/ddcae7ba0f9d1a0e7ae707f0e689e4a9c95bb48ec49c8e6d9cc86d43f4121cb6?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/ddcae7ba0f9d1a0e7ae707f0e689e4a9c95bb48ec49c8e6d9cc86d43f4121cb6?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/ddcae7ba0f9d1a0e7ae707f0e689e4a9c95bb48ec49c8e6d9cc86d43f4121cb6?s=96&d=mm&r=g","caption":"Middleware Team"},"url":"https:\/\/www.dbi-services.com\/blog\/author\/middleware-team\/"}]}},"_links":{"self":[{"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/posts\/12844","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/users\/40"}],"replies":[{"embeddable":true,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/comments?post=12844"}],"version-history":[{"count":1,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/posts\/12844\/revisions"}],"predecessor-version":[{"id":41183,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/posts\/12844\/revisions\/41183"}],"wp:attachment":[{"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/media?parent=12844"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/categories?post=12844"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/tags?post=12844"},{"taxonomy":"type","embeddable":true,"href":"https:\/\/www.dbi-services.com\/blog\/wp-json\/wp\/v2\/type_dbi?post=12844"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}