From 641694ce196c373181c0d9c5d19689cee7e890f3 Mon Sep 17 00:00:00 2001 From: Suramya Shah Date: Fri, 23 Feb 2018 13:00:41 +0530 Subject: [PATCH] Consolidate health-check-middleware.rst Consolidate from configuration.rst into admin/health-check-middleware.rst. Change-Id: Ib4de0a26975641ae6bc44a4525423628a2a04a3c --- doc/source/admin/health-check-middleware.rst | 28 ++++++++++++++++++ doc/source/admin/index.rst | 1 + doc/source/configuration.rst | 30 -------------------- 3 files changed, 29 insertions(+), 30 deletions(-) create mode 100644 doc/source/admin/health-check-middleware.rst diff --git a/doc/source/admin/health-check-middleware.rst b/doc/source/admin/health-check-middleware.rst new file mode 100644 index 0000000000..f82b877259 --- /dev/null +++ b/doc/source/admin/health-check-middleware.rst @@ -0,0 +1,28 @@ +Health Check middleware +======================= + +This health check middleware allows an operator to configure the endpoint URL +that will provide information to a load balancer if the given API endpoint at +the node should be available or not. + +To enable the health check middleware, it must occur in the beginning of the +application pipeline. + +The health check middleware should be placed in your +``keystone-paste.ini`` in a section titled ``[filter:healthcheck]``. +It should look like this:: + + [filter:healthcheck] + use = egg:oslo.middleware#healthcheck + +Desired keystone application pipelines have been defined with this filter, +looking like so:: + + [pipeline:public_version_api] + pipeline = healthcheck cors sizelimit osprofiler url_normalize public_version_service + +It's important that the healthcheck go to the front of the pipeline for the +most efficient checks. + +For more information and configuration options for the middleware see +`oslo.middleware `_. \ No newline at end of file diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index 011dceca67..b719bb35a1 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -40,3 +40,4 @@ command-line client. federated-identity.rst identity-credential-encryption.rst endpoint-filtering.rst + health-check-middleware.rst diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index 75fe2af30f..740b301af8 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -450,36 +450,6 @@ If a response to ``list_{entity}`` call has been truncated, then the response status code will still be 200 (OK), but the ``truncated`` attribute in the collection will be set to ``true``. - -Health Check middleware -======================= - -This health check middleware allows an operator to configure the endpoint URL -that will provide information to a load balancer if the given API endpoint at -the node should be available or not. - -To enable the health check middleware, it must occur in the beginning of the -application pipeline. - -The health check middleware should be placed in your -``keystone-paste.ini`` in a section titled ``[filter:healthcheck]``. -It should look like this:: - - [filter:healthcheck] - use = egg:oslo.middleware#healthcheck - -Desired keystone application pipelines have been defined with this filter, -looking like so:: - - [pipeline:public_version_api] - pipeline = healthcheck cors sizelimit osprofiler url_normalize public_version_service - -It's important that the healthcheck go to the front of the pipeline for the -most efficient checks. - -For more information and configuration options for the middleware see -`oslo.middleware `_. - .. _`prepare your deployment`: Preparing your deployment