X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=ric-infra%2FREADME.md;h=487bfb7c8b69a46043d3de14f2c11db6f93f318d;hb=75b5b699748ed990eb8996652efef950eee5d9b9;hp=55251a628cd92eef2eedbdd3ed9f13ef32f667e8;hpb=7f1e409379856025977fc8a6ea04ddb215f21a13;p=it%2Fdep.git diff --git a/ric-infra/README.md b/ric-infra/README.md index 55251a62..487bfb7c 100644 --- a/ric-infra/README.md +++ b/ric-infra/README.md @@ -1,15 +1,16 @@ # RIC Infrastructure Support Helm charts, configuration files, and automation scripts that deploy a development enviroment for RIC. -A developer should star from here to create a kubernetes cluster that is pre-configured for RIC. -Such development cluster is mimicking a closed field-trial environment. - +A developer should start from here to create a kubernetes cluster that is pre-configured for RIC. +Such a development cluster is mimicking a closed field-trial environment. ### Directory Structure . ├── 00-Kubernetes Contains scripts to deploy K8S cluster ├── 10-Nexus Contains scripts and helm charts to deploy the docker registry and helm repo +├── 20-Monitoring Helm charts for installed ELFK stack +├── 40-Credential Helm charts to onboard credential and secrets for docker registry and helm repo └── README.md This file @@ -40,4 +41,26 @@ In the one-click deployment solution, the above setting will be overrided by env The installation process of the Nexus repo manager will generate certificates and credential for docker registry and helm repo. +### To deploy ELFK stack +```sh +$ # Modify the configuration files in ./20-Monitoring/etc/ +$ . ./20-Monitoring/bin/install +``` + + +### To onboard credentials +```sh +$ # Modify the user name and password in ./40-Credential/helm/values.yaml +$ # Alternatively, include the credential information in an override value yaml file +$ . ./40-Credential/bin/install +$ # If you have an override value.yaml file, please use +$ #. ./40-Credential/bin/install YOUR_OVERRIDE_FILE +``` + +### Credential Deployment Options +You can configure the Helm release name, Kubernetes namespace using configuration files located in ./40-Credential/etc/ +Please make sure that the namespace is the same one as the one used for RIC platform components. + + + TODO: Fill in the details about how to pass the credential to RIC