Custom images are only supported on self-hosted instances of Ephemeral.
You can only create custom images for Oracle.
Ephemeral uses images to create an empty database. Ephemeral provides base images for different versions of its supported databases.
For Oracle, you can add custom images to use to create Ephemeral databases.
You manage custom images from the Custom Images list on the User Settings page. To display the User Settings page:
Click your user image at the top right of Ephemeral.
In the menu, click User Settings.
An Oracle custom image includes the following configuration.
In the Image Reference field, provide the image reference for this image.
The image reference value must follow the Open Container Specification addressable image format:
[<registry>/][<project>/]<image>[:<tag>|@<digest>]
The image reference is a path that identifies the image and where it is located.
In the Container Data Mount Path field, provide the path in the container to the database's data directory.
These settings provide connection information for databases that are created from the image:
Port - The port to use for connections to a database created from this image.
Data directory group - The Linux group identifier to mount the data directory of the database as.
Database username - The admin user for the database that is created by this image. Ephemeral uses this to create a non-admin user and a pluggable database, and to interact with the database in general.
Password environment variable - The name of the environment variable to set on the database container, to configure the password for the admin user, which is defined in the Database username field.
You specify whether the image automatically creates an initial database on startup, and provide the name of the initial database. If the image does not automatically create an initial database on startup, then Ephemeral uses the provided name to create the initial database.
By default, Ephemeral assumes that the image creates an initial database on startup, and Contains initial database is toggled to the on position. If the image does not create an initial database on startup, then toggle Contains initial database to the off position.
In the Initial database name field, provide the name of the initial database. If the image already contains an initial database, then this name must match the name of that database. If the image does not contain an initial database, then Ephemeral uses the name to create the initial database.
In the Minimum storage field, enter the minimum storage in GB that is required for databases that are created from this image.
When you start a database from this image, Ephemeral automatically generates a password for the database user.
In the Max password length field, type the maximum length for the password.
In the Oracle DBA Privilege field, provide the name of the database role that the database user assumes when it connects to the database.
In the Oracle Schema field, provide the name of the schema for the database.
You can also provide values for any additional environment variables.
Under Custom Environment Variables, to add a variable:
Click Add custom environment variable.
In the Name field for the variable, type the name of the variable.
In the Value field, type the value for the variable
To remove an environment variable, click its delete icon.
Manage custom images
Create, edit, and delete a custom image
Oracle image configuration
Configuration fields for an Oracle custom image
To create a custom image:
On the User Settings page, under Custom Images, click Create custom image.
In the Name field, provide a name for the image.
Under Select database type, click the database to create the image for. You can only create images for Oracle.
Provide the configuration details. For a list of the configuration fields, go to Oracle image configuration.
Click Create.
To edit an existing custom image:
Under Custom Images, click the edit icon for the image.
Update the configuration. You cannot change the database type. Oracle image configuration
Click Save.
To delete a custom image, under Custom Images, click the delete icon for the image.