Add first set of SI95 unit tests and health check

[ric-plt/lib/rmr.git] / src / support / README

diff --git a/src/support/README b/src/support/README
new file mode 100644 (file)
index 0000000..7e274d1
--- /dev/null
+++ b/src/support/README
@@ -0,0 +1,34 @@
+#
+#==================================================================================
+#       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:
+       health_ck       -- 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).