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 ├── 10-Nexus                  Contains scripts and helm charts to deploy the docker registry and helm repo
  12 ├── 20-Monitoring             Helm charts for installed ELFK stack
  13 ├── 40-Credential             Helm charts to onboard credential and secrets for docker registry and helm repo
  14 └── README.md                 This file
  15
  16
  17 ### To deploy the Kubernetes cluster
  18 ```sh
  19 $ # Modify the configuration files in ./00-Kubernetes/etc/
  20 $ . ./00-Kubernetes/bin/install
  21 ```
  22
  23 ### To deploy Nexus repo manager
  24 ```sh
  25 $ # Modify the configuration files in ./10-Nexus/etc/
  26 $ . ./10-Nexus/bin/install
  27 ```
  28
  29
  30 ### Nexus Deployment Options
  31 You can configure the Helm release name, Kubernetes namespace, and specify ingress controller port using configuration
  32 files located in ./10-Nexus/etc/
  33
  34 In the one-click deployment solution, the above setting will be overrided by environment variables shown below.
  35 *RICINFRA_RELEASE_NAME
  36 *RICINFRA_NAMESPACE
  37 *INGRESS_PORT
  38
  39
  40 ### Passing credential to RIC
  41 The installation process of the Nexus repo manager will generate certificates and credential for docker registry and
  42 helm repo.
  43
  44 ### To deploy ELFK stack
  45 ```sh
  46 $ # Modify the configuration files in ./20-Monitoring/etc/
  47 $ . ./20-Monitoring/bin/install
  48 ```
  49
  50
  51 ### To onboard credentials
  52 ```sh
  53 $ # Modify the user name and password in ./40-Credential/helm/values.yaml
  54 $ # Alternatively, include the credential information in an override value yaml file
  55 $ . ./40-Credential/bin/install
  56 $ # If you have an override value.yaml file, please use
  57 $ #. ./40-Credential/bin/install YOUR_OVERRIDE_FILE
  58 ```
  59
  60 ### Credential Deployment Options
  61 You can configure the Helm release name, Kubernetes namespace using configuration files located in ./40-Credential/etc/
  62 Please make sure that the namespace is the same one as the one used for RIC platform components.
  63
  64
  65
  66 TODO: Fill in the details about how to pass the credential to RIC