X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=68f7ed0889e8408583b08ad58670b9022a958e3f;hb=refs%2Fchanges%2F58%2F8558%2F1;hp=20cbb00dca918f5d8f5d2eff0268a839a821ce4d;hpb=f3ce354b2e6c538b50ed990ba359d3af2283c901;p=pti%2Fo2.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 20cbb00..68f7ed0 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -13,7 +13,7 @@ Installation Guide Abstract -------- -This document describes how to install O-RAN O2 service over O-RAN INF platform. +This document describes how to install INF O2 service over O-RAN INF platform. The audience of this document is assumed to have basic knowledge in kubernetes cli, helm chart cli. @@ -24,8 +24,8 @@ Preface Before starting the installation and deployment of O-RAN O2 service, you should have already deployed O-RAN INF platform, and you need to download the helm charts or build from source as described in developer-guide. -ORAN O2 Service in E Release -============================ +INF O2 Service in E Release +=========================== 1. Provision remote cli for kubernetes over INF platform -------------------------------------------------------- @@ -108,11 +108,11 @@ The following instruction should be done outside of INF platform controller host kubectl get pods -A -2. Deploy O2 service --------------------- +2. Deploy INF O2 service +------------------------ -2.1 Retrieve Helm chart for deploying of O2 service -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +2.1 Retrieve Helm chart for deploying of INF O2 service +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code:: shell @@ -135,6 +135,10 @@ The following instruction should be done outside of INF platform controller host export OS_USERNAME= export OS_PASSWORD= + # If the external OAM IP same as OS_AUTH_URL's IP address, you can use the below command to set the environment + # export API_HOST_EXTERNAL_FLOATING=$(echo ${OS_AUTH_URL} | sed -e s,`echo ${OS_AUTH_URL} | grep :// | sed -e's,^\(.*//\).*,\1,g'`,,g | cut -d/ -f1 | sed -e 's,:.*,,g') + export API_HOST_EXTERNAL_FLOATING= + cat <o2service-override.yaml o2ims: imagePullSecrets: admin-orano2-registry-secret @@ -149,6 +153,7 @@ The following instruction should be done outside of INF platform controller host OS_USERNAME: "${OS_USERNAME}" OS_PASSWORD: "${OS_PASSWORD}" K8S_KUBECONFIG: "/opt/k8s_kube.conf" + API_HOST_EXTERNAL_FLOATING: "${API_HOST_EXTERNAL_FLOATING}" EOF @@ -163,25 +168,26 @@ The following instruction should be done outside of INF platform controller host kubectl -n ${NAMESPACE} get services |grep o2service -2.4 Verify O2 service -~~~~~~~~~~~~~~~~~~~~~ +2.4 Verify INF O2 service +~~~~~~~~~~~~~~~~~~~~~~~~~ .. code:: shell curl -k http(s)://:30205/o2ims_infrastructureInventory/v1/ -2.5 O2 Service API Swagger -~~~~~~~~~~~~~~~~~~~~~~~~~~ +2.5 INF O2 Service API Swagger +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Swagger UI can be found with URL: http(s)://:30205 -3. Register O-Cloud to SMO --------------------------- +3. Register INF O2 Service to SMO +--------------------------------- - assumed you have setup SMO O2 endpoint for registration -- O2 service will post the O-Cloud registration data to that SMO O2 endpoint +- INF O2 service will post the INF platform registration data to that SMO O2 endpoint + .. code:: shell