X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=ric-infra%2FREADME.md;h=80b46d776cd928f5056084aa1eb40cad86d40c21;hb=refs%2Ftags%2F0.0.1;hp=55251a628cd92eef2eedbdd3ed9f13ef32f667e8;hpb=7f1e409379856025977fc8a6ea04ddb215f21a13;p=it%2Fdep.git diff --git a/ric-infra/README.md b/ric-infra/README.md index 55251a62..80b46d77 100644 --- a/ric-infra/README.md +++ b/ric-infra/README.md @@ -1,15 +1,18 @@ # 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 +├── 15-Chartmuseum Contains scripts and helm charts to deploy the Helm chart museum +├── 20-Monitoring Helm charts for installing ELFK stack +├── 30-Kong Helm charts for installing Kong Proxy/Ingress Controller +├── 40-Credential Helm charts to onboard credential and secrets for docker registry and helm repo +├── 45-Tiller └── README.md This file @@ -19,25 +22,57 @@ $ # Modify the configuration files in ./00-Kubernetes/etc/ $ . ./00-Kubernetes/bin/install ``` -### To deploy Nexus repo manager + +### To deploy the Chartmuseum +```sh +$ # An override file must be used. +$ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE +$ #. ./15-Chartmuseum/bin/install -f YOUR_OVERRIDE_FILE +$ # To uninstall, +$ . ./15-Chartmuseum/bin/uninstall +``` + + +### To deploy ELFK stack +```sh +$ # An override file must be used. +$ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE +$ . ./20-Monitoring/bin/install -f YOUR_OVERRIDE_FILE +$ # To uninstall, +$ . ./20-Monitoring/bin/uninstall +``` + + +### To deploy Kong ```sh -$ # Modify the configuration files in ./10-Nexus/etc/ -$ . ./10-Nexus/bin/install +$ # An override file must be used. +$ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE +$ . ./30-Kong/bin/install -f YOUR_OVERRIDE_FILE +$ # To uninstall, +$ . ./30-Kong/bin/uninstall ``` -### Nexus Deployment Options -You can configure the Helm release name, Kubernetes namespace, and specify ingress controller port using configuration -files located in ./10-Nexus/etc/ +### 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 +``` -In the one-click deployment solution, the above setting will be overrided by environment variables shown below. -*RICINFRA_RELEASE_NAME -*RICINFRA_NAMESPACE -*INGRESS_PORT +### 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. -### Passing credential to RIC -The installation process of the Nexus repo manager will generate certificates and credential for docker registry and -helm repo. +### To deploy an additional Tiller for xapp deployment +```sh +$ # An override file must be used. +$ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE +$ . ./45-Tiller/bin/install -f YOUR_OVERRIDE_FILE +$ # To uninstall, +$ . ./45-Tiller/bin/uninstall +``` -TODO: Fill in the details about how to pass the credential to RIC