src/support/README

#
#==================================================================================
#       Copyright (c) 2020 Nokia
#       Copyright (c) 2020 AT&T Intellectual Property.
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
#==================================================================================
#

This directory contains the source for any support tools which
are distributed with the RMR runtime package.  Support tools
might provide means to query information about an RMR based
application using the RMR_CTL_PORT.

Support tools:
	rmr_probe	-- A generic health check application which
				sends n messages to the application running
				at the indicated host:port and expects to
				receive n responses. Exit code is a simple
				binary: 0 == received responses, 1 == failure.

Support tools are automatically built and included in the 
runtime package (deb or rpm).


The original name of rmr_probe was health_ck. This was deemed too
generic and thus is replaced by rmr_probe. We continue to build
and package health_ck for a few versions allowing any containers
which use that to avoid breakage.