monasca/api repository overview

⁠monasca-api Dockerfile

This image contains a containerized version of the Monasca API.

There are two implementations of the monasca-api:

• python (tagged -python or empty) - Dockerfile⁠
• java (tagged -java) - Dockerfile⁠

Currently the python images are recommended. For more information on the Monasca project, see the wiki⁠.

Source repositories: monasca-api⁠ · monasca-docker⁠

⁠Tags

The images in this repository follow a few tagging conventions:

• latest: refers to the latest stable Python point release, e.g. 1.5.0-python
• latest-python, latest-java: as above, but specifically referring to the latest stable Python or Java point release, e.g. 1.5.0
• 1.5.0, 1.5, 1: standard semver tags, based on git tags in the official repository⁠
• 1.5.0-python, 1.5-python, 1-python: as above, but specifically referring to python-based images
• mitaka, newton, etc: named versions following OpenStack release names built from the tip of the stable/RELEASENAME branches in the repository
• mitaka-python, newton-python: as above, but specifically Python-based images
• master, master-DATESTAMP: unstable builds from the master branch, not intended for general use

Note that unless otherwise specified, images will be Python-based. All Java-based images will be tagged as such, and likely will not support the configuration options described below.

⁠Usage

To run, the API needs to connect to working instances of Kafka, Influx, and MySQL. For metrics to be processed, one or more monasca-persister⁠ instances should be running as well. Alarming and alarm management management additionally require an instance of storm and monasca-thresh⁠ as well as monasca-notification⁠.

In environments resembling the official Kubernetes environment⁠ the image does not require additional configuration parameters, and can be run like so:

docker run -p 8070:8070 -it monasca/api:latest

NOTE: due to recent config file changes, this Docker container only supports API versions greater than 1.5.0. That is to say, as of this writing, there are no formal API releases supported by this Dockerfile. As such, the latest and latest-python tags will point to the latest master image until the next monasca-api release is published.

⁠Configuration

A number of environment variables can be passed to the container:

If additional values need to be overridden, new config files or jinja2 templates can be provided by mounting a replacement on top of the original template:

• /etc/monasca/api-config.conf.j2
• /etc/monasca/api-config.ini.j2
• /etc/monasca/api-logging.conf.j2

If jinja2 formatting is not desired, the environment variable CONFIG_TEMPLATE can be set to false. Note that the jinja2 template should still be overwritten (rather than the target file without the .j2 suffix) as it will be copied at runtime.

The config file sources are available in the repository⁠. If necessary, the generated config files can be viewed at runtime by running:

docker exec -it some_container_id cat /etc/monasca/api-config.conf
docker exec -it some_container_id cat /etc/monasca/api-config.ini
docker exec -it some_container_id cat /etc/monasca/api-logging.conf

⁠Troubleshooting

Container status can be checked by the following command (example):

docker ps --filter 'name=monasca' --format '{{.Names}}\t{{.Image}}\t{{.Status}}'

Result of health check can be get by the following command:

docker inspect --format '{{json .State.Health}}' monasca | python -m json.tool

Health check ExitCodes:

• 1: Keystone authentication error
• 2: Monasca API error