add docker detail

Author: wasin-waeosri

Java/.env.example

@@ -1,23 +1,12 @@
-# Core Credentials
-RTO_USER=RTO_USER
-RTO_PASSWORD=RTO_PASSWORD
-RTO_APP_KEY=RTO_APP_KEY
-RTO_SERVICE=ELEKTRON_DD
-
-#WebSocketAPI
-RTO_WS_PORT=443
-RTO_WS_APP_ID=256
+# RTO Credentials
+RTO_USER=
+RTO_PASSWORD=
+RTO_APP_KEY=
+# If you do not need to change password, do not input this RTO_WS_NEW_PASSWORD configuration
 RTO_WS_NEW_PASSWORD=
-RTO_WS_AUTH_URL=https://api.refinitiv.com:443/auth/oauth2/v1/token
-RTO_WS_DISCOVERY_URL=https://api.refinitiv.com/streaming/pricing/v1/
-RTO_WS_POSITION=443
 
-#EMA Java
-RTO_WS_RDMFIELDDICTIONARY=./etc/RDMFieldDictionary
-RTO_WS_ENUMTYPEDEF=./etc/enumtype.def
-RTO_PROXY_HOSTNAME=
-RTO_PROXY_PORT=
-RTO_PROXY_USERNAME=
-RTO_PROXY_PASSWORD=
-RTO_PROXY_DOMAIN=
-RTO_PROXY_KRB5=
+# RDP-RTO Core Configurations
+RTO_WS_PORT=443
+RDP_BASE_URL=https://api.refinitiv.com
+RDP_AUTH_URL=/auth/oauth2/v1/token
+RDP_DISCOVERY_URL=/streaming/pricing/v1/

Java/Dockerfile

@@ -6,7 +6,8 @@ COPY pom.xml .
 RUN mvn -e -B dependency:resolve
 COPY src ./src
 # Build and compile application
-RUN mvn clean -e -B package
+#RUN mvn clean -e -B package
+RUN mvn clean -e -B compile assembly:single
 
 # Run stage
 FROM openjdk:11-jre-slim

Java/pom.xml

@@ -48,30 +48,27 @@
     <build>
         <plugins>
             <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-assembly-plugin</artifactId>
+                <configuration>
+                  <archive>
+                    <manifest>
+                      <mainClass>com.refinitiv.ws.cloud.MarketPriceRdpGwServiceDiscovery</mainClass>
+                    </manifest>
+                  </archive>
+                  <descriptorRefs>
+                    <descriptorRef>jar-with-dependencies</descriptorRef>
+                  </descriptorRefs>
+                </configuration>
                 <executions>
-                    <execution>
-                        <phase>package</phase>
-                        <goals>
-                            <goal>single</goal>
-                        </goals>
-                        <configuration>
-                            <archive>
-                                <manifest>
-                                    <mainClass>
-                                        <!--com.refinitiv.ema.test.TestENV-->
-                                        com.refinitiv.ws.cloud.MarketPriceRdpGwServiceDiscovery
-                                    </mainClass>
-                                </manifest>
-                            </archive>
-                            <descriptorRefs>
-                                <descriptorRef>jar-with-dependencies</descriptorRef>
-                            </descriptorRefs>
-                        </configuration>
-                    </execution>
+                  <execution>
+                    <id>make-assembly</id> <!-- this is used for inheritance merges -->
+                    <phase>package</phase> <!-- bind to the packaging phase -->
+                    <goals>
+                      <goal>single</goal>
+                    </goals>
+                  </execution>
                 </executions>
-            </plugin>
+              </plugin>
         </plugins>
     </build>
 

Python/.env.example

@@ -4,6 +4,6 @@ RDP_PASSWORD=
 RDP_APP_KEY=
 
 # RDP Core Endpoints
-RDP_BASE_URL= https://api.refinitiv.com
+RDP_BASE_URL=https://api.refinitiv.com
 RDP_AUTH_URL=/auth/oauth2/v1/token
 RDP_ESG_URL=/data/environmental-social-governance/v2/views/scores-full

Python/Dockerfile

@@ -11,16 +11,14 @@ RUN pip install --user -r requirements.txt
 FROM python:3.8.11-slim
 WORKDIR /app
 
-# Set Python buffer to make Docker print every messages instantly.
-ENV PYTHONUNBUFFERED=1
+# Update PATH environment variable + set Python buffer to make Docker print every messages instantly.
+ENV PATH=/root/.local:$PATH \
+    USERNAME=DOCKER_CONTAINER \
+    PYTHONUNBUFFERED=1
 
 # copy only the dependencies installation from the 1st stage image
 COPY --from=builder /root/.local /root/.local
 COPY rdp_apis_console.py .
 
-# update PATH environment variable
-ENV PATH=/root/.local:$PATH
-ENV USERNAME=DOCKER_CONTAINER
-
 #Run Python
 ENTRYPOINT [ "python", "./rdp_apis_console.py" ]

README.md

@@ -60,7 +60,7 @@ Please note that you *do not* need the ```""``` or ```''``` characters for a str
 
 ### Caution
 
-You *should not* share this ```.env``` file to your peers or commit/push it to the version control. You should add the file to the ```.gitignore``` file to avoid adding it to a version control or public repo accidentally.
+You *should not* share this ```.env``` file to your peers or commit/push it to the version control. You should add the file to the ```.gitignore``` file to avoid adding it to a version control or public repository accidentally.
 
 You can create a ```.env.example``` file as a template for environment variables and ```.env``` file sharing. The file has the same parameters' keys as a ```.env``` file but without sensitive values as the following example:
 
@@ -115,7 +115,7 @@ RDP_PASSWORD=<Your RDP password>
 RDP_APP_KEY=<Your RDP appkey>
 
 # RDP Core Endpoints
-RDP_BASE_URL = https://api.refinitiv.com
+RDP_BASE_URL=https://api.refinitiv.com
 RDP_AUTH_URL=/auth/oauth2/v1/token
 RDP_ESG_URL=/data/environmental-social-governance/v2/views/scores-full
 ```
@@ -249,7 +249,7 @@ RTO_PASSWORD=<Your RTO password>
 RTO_APP_KEY=<Your RTO appkey>
 
 # RDP-RTO Core Endpoints
-RDP_BASE_URL = https://api.refinitiv.com
+RDP_BASE_URL=https://api.refinitiv.com
 RDP_AUTH_URL=/auth/oauth2/v1/token
 RDP_DISCOVERY_URL=/streaming/pricing/v1/
 RTO_WS_PORT=443
@@ -287,6 +287,76 @@ discoveryUrl = baseUrl + dotenv.get("RDP_DISCOVERY_URL");
 ```
 Next, the application uses those configurations to authenticate with RDP Auth Service, get the RTO WebSocket endpoint dynamically from the Service Discovery mechanism and further connects and consume the real-time streaming data from the WebSocket server.
 
+## dotenv with Docker
+
+[Docker](https://www.docker.com/) supports the environment variables usage in the [Dockerfile](https://docs.docker.com/engine/reference/builder/#env), [docker run command](https://docs.docker.com/engine/reference/commandline/run/) and [Docker compose](https://docs.docker.com/compose/environment-variables/). 
+
+### dotenv with Dockerfile
+
+#### Dockerfile ENV instruction
+
+Let's demonstrate with the Dockerfile first. You can use the ```ENV``` instruction to set the environment variable in the image. 
+
+```
+ENV <key>=<value> ...
+```
+You can set multiple environment variables in a single ```ENV``` instruction as well.
+
+```
+ENV <key>=<value> \
+    <key>=<value> \
+    <key>=<value>
+```
+
+The Dockerfile below set both application and System's configurations in the Dockerfile. 
+
+```
+# Update PATH environment variable + set Python buffer to make Docker print every messages instantly.
+ENV PATH=/root/.local:$PATH \
+    USERNAME=DOCKER_CONTAINER \
+    PYTHONUNBUFFERED=1
+```
+All containers from the result image can access the environment variables set using Dockerfile ```ENV``` instruction, unless it is replaced by the Docker run command options. 
+
+When you run the Docker containers from the above Docker image setting, the ```System.out.println(dotenv.get("USERNAME"));``` (Java) and ``` print('User: ', os.getenv('USERNAME'))``` (Python) will print the USERNAME information as *DOCKER_CONTAINER*.
+
+#### Docker Run command
+
+You can use the ```--env``` (```-e``` for shorter syntax) options with the Docker run command to set the environment variable of the container.  
+
+```
+$> docker run --env <key>=<value> IMAGE
+```
+
+Please note that if you want to set multiple environment variables, you need to set ```--env```` multiple times
+
+```
+$> docker run --env USERNAME=DOCKER_CONTAINER_RUN --env RDP_USER=USER1 --env RDP_PASSWORD=PASSWORD --env RDP_APP_KEY=APP_KEY IMAGE
+```
+Alternatively, you can use the ```--env-file``` option to parse a file of environment variables (```.env``` file) to Docker container. 
+
+```
+$> docker run --env-file .env IMAGE
+```
+
+Example for the Python RDP application:
+
+```
+$>Python> docker build . -t python_rdp
+...
+$>Python> docker run --env-file .env --name python_console python_rdp
+```
+
+Example for the Java RTO WebSocket application:
+
+```
+$>Java> docker build . -t java_rto
+...
+$>Java> docker run --env-file .env --name java_websocket java_rto
+```
+#### Caution
+
+You *should add* ```.env``` (and ```.env.example````) file to the ```.dockerignore``` file to avoid adding it to a public Docker Hub repository.
 
 
 ## <a id="references"></a>References