ric_robot_suite/helm/nanobot/README

   1 #   Copyright (c) 2019 AT&T Intellectual Property.
   2 #   Copyright (c) 2019 Nokia.
   3 #
   4 #   Licensed under the Apache License, Version 2.0 (the "License");
   5 #   you may not use this file except in compliance with the License.
   6 #   You may obtain a copy of the License at
   7 #
   8 #       http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #   Unless required by applicable law or agreed to in writing, software
  11 #   distributed under the License is distributed on an "AS IS" BASIS,
  12 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #   See the License for the specific language governing permissions and
  14 #   limitations under the License.
  15
  16 This directory contains a Helm chart for the minimal robot container
  17 and Kubernetes job.
  18
  19 The job mounts its testsuites directory as a configmap, built from
  20 files in nanobot/configmap-src/testsuites.  Template expansion is
  21 performed on files in that directory.
  22
  23 Configuration of the chart is split between the "recipe" used to
  24 deploy the RIC (and consumed by the ric-common chart, which is
  25 required for this chart) and the chart's own values.yaml file.
  26 Generally, RIC platform configuration is specified by the recipe, and
  27 robot and xapp configuration from the chart's values.yaml, although
  28 there is some overlap.
  29
  30 Support files (testsuites, keyword definition libraries, scripts, and
  31 variable definition files) for the robot framework itself are supplied
  32 by k8s configmaps generated from the contents of subdirectories of the
  33 configmap-src directory; those subdirectories may contain one or more of
  34 the following directories:
  35
  36 bin/:        scripts/binaries, mounted at /robot/bin
  37 testsuites/: test suites, mounted at /robot/testsuites
  38 properties/: variable definition (properties) files;
  39              contents mounted at /robot/resources
  40 resources/:  robot keyword definition libraries, contents
  41              mounted at /robot/resources
  42
  43 Helm template expansion is performed on the contents of all
  44 directories.
  45 Because both resources/ and properties/ are mounted at
  46 robot/resources, care should be taken to ensure that names do not
  47 collide across those directories, particularly between trees.
  48
  49
  50 To install the chart (which creates and runs a single Kubernetes job),
  51 edit values.yaml to reflect your environment and desired tests and run
  52
  53 $ helm install [--values <override-file> ] --namespace <namespace> nanobot
  54
  55 ... where <override-file> is the recipe override file used when
  56 deploying the RIC, if any.
  57
  58 The namespace selected will be where the job's service account is
  59 created and the job runs.  It may but need not be the same as the RIC
  60 platform or xapp namespace —- the chart may be deployed in any
  61 namespace.
  62
  63