Add initial codes

[it/test.git] / ric_robot_suite / helm / nanobot / README

diff --git a/ric_robot_suite/helm/nanobot/README b/ric_robot_suite/helm/nanobot/README
new file mode 100644 (file)
index 0000000..693fced
--- /dev/null
+++ b/ric_robot_suite/helm/nanobot/README
@@ -0,0 +1,32 @@
+#   Copyright (c) 2019 AT&T Intellectual Property.
+#   Copyright (c) 2019 Nokia.
+#
+#   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 a Helm chart for the minimal robot container
+and Kubernetes job.
+
+The job mounts its testsuites directory as a configmap, built from
+files in nanobot/configmap-src/testsuites.  Template expansion is
+performed on files in that directory.
+
+To install the chart, edit values.yaml to reflect your environment
+and desired tests and run
+
+$ helm install --namespace <namespace> nanobot
+
+The namespace selected will be where the job's service account is
+created and the job runs.  It may but need not be the same as the RIC
+platform or xapp namespace.
+
+