docs/xapp_onboarder/guide/example.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 ..
   4 .. Copyright (C) 2019 AT&T Intellectual Property
   5
   6
   7 Step-by-step xApp Descriptor Design Example
   8 ===========================================
   9
  10 Step 1: Gather Information
  11 --------------------------
  12 Collect the information about the following items
  13
  14 * xApp name
  15 * Version of the xApp descriptor
  16 * Details of the xApp containers
  17 * (Optional) xApp-specific configuration parameters
  18 * (Optional) Metrics produced
  19 * (Optional) Ports for messaging
  20 * (Optional) Liveness and readiness probes methods
  21
  22 Step 2: Download config-file.json skeleton
  23 ------------------------------------------
  24 Download the config-file.json file :download:`here <config-file.json>`
  25
  26 Step 3: Change xapp_name and version
  27 ------------------------------------
  28 In the config-file.json file, change the values for "xapp_name" and "version"
  29
  30 .. note:: If xapp-onboarder is configured with ALLOW_REDEPLOY=False, you cannot reuse the same version number between onboarding.
  31
  32 Step 4: Fill in the container information
  33 -----------------------------------------
  34 The container section in the config-file.json is a list of container properties structure. For each container, give it a unique name. Specify the docker image registry, docker image name, and docker iamge tag. Optionally. Please make sure that the docker registry is accessible from the RIC platform instance to which the xApp will be deployed. If you want to specify the contianer entry point, you can specify the command used to start the container.
  35
  36
  37