Docker-compose for Oracle APEX
Hello everyone and welcome back to our blog...
In the previous post, we showed you how to run an Oracle XE instance in a docker container and then run ORDS in another container to use it to connect to APEX.
We first downloaded the Images we needed, then we had to write some codes in the console/Terminal to configure the networks and volumes and for each time we wanted to spin up a DB container or an ORDS container, we had to write a docker-console command and pass all the parameters.
There is an easier way that we can use to run all the containers with the configurations in just one command, and that tool is docker-compose. In this post, we will show you how to use docker-compose and how to run APEX in docker just as we did last time.
In docker-compose, we use a YAML file to define the services we want to run. By services we mean containers, so each container is represented as a service in docker-compose. Under each service, we can list all the configurations that are related to that service. One advantage of using docker-compose is to make your commands structured, easy to read, and maintain or change. For example, see how the command for running a docker container looks like we you want to write it in the terminal:
1 2 3 4 5 6 | docker run -d --name db-container\ > -p 1521:1521\ > -e ORACLE_PWD=1230123\ > -v db-demo-volume:/opt/oracle/oradata\ > --network=demo-network\ > --hostname database > oracle-xe-21.3 |
It is not easy to read right :). Now let's see how docker-compose will help us make this more efficient.
Oracle XE Service
We will first define the Oracle XE service with its related configurations in our compose file:
1 2 3 4 5 6 7 8 9 10 11 12 13 | version: '3.9'
services:
devdb:
container_name: devdb
image: container-registry.oracle.com/database/express:latest
ports:
- 1521:1521
environment:
- ORACLE_PWD=1230123
volumes:
- dev-vol:/opt/oracle/oradata
hostname: oracledev
|
Keep in mind that the first line of every docker-compose file is for specifying the Compose file format version. In our example, we are using version 3.9.
- The third line is the services we want this file to run, by services we mean containers. Under the services, we will list the containers we want to run.
- devdb is the name for our first service (container), the name can be anything but you better give meaningful names. Under this service, we will list the configurations related to it.
- container_name This is equivalent to the --name tag when using the terminal.
- image is the image to be used for spinning up the container
- ports to map the ports between the container and the host. The first port is the host port and the second specifies the container port. This is equivalent to -p.
- environment under this we pass the environment variable to the container, in our example, we are passing the oracle_pwd. This is equivalent to -e (You can create an env file and save all environment variables in it).
- volumes to specify the paths to mount on the host and the container. The first path is the host and the second is the containers' path. This is equivalent to -v (At the end of the file we will define our volumes).
- hostname giving a name to the DB host machine. This is equivalent to --hostname.
ORDS Service
14 15 16 17 18 19 20 21 22 23 | ords: container_name: ords restart: always depends_on: - devdb volumes: - ./variables:/opt/oracle/variables ports: - 8181:8181 image: container-registry.oracle.com/database/ords:latest |
As you see, it is almost the same as the first service, we have changed the name of the service and container, ports, volume, and the image to use. We just added three lines 16, 17, and 18.
- restart this will restart the service every time it fails. The database will take some time to be ready to use, in this time ORDS will try to connect to the database and it will fail, so we are retrying to connect every time until the connection is established.
- depends_on we don't want ORDS service to start before the database service starts. So we are telling the compose that this service has to start after the devdb service.
Network and Volumes
24 25 26 27 28 29 30 | volumes: dev-vol: name: db-vol external: false networks: default: name: demo-network |
Final Compose file
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 | version: '3.9' services: devdb: container_name: devdb image: container-registry.oracle.com/database/express:latest ports: - 1521:1521 environment: - ORACLE_PWD=1230123 volumes: - dev-vol:/opt/oracle/oradata hostname: oracledev ords: container_name: ords restart: always depends_on: - devdb volumes: - ./variables:/opt/oracle/variables |
Docker-compose commands
Up
1 | docker-compose up |
Down
1 | docker-compose down |
Stop
1 | docker-compose stop |
1 | docker login container-registry.oracle.com |
- https://docs.docker.com/compose/
Labels: apex, docker, docker-compose, oracle xe, yaml
4 Comments:
Sad that tutorial is was not tested :(
ERROR: Named volume "ords-vol:/opt/oracle/variables:rw" is used in service "ords" but no declaration was found in the volumes section.
thank you for mentioning, I have updated the code :)
Thanks for the informations;)
Thanks for the article;)
Post a Comment
Note: Only a member of this blog may post a comment.
Subscribe to Post Comments [Atom]
<< Home