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 star from here to create a kubernetes cluster that is pre-configured for RIC.
   5 Such development cluster is mimicking a closed field-trial environment.
   6
   7
   8
   9 ### Directory Structure
  10 .
  11 ├── 00-Kubernetes             Contains scripts to deploy K8S cluster
  12 ├── 10-Nexus                  Contains scripts and helm charts to deploy the docker registry and helm repo
  13 └── README.md                 This file
  14
  15
  16 ### To deploy the Kubernetes cluster
  17 ```sh
  18 $ # Modify the configuration files in ./00-Kubernetes/etc/
  19 $ . ./00-Kubernetes/bin/install
  20 ```
  21
  22 ### To deploy Nexus repo manager
  23 ```sh
  24 $ # Modify the configuration files in ./10-Nexus/etc/
  25 $ . ./10-Nexus/bin/install
  26 ```
  27
  28
  29 ### Nexus Deployment Options
  30 You can configure the Helm release name, Kubernetes namespace, and specify ingress controller port using configuration
  31 files located in ./10-Nexus/etc/
  32
  33 In the one-click deployment solution, the above setting will be overrided by environment variables shown below.
  34 *RICINFRA_RELEASE_NAME
  35 *RICINFRA_NAMESPACE
  36 *INGRESS_PORT
  37
  38
  39 ### Passing credential to RIC
  40 The installation process of the Nexus repo manager will generate certificates and credential for docker registry and
  41 helm repo.
  42
  43 TODO: Fill in the details about how to pass the credential to RIC