History

Witold Bedyk abc3f8dd97 Remove Docker tag based on timestamp As agreed in spec [1] we don't want to create and publish tags based on timestamp. Story: 2001694 Task: 23322 [1] http://specs.openstack.org/openstack/monasca-specs/specs/rocky/approved/monasca-services-in-docker.html#work-items Change-Id: Id72eb0ac7be7077bfaa8b8684a45494c09d92034		2018-10-05 10:57:47 +02:00
..
example	Remove Docker tag based on timestamp	2018-10-05 10:57:47 +02:00
Dockerfile	Allow to build image with common from Gerrit	2018-09-07 14:05:13 +02:00
README.rst	Make health checks more frequent in Docker	2018-07-26 14:00:32 +02:00
ashrc	Add base Dockerfile and supporting scripts	2018-07-09 13:49:19 +02:00
build_base_image.sh	Build Docker image in zuul	2018-07-19 10:02:47 +02:00
kafka_wait_for_topics.py	Add base Dockerfile and supporting scripts	2018-07-09 13:49:19 +02:00
mysql_check.py	Implement MySQL check script for Docker	2018-07-31 08:54:51 +00:00
wait_for.sh	Minor language changes and added license headers	2018-07-10 15:08:55 +02:00

README.rst

Docker base image for Monasca services

This image is used as a starting point for images of all Monasca services.

Building monasca-base image

You need to have Docker installed (minimum tested version is 17.09). Then you can build image inside of this folder by running:

docker build --no-cache -t monasca-base:1.0.0 .

Building child image

In the example folder you can find samples of how to start building new child image using monasca-base.

Requirements

Every child image has to provide two files:

start.sh: In this starting script provide all steps that lead to the proper service start. Including usage of wait scripts and templating of configuration files. You also could provide the ability to allow running container after service died for easier debugging.
health_check.py: This file will be used for checking the status of the application running in the container. It should be used to inform Docker that service is operating and healthy. It will be useful for container orchestration like Kubernetes or Docker Swarm to properly handle services that are still running but stopped being responsive. Avoid using curl directly and instead, use health_check.py written with specific service in mind. It will provide more flexibility like when creating JSON request body.

Wait scripts

Some Python libraries are already pre-installed: pykafka and PyMySQL. They are used by wait scripts and in the process of creating the child image pip3 will reinstall them to use proper versions confronting the upper constraints file.

These wait scripts will be available in every child image and can be used in start.sh to avoid unnecessary errors and restarts of containers when they are started.

python3 /kafka_wait_for_topics.py || exit 1
python3 /mysql_check.py || exit 1
/wait_for.sh 192.168.10.6:5000 || exit 1

Please, check the content of each of these files for documentation of what environment variables are used and more usage examples.

Useful commands

List all labels of the image (you need to have jq installed):

docker inspect monasca-api:master | jq .[].Config.Labels

Get all steps of the Docker image build process history:

docker history --no-trunc <IMAGE_ID>
docker history --no-trunc monasca-base:1.0.0