ric-platform/README.md

   1 # RIC Platform Components
   2
   3 Helm charts, deployment scripts and configuration files for RIC platform components.
   4
   5 ### Directory Structure
   6 .
   7 ├── 20-Credential        Helm charts to onboard credential and secrets for docker registry and helm repo
   8 ├── 50-RIC-Platform      Deployment scripts, charts and configuration files for RIC platform components
   9 └── README.md            This file
  10
  11 ### To onboard credentials
  12 ```sh
  13 $ # Modify the user name and password in ./20-Credential/helm/values.yaml
  14 $ # Alternatively, include the credential information in an override value yaml file
  15 $ . ./20-Credential/bin/install
  16 $ # If you have an override value.yaml file, please use
  17 $ #. ./20-Credential/bin/install YOUR_OVERRIDE_FILE
  18 ```
  19
  20 ### Credential Deployment Options
  21 You can configure the Helm release name, Kubernetes namespace using configuration files located in ./20-Credential/etc/
  22 Please make sure that the namespace is the same one as the one used for RIC platform components.
  23
  24 In the one-click deployment solution, the above setting will be overrided by environment variables shown below.
  25 *RICPLT_RELEASE_NAME
  26 *RICPLT_NAMESPACE
  27
  28
  29 ### To Deploy RIC Platform
  30 ```sh
  31 $ # Modify the configuration files in ./50-RIC-Platform/etc/
  32 $ . ./50-RIC-Platform/bin/install
  33 $ # If you have an override value.yaml file, please use
  34 $ #. ./50-RIC-Platform/bin/install YOUR_OVERRIDE_FILE
  35 ```
  36
  37 ### RIC Platform Deployment Options
  38 You can configure the Helm release name, Kubernetes namespace using configuration files located in ./50-RIC-Platform/etc/
  39 Please make sure that the namespace is the same one as the one used for RIC platform components.
  40
  41 In the one-click deployment solution, the above setting will be overrided by environment variables shown below.
  42 *RICPLT_RELEASE_NAME
  43 *RICPLT_NAMESPACE
  44
  45 ### To Undeploy RIC Platform
  46 ```sh
  47 $ . ./50-RIC-Platform/bin/uninstall