This project uses the openSUSE Java 21 image here to build a pre-configured OpenSearch 1 Docker image.
It can be used as a base image for any projects that use OpenSearch.
The vm.max_map_count kernel setting needs to be set on host to at least 262144 for production use:
sysctl -w vm.max_map_count=262144
Tini is pre-installed in the container. If the image entrypoint is not overwritten then it will be automatically used.
PostgreSQL Client is pre-installed in the container. psql is a terminal-based front-end to PostgreSQL. It enables you to type in queries interactively, issue them to PostgreSQL, and see the query results. Alternatively, input can be from a file or from command line arguments. In addition, psql provides a number of meta-commands and various shell-like features to facilitate writing scripts and automating a wide variety of tasks.
DejaVu Fonts is pre-installed in the container. The DejaVu fonts are a font family based on the Bitstream Vera Fonts. Its purpose is to provide a wider range of characters while maintaining the original look and feel through the process of collaborative development.
su-exec is pre-installed in the container. su-exec allows derived images to run commands as a specified user, rather than as the default user.
Note: gosu has been replaced with su-exec, however gosu command is still supported as a symlink to su-exec.
To use su-exec, set the RUNAS_USER environment variable in the derived container's Dockerfile. Subsequent commands will then be run as the specified user:
ENV RUNAS_USER=my-user
CMD ["whoami"] # Outputs my-user
Note: the user specified by the RUNAS_USER is expected to already exist, and the CMD will fail if this is not the case.
Any executable scripts added to the /startup/startup.d/ directory will be automatically run each time the container is started (assuming the image entrypoint is not overwritten).
The image comes pre-installed with a startup script which provides a mechanism to extend the CA certificates which should be trusted.
The image comes pre-installed with a startup script which provides support for file-based secrets.
It works by looking for environment variables ending with the _FILE prefix and setting the environment variable base name to the contents of the file.
For example, given this environment variable ending in the _FILE suffix:
ABC_PASSWORD_FILE=/var/somefile.txt
the script will read the contents of /var/somefile.txt (for example 'mypassword'), and export an environment variable named ABC_PASSWORD:
ABC_PASSWORD=mypassword
This feature is disabled by default. To enable it, ensure a USE_FILE_BASED_SECRETS environment variable is present, with a value of true, for example, USE_FILE_BASED_SECRETS=true.
The image comes pre-installed with a utility script which can be used to check if a PostgreSQL database exists and to create it if it does not.
When the script is called it must be passed an environment variable prefix for the service:
/scripts/check-create-pgdb.sh SERVICE_
The script then reads the database details from a set of environment variables with the specified prefix:
| Environment Variable | Description |
|---|---|
SERVICE_DATABASE_HOST |
The host name of the machine on which the PostgreSQL server is running. |
SERVICE_DATABASE_PORT |
The TCP port on which the PostgreSQL server is listening for connections. |
SERVICE_DATABASE_USERNAME |
The username to use when establishing the connection to the PostgreSQL server. |
SERVICE_DATABASE_PASSWORD |
The password to use when establishing the connection to the PostgreSQL server. |
SERVICE_DATABASE_APPNAME |
The application name that PostgreSQL should associate with the connection for logging and monitoring. |
SERVICE_DATABASE_NAME |
The name of the PostgreSQL database to be created. |
docker run -d --name os1 -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" cafapi/opensuse-opensearch1
Send requests to the server to verify that OpenSearch is up and running:
curl -ku 'admin:admin' https://localhost:9200
curl -ku 'admin:admin' https://localhost:9200/_cat/nodes?v
curl -ku 'admin:admin' https://localhost:9200/_cat/plugins?v