ric-infra/README.md

   1 # RIC Infrastructure Support
   2
   3 Helm charts, configuration files, and automation scripts that deploy a development enviroment for RIC.
   4 A developer should start from here to create a kubernetes cluster that is pre-configured for RIC.
   5 Such a development cluster is mimicking a closed field-trial environment.
   6
   7
   8 ### Directory Structure
   9 .
  10 ├── 00-Kubernetes             Contains scripts to deploy K8S cluster
  11 ├── 15-Chartmuseum            Contains scripts and helm charts to deploy the Helm chart museum
  12 ├── 20-Monitoring             Helm charts for installing ELFK stack
  13 ├── 30-Kong                   Helm charts for installing Kong Proxy/Ingress Controller
  14 ├── 40-Credential             Helm charts to onboard credential and secrets for docker registry and helm repo
  15 ├── 45-Tiller
  16 └── README.md                 This file
  17
  18
  19 ### To deploy the Kubernetes cluster
  20 ```sh
  21 $ # Modify the configuration files in ./00-Kubernetes/etc/
  22 $ . ./00-Kubernetes/bin/install
  23 ```
  24
  25
  26 ### To deploy the Chartmuseum
  27 ```sh
  28 $ # An override file must be used.
  29 $ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE
  30 $ #. ./15-Chartmuseum/bin/install -f YOUR_OVERRIDE_FILE
  31 $ # To uninstall,
  32 $ . ./15-Chartmuseum/bin/uninstall
  33 ```
  34
  35
  36 ### To deploy ELFK stack
  37 ```sh
  38 $ # An override file must be used.
  39 $ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE
  40 $ . ./20-Monitoring/bin/install -f YOUR_OVERRIDE_FILE
  41 $ # To uninstall,
  42 $ . ./20-Monitoring/bin/uninstall
  43 ```
  44
  45
  46 ### To deploy Kong
  47 ```sh
  48 $ # An override file must be used.
  49 $ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE
  50 $ . ./30-Kong/bin/install -f YOUR_OVERRIDE_FILE
  51 $ # To uninstall,
  52 $ . ./30-Kong/bin/uninstall
  53 ```
  54
  55
  56 ### To onboard credentials
  57 ```sh
  58 $ # Modify the user name and password in ./40-Credential/helm/values.yaml
  59 $ # Alternatively, include the credential information in an override value yaml file
  60 $ . ./40-Credential/bin/install
  61 $ # If you have an override value.yaml file, please use
  62 $ #. ./40-Credential/bin/install YOUR_OVERRIDE_FILE
  63 ```
  64
  65 ### Credential Deployment Options
  66 You can configure the Helm release name, Kubernetes namespace using configuration files located in ./40-Credential/etc/
  67 Please make sure that the namespace is the same one as the one used for RIC platform components.
  68
  69
  70 ### To deploy an additional Tiller for xapp deployment
  71 ```sh
  72 $ # An override file must be used.
  73 $ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE
  74 $ . ./45-Tiller/bin/install -f YOUR_OVERRIDE_FILE
  75 $ # To uninstall,
  76 $ . ./45-Tiller/bin/uninstall
  77 ```
  78