Use the healthcheck middleware from oslo_middleware. This adds a new pipeline that depends if /etc/magnum/healthcheck_disable file exists. The healthcheck middleware is avalible under the /healthcheck URL. Return values: 200 OK (If the file does not exist) 503 DISABLED BY FILE (If file exists) Change-Id: I23179d5285831af12de7f392849c490d86a5682e
2.0 KiB
Configuration
Magnum has a number of configuration options which will be detailed here.
Magnum Config
The magnum configuration file is called magnum.conf
.
Magnum Pipeline
The pipeline details are contained in api-paste.ini
.
Healthcheck Middleware
This piece of middleware creates an endpoint that allows a load balancer to probe if the API endpoint should be available at the node or not.
The healthcheck middleware should be placed early in the pipeline.
Which is located in your api-paste.ini
under a section
called [filter:healthcheck]
. It should look like this:
[filter:healthcheck]
paste.filter_factory = oslo_middleware:Healthcheck.factory
backends = disable_by_file
disable_by_file_path = /etc/magnum/healthcheck_disable
The main pipeline using this filter should look something like this
also defined in the api-paste.ini
:
[pipeline:main]
pipeline = cors healthcheck request_id authtoken api_v1
If you wish to disable a middleware without taking it out of the
pipeline, you can create a file under the file path defined by
disable_by_file_path
ie.
/etc/magnum/healthcheck_disable
.
For more information see oslo.middleware.