Faire tourner Oracle Database Server dans un container Docker

Au boulot, j'ai dû créer une base de données Oracle Enterprise en local pour pouvoir écrire des scripts dans différents langages et montrer comment se connecter à Oracle avec, par exemple, .Net, NodeJS, Python ou PHP.

L'idée a donc tout de suite été de vérifier s'il existait une image officielle. Elle existe mais, zut, ce n'est pas aussi simple que pour PostgreSQL, MySQL ou MS SQL Server.

Dans cet article, qui est une mise au propre de mes notes, nous allons installer Oracle Enterprise en local dans un container, créer une base avec des données d'exemple et accéder à cette base de plusieurs façons.

C'est un guide pas à pas pour faciliter la vie de ceux qui doivent faire la même chose — moi, par exemple, dans quelques mois, quand j'aurai tout oublié.

Ça prend un moment (Oracle est lent à s'initialiser), mais voici où nous allons : un container Oracle qui tourne, prêt à être interrogé.

Construisons tout ça, en commençant par l'image elle-même.

Télécharger une image Docker pour OracleDB​

Oui, il existe bien une image Docker appelée container-registry.oracle.com/database/enterprise:latest mais, avant de pouvoir la télécharger, il faudra faire quelques choses :

Si vous sautez une étape et essayez de télécharger l'image directement, vous obtiendrez cette erreur :

$ docker pull container-registry.oracle.com/database/enterprise:latest
Error response from daemon: Head "https://container-registry.oracle.com/v2/database/enterprise/manifests/21.3.0.0": unauthorized: Auth failed.▋

Création d'un compte gratuit sur oracle.com​

Rendez-vous sur https://container-registry.oracle.com/ords/ocr/ba/database/enterprise et créez un utilisateur en cliquant sur le bouton / lien Sign In en haut à droite.

https://container-registry.oracle.com/ords/ocr/ba/database/enterprise

https://container-registry.oracle.com/ords/ocr/ba/database/enterprise

Générer un token​

Une fois votre utilisateur validé (après réception d'un email), retournez sur le site https://container-registry.oracle.com/ords/ocr/ba/database/enterprise, connectez-vous, cliquez sur votre profil puis choisissez Auth Token.

https://container-registry.oracle.com/ords/ocr/ba/database/enterprise

Cliquez sur le bouton Generate Secret Key et copiez votre SSO Username et votre Secret Key quelque part (dans votre gestionnaire de mots de passe par exemple).

Accepter les termes de la licence​

Rendez-vous sur https://container-registry.oracle.com/ords/ocr/ba/database et cherchez enterprise dans la colonne Repository.

https://container-registry.oracle.com/ords/ocr/ba/database

Une fois connecté, cliquez sur le bouton Continue qui apparaît à droite.

https://container-registry.oracle.com/ords/ocr/ba/database

Une fenêtre popup s'affiche et, en bas, vous devrez cliquer sur Accept.

Optionnel : en retournant sur https://container-registry.oracle.com/ords/ocr/ba/database, vous verrez qu'Oracle a bien enregistré le fait que vous avez accepté ses conditions.

https://container-registry.oracle.com/ords/ocr/ba/database

Configurer votre environnement Docker local​

Dernière partie : apprendre à Docker que vous pouvez télécharger depuis le registre Oracle.

Allez en ligne de commande et tapez docker login container-registry.oracle.com.

Renseignez votre SSO Username et votre Secret Key (donnés par la page Auth Token sur oracle.com).

Docker affichera Login Succeeded.

{
    "auths": {?
        "container-registry.oracle.com": {},?
        "https://index.docker.io/v1/": {}?
    }
}

Enfin, vous pouvez récupérer l'image​

Si toutes les étapes précédentes ont été correctement réalisées, vous devriez maintenant pouvoir lancer docker pull container-registry.oracle.com/database/enterprise:latest sans erreur et télécharger l'image Docker de 3,5 Go.

Concepts importants à connaître avec Oracle v12 et suivants (passez cette section si vous voulez juste le lancer)​

Container database (CDB) versus Pluggable database (PDB)​

Dans l'architecture multi-tenant d'Oracle (introduite depuis Oracle 12c), les concepts de Container Database (CDB) et de Pluggable Database (PDB) sont fondamentaux.

Par rapport aux autres moteurs de base de données, une PDB est une base de données tandis que la CDB est l'infrastructure sous-jacente qui gère une ou plusieurs PDB, en partageant des processus d'arrière-plan et de la mémoire.

Créer un container de base de données Oracle​

Une fois l'image récupérée, nous pouvons créer notre container, c'est-à-dire notre service de base de données Oracle.

La liste des options de ligne de commande supportées est ici : https://container-registry.oracle.com/ords/ocr/ba/database/enterprise#custom-configurations

Si on le souhaite, on peut lancer une commande docker run tout de suite mais, avant, faisons un peu de configuration.

Pourquoi ? Parce que la génération du container est terriblement lente et peut prendre jusqu'à dix minutes.

Pour être le plus efficace possible, nous allons d'abord créer un ensemble de fichiers sur notre disque pour que, pendant la création de la base, Docker crée aussi automatiquement quelques tables et y insère des enregistrements.

Création de quelques fichiers de configuration​

Créez un nouveau dossier sur votre disque, allez-y, puis créez le dossier où nous mettrons nos fichiers de démarrage :

$ mkdir -p /tmp/oracle && cd $_
$ mkdir -p scripts/startup

Créons une base d'exemple Human Resources​

Oracle fournit des bases d'exemple sur la page Oracle Database Sample Schemas. Vous pouvez y télécharger l'archive db-sample-schemas-23.3.zip, l'ouvrir et aller dans le dossier human_resources. Vous y trouverez un fichier appelé hr_create.sql qui est un exemple de base RH. Il y a un second fichier appelé hr_populate.sql pour remplir les tables avec des données.

Téléchargez et copiez ces deux fichiers dans le dossier scripts/startup/sql/ que vous avez créé précédemment.

La deuxième chose à faire est de créer le fichier scripts/startup/populate_db.sh avec le contenu ci-dessous pour automatiser la création de nos tables et insérer des enregistrements dans notre base. Comme dit dans un chapitre précédent, il est important de bien se connecter à la PDB pour que les tables soient créées dans une base de données, pas dans le container.

#!/usr/bin/env bash

sqlplus -S sys/admin@localhost:1521/ORCLCDB AS SYSDBA <<EOF?
ALTER SESSION SET CONTAINER = ORCLPDB1;?
CONNECT system/admin@orclpdb1?
@/docker-entrypoint-initdb.d/startup/sql/hr_create.sql?
@/docker-entrypoint-initdb.d/startup/sql/hr_populate.sql?
COMMIT;
EXIT;
EOF

Rendez maintenant le script exécutable : chmod +x scripts/startup/populate_db.sh.

Si vous avez besoin du modèle de données, le voici :

Créer le volume OracleDBData​

Comme lancer le container est un processus très lent, nous allons créer un volume Docker pour garder la base persistante sur le disque.

Le volume conservera la base sur notre disque, dans un volume géré par Docker. Ainsi, nous pouvons arrêter le container Oracle, le redémarrer et nous ne perdrons pas notre base. La base sera persistante dans un volume auto-géré par Docker.

Lancez cette commande dans la console pour créer un volume géré par Docker :

$ docker volume create OracleDBData

Créer le réseau oracle​

Et enfin, nous allons créer un réseau spécifique pour notre container Oracle :

$ docker network create oracle

Prêt à créer le container​

Nous sommes prêts à créer notre container en lançant cette commande :

$ docker run -d \
    --name oracle-db \
    --network oracle \
    -p 1521:1521 \
    -p 5500:5500 \
    -e ORACLE_SID=ORCLCDB \
    -e ORACLE_PDB=ORCLPDB1 \
    -e ORACLE_PWD=admin \
    -v OracleDBData:/opt/oracle/oradata \
    -v ./scripts/startup/:/docker-entrypoint-initdb.d/startup \
    container-registry.oracle.com/database/enterprise:latest
▋

La commande docker run était terriblement complexe ; voici le détail :

• --name oracle-db : notre container s'appellera oracle-db (nous pourrons donc y accéder plus tard avec docker exec -it oracle-db [...]),
• --network oracle : nous créerons notre container sur le réseau oracle,
• -p 1521:1521 : Oracle utilise le port 1521 (Oracle Listener) et nous exposons ce port sur notre machine,
• -p 5500:5500 : optionnel. Oracle utilise un second port 5500 (OEM Express) et nous exposons également ce port pour pouvoir accéder à http://localhost:5500,
• -e ORACLE_SID=ORCLCDB : le SID de la base Oracle (SID signifie System identifier) est un réglage très important. Nous gardons la valeur par défaut, à savoir ORCLCDB (rappel : CDB signifie Container database)
• -e ORACLE_PDB=ORCLPDB1 : le nom de la PDB Oracle. Ici aussi, nous gardons la valeur par défaut, à savoir ORCLPDB1. (rappel : PDB signifie pluggable database).
• -e ORACLE_PWD=admin : le mot de passe des utilisateurs SYS, SYSTEM et PDBADMIN. Il n'y a pas de valeur par défaut puisque le mot de passe est généré automatiquement et doit être récupéré dans les logs (docker log). Ce paramètre modifie le mot de passe des utilisateurs SYS, SYSTEM et PDBADMIN.
• -v OracleDBData:/opt/oracle/oradata : nous rendons la base persistante sur notre disque mais peu importe où, nous laissons Docker gérer ça. Nous avons créé précédemment un volume Docker nommé OracleDBData.
• -v ./scripts/startup/:/docker-entrypoint-initdb.d/startup : cela nous permet de créer des fichiers en local dans le dossier ./scripts/startup (comme nos fichiers SQL) et de les exécuter dans le container une fois la base Oracle principale prête. Et, en effet, nous avons créé précédemment les fichiers populate_db.sh, sql/hr_create.sql et sql/hr_populate.sql dans notre dossier scripts/startup.

Constantes importantes à retenir​

À partir de maintenant, notre serveur de base de données Oracle tourne dans un container Docker. Nous allons beaucoup utiliser certaines constantes.

Voici les constantes à retenir :

• 1521 est le numéro de port à utiliser pour se connecter au service Oracle DB,
• oracle-db est le nom de notre container,
• ORCLCDB est le nom de notre CDB,
• ORCLPDB1 est le nom de notre pluggable database,
• admin est le mot de passe à utiliser et
• system est l'utilisateur employé lors de la création de la base

Si vous reprenez le script populate_db.sh, nous avions :

# highlight-next-line
sqlplus -S sys/admin@localhost:1521/ORCLCDB AS SYSDBA <<EOF?
# highlight-next-line
ALTER SESSION SET CONTAINER = ORCLPDB1;?
# highlight-next-line
CONNECT system/admin@orclpdb1?
@/docker-entrypoint-initdb.d/startup/sql/hr_create.sql?
@/docker-entrypoint-initdb.d/startup/sql/hr_populate.sql
COMMIT;
EXIT;?
EOF

Et maintenant, vous comprenez pourquoi les chaînes de connexion étaient :

• sys/admin@localhost:1521/ORCLCDB : sys est un utilisateur système d'Oracle, admin le mot de passe associé, 1521 notre port exposé et ORCLCDB le nom de notre container database,
• ALTER SESSION SET CONTAINER = ORCLPDB1; : nous devons créer nos tables et nos enregistrements dans notre base (ORCLPDB1) et
• CONNECT system/admin@orclpdb1 : system est aussi un utilisateur système d'Oracle, il sera le propriétaire de nos tables, admin est le même mot de passe associé et orclpdb1 est le nom de ce qu'Oracle appelle le service.

Lancer une console interactive dans le container de la base​

Si vous devez entrer dans le container, lancez simplement docker exec -it oracle-db bash.

À titre d'exemple fictif, nous pouvons aller dans le dossier /docker-entrypoint-initdb.d/startup à l'intérieur du container et relancer notre script ./populate_db.sh (relancer, car il a déjà été exécuté par Oracle pendant la création du container) :

Et bien sûr, nous obtiendrons plein d'erreurs illustrant le fait que les tables et les enregistrements ont déjà été créés/insérés.

Tapez exit pour quitter la console et revenir au prompt de votre machine hôte.

Travailler avec le container Oracle DB​

La commande docker run prendra environ 10 minutes.

Si vous avez Docker Desktop, basculez sur son interface, cliquez sur le lien Containers puis sur votre container oracle-db pour voir le log. Attendez de voir :

Vous obtiendrez le même écran « prêt à l'emploi » déjà montré en début d'article.

Vous pouvez aussi utiliser la ligne de commande : docker logs oracle-db --follow et attendre le message DATABASE IS READY TO USE!. Appuyez sur CTRL+C pour quitter le log.

Maintenant, nous pouvons entrer dans le container oracle-db et lancer SQL*Plus avec docker exec -it oracle-db sqlplus sys/admin@ ORCLPDB1 as sysdba (rappel : nous nous connectons à la PDB, pas au CDB).

Un mot sur le schéma​

Précédemment, nous avons créé nos tables avec le script scripts/startup/populate_db.sh. Voici le script utilisé :

#!/usr/bin/env bash

sqlplus -S sys/admin@localhost:1521/ORCLCDB AS SYSDBA <<EOF?
ALTER SESSION SET CONTAINER = ORCLPDB1;?
CONNECT system/admin@orclpdb1?
@/docker-entrypoint-initdb.d/startup/sql/hr_create.sql?
@/docker-entrypoint-initdb.d/startup/sql/hr_populate.sql?
COMMIT;
EXIT;
EOF

L'instruction CONNECT utilise l'utilisateur Oracle system. Les tables seront donc créées dans le schéma system.

Si nous lançons docker exec -it oracle-db sqlplus sys/admin@ ORCLPDB1 as sysdba et que nous essayons d'afficher les enregistrements de la table COUNTRIES, ça ne marchera pas à moins de préciser le schéma :

C'est parce que l'utilisateur sys utilise le schéma sys par défaut (on peut le voir en lançant SELECT SYS_CONTEXT('USERENV', 'CURRENT_SCHEMA') FROM dual;).

Voilà pourquoi, puisque nos tables sont dans le schéma system, nous y accédons avec SELECT * FROM SYSTEM.COUNTRIES;.

Mais nous pouvons aussi changer d'utilisateur, ne plus utiliser sys mais system, en lançant CONNECT system/admin@ orclpdb1.

Vérifier nos données fictives​

Ceci compris, voici comment voir nos données :

• Lancez docker exec -it oracle-db sqlplus sys/admin@ ORCLPDB1 as sysdba,
• Puis, dans SQL*Plus, lancez CONNECT system/admin@ orclpdb1,
• Pour des raisons esthétiques, lancez SET WRAP OFF et SET PAGESIZE 1000 et
• nous pouvons accéder à nos tables comme ceci : SELECT EMPLOYEE_ID, FIRST_NAME, LAST_NAME, EMAIL FROM EMPLOYEES;

Accéder à Oracle Enterprise Manager Database Express​

Plus tôt, lors de notre commande docker run, nous avons mappé le port 5500 du container sur notre host. Ce port est celui utilisé par Oracle Enterprise Manager Database Express (alias OEM Express).

C'est une application web accessible en surfant sur https://localhost: 5500/em/.

Connectez-vous avec system / admin et orclpdb1 comme nom de container.

https://localhost:5500/em/

Accéder à notre base avec les outils Oracle​

Oracle SQL Developer​

Vous pouvez télécharger Oracle SQL Developer. C'est un fichier ZIP et, une fois dézippé, vous pouvez lancer l'interface sans devoir installer le logiciel : c'est prêt à l'emploi.

Une fois installé, lancez-le et créez une nouvelle connexion vers :

Commencez à taper SELECT * FROM system. et appuyez sur CTRL+SPACE pour obtenir la liste des objets de ce schéma. En descendant un peu, vous trouverez employees.

Validez ou tapez simplement le SQL complet SELECT * FROM system.employees. Dans l'exemple ci-dessous, je demande la liste des régions et la liste des employés. Je lance la query en appuyant simplement sur F5 — le même résultat que celui déjà montré en début d'article.

Se connecter à Oracle SQL Developer avec le bon utilisateur​

Dans le chapitre précédent, nous avons créé une connexion avec sys comme nom d'utilisateur et, pour cette raison, si nous cliquons sur le menu Tables (Filtered) dans l'arborescence de gauche, nous obtiendrons un paquet de tables mais pas celles de l'utilisateur system, comme notre table employees.

Maintenant, en dépliant la liste des tables, nous voyons les nôtres :

Accéder à notre container Oracle DB avec Oracle SQLPlus​

Une autre façon serait d'utiliser l'image Docker officielle sql*plus comme ceci :

$ docker run --rm -it --network oracle oracletools/sqlplus:v19.18_lin SYS/admin@oracle-db:1521/orclpdb1 as sysdba▋

Une fois connectés, nous pouvons par exemple obtenir la liste des pays comme ceci :

Pour aller plus loin​

Maintenant que le container oracle-db tourne, deux articles de suite le réutilisent directement : Transformer une base Oracle en OpenData avec Oracle REST Data Services et Accéder à une base de données Oracle avec .Net, NodeJS, PHP et Python.