src/support/README

   1 #
   2 #==================================================================================
   3 #       Copyright (c) 2020 Nokia
   4 #       Copyright (c) 2020 AT&T Intellectual Property.
   5 #
   6 #   Licensed under the Apache License, Version 2.0 (the "License");
   7 #   you may not use this file except in compliance with the License.
   8 #   You may obtain a copy of the License at
   9 #
  10 #       http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 #   Unless required by applicable law or agreed to in writing, software
  13 #   distributed under the License is distributed on an "AS IS" BASIS,
  14 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 #   See the License for the specific language governing permissions and
  16 #   limitations under the License.
  17 #==================================================================================
  18 #
  19
  20 This directory contains the source for any support tools which
  21 are distributed with the RMR runtime package.  Support tools
  22 might provide means to query information about an RMR based
  23 application using the RMR_CTL_PORT.
  24
  25 Support tools:
  26         rmr_probe       -- A generic health check application which
  27                                 sends n messages to the application running
  28                                 at the indicated host:port and expects to
  29                                 receive n responses. Exit code is a simple
  30                                 binary: 0 == received responses, 1 == failure.
  31
  32 Support tools are automatically built and included in the
  33 runtime package (deb or rpm).
  34
  35
  36 The original name of rmr_probe was health_ck. This was deemed too
  37 generic and thus is replaced by rmr_probe. We continue to build
  38 and package health_ck for a few versions allowing any containers
  39 which use that to avoid breakage.