From: Zhang Rong(Jon) Date: Wed, 29 Dec 2021 13:28:13 +0000 (+0800) Subject: Docs: update installation guide X-Git-Tag: 1.0.0~1 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=3985a27696d6c5857ad54ecac7f8da32ad8edfc3;p=pti%2Fo2.git Docs: update installation guide 1. Fix NO_PUBKEY while update apt source of the kubernets 2. Update image address in the o2service-override.yaml Signed-off-by: Zhang Rong(Jon) Change-Id: I9ffb81cbd4d12566f4f002a1997dc88bd82978a2 --- diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 1af3489..5f29fff 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -10,9 +10,9 @@ Developer-Guide :local: -This project implements a reference implementation for O-RAN O2 IMS and DMS to expose INF platfrom to SMO with O2 interface. +This project implements a reference implementation for O-RAN O2 IMS and DMS to expose the INF platform to SMO with the O2 interface. -To contribute on this project, you are supposed to be familiar with INF platfrom as well as O-RAN O2 interface specifications: +To contribute to this project, you are supposed to be familiar with the INF platform as well as O-RAN O2 interface specifications: - `O-RAN SC INF platfrom`_ - `O-RAN O2 interface`_ @@ -22,12 +22,12 @@ To contribute on this project, you are supposed to be familiar with INF platfrom -1. Prerequisite for build environment -------------------------------------- +1. Prerequisite for building environment +---------------------------------------- * A ubuntu 18.04 host is sufficient to build o2 projects -:: +.. code:: shell # clone code from gerrit repo $ git clone "https://gerrit.o-ran-sc.org/r/pti/o2" && (cd "o2" && mkdir -p .git/hooks && curl -Lo `git rev-parse --git-dir`/hooks/commit-msg https://gerrit.o-ran-sc.org/r/tools/hooks/commit-msg; chmod +x `git rev-parse --git-dir`/hooks/commit-msg) @@ -37,12 +37,12 @@ To contribute on this project, you are supposed to be familiar with INF platfrom $ tox -e code -1. local test with docker-compose +2. Local test with docker-compose --------------------------------- * To test with docker-compose, a docker engine is supposed to be installed as well -:: +.. code:: shell $ docker-compose build $ docker-compose up -d @@ -54,7 +54,7 @@ To contribute on this project, you are supposed to be familiar with INF platfrom * To test with INF platform, you should install INF platform first, by default you will be able to use the 'admin' user -:: +.. code:: shell $ source ./admin_openrc.sh $ export |grep OS_AUTH_URL @@ -64,6 +64,7 @@ To contribute on this project, you are supposed to be familiar with INF platfrom 4, Tear down docker containers -:: +.. code:: shell + $ docker-compose down --remove-orphans diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 8768ddb..ff51d0f 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -38,7 +38,7 @@ The following instruction must be done over INF platform controller host (contro - Please see the O-RAN INF documentation to find out how to ssh to controller host of INF platform. -:: +.. code:: shell USER="admin-user" NAMESPACE="kube-system" @@ -74,20 +74,22 @@ The following instruction must be done over INF platform controller host (contro The following instruction should be done outside of INF platform controller host -:: +.. code:: shell sudo apt-get install -y apt-transport-https echo "deb http://mirrors.ustc.edu.cn/kubernetes/apt kubernetes-xenial main" | \ sudo tee -a /etc/apt/sources.list.d/kubernetes.list + gpg --keyserver keyserver.ubuntu.com --recv-keys 836F4BEB + gpg --export --armor 836F4BEB | sudo apt-key add - sudo apt-get update sudo apt-get install -y kubectl source <(kubectl completion bash) # setup autocomplete in bash into the current shell, bash-completion package should be installed first. echo "source <(kubectl completion bash)" >> ~/.bashrc # add autocomplete permanently to your bash shell. - https://get.helm.sh/helm-v3.5.3-linux-amd64.tar.gz + curl https://get.helm.sh/helm-v3.5.3-linux-amd64.tar.gz --output helm-v3.5.3-linux-amd64.tar.gz tar xvf helm-v3.5.3-linux-amd64.tar.gz - sudo cp linux-amd64/helm /usr/local/bin + sudo cp linux-amd64/helm /usr/local/bin/ source <(helm completion bash) echo "source <(helm completion bash)" >> ~/.bashrc @@ -100,7 +102,7 @@ The following instruction should be done outside of INF platform controller host kubectl config set-cluster inf-cluster --server=https://${OAM_IP}:6443 --insecure-skip-tls-verify kubectl config set-credentials ${USER} --token=$TOKEN_DATA - kubectl config set-context ${USER}@inf-cluster --cluster=inf-cluster --user ${USER} --namespace=${NAMESPACE} + kubectl config set-context ${USER}@inf-cluster --cluster=inf-cluster --user ${USER} --namespace=${NAMESPACE} kubectl config use-context ${USER}@inf-cluster kubectl get pods -A @@ -112,28 +114,30 @@ The following instruction should be done outside of INF platform controller host 2.1 Retrieve Helm chart for deploying of O2 service ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code:: shell - git clone -b e-release "https://gerrit.o-ran-sc.org/r/pti/o2" + git clone -b e-release "https://gerrit.o-ran-sc.org/r/pti/o2" 2.2 Prepare override yaml ~~~~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code:: shell export NAMESPACE=orano2 kubectl create ns ${NAMESPACE} - cd /home/sysadmin/ - source /etc/platform/openrc + export OS_AUTH_URL= + export OS_USERNAME= + export OS_PASSWORD= + cat <o2service-override.yaml o2ims: imagePullSecrets: admin-orano2-registry-secret image: - repository: registry.local:9001/admin/o2imsdms - tag: 0.1.4 + repository: nexus3.o-ran-sc.org:10004/o-ran-sc/pti-o2imsdms + tag: 1.0.0 pullPolicy: IfNotPresent logginglevel: "DEBUG" @@ -147,7 +151,7 @@ The following instruction should be done outside of INF platform controller host 2.3 Deploy by helm cli ~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code:: shell helm install o2service o2/charts/ -f o2service-override.yaml helm list |grep o2service @@ -158,10 +162,10 @@ The following instruction should be done outside of INF platform controller host 2.4 Verify O2 service ~~~~~~~~~~~~~~~~~~~~~ -:: +.. code:: shell curl -k http(s)://:30205 - curl -k http(s)://:30205/o2ims_infrastructureInventory/v1 + curl -k http(s)://:30205/o2ims_infrastructureInventory/v1/ 3. Register O-Cloud to SMO @@ -170,9 +174,13 @@ The following instruction should be done outside of INF platform controller host - assumed you have setup SMO O2 endpoint for registration - O2 service will post the O-Cloud registration data to that SMO O2 endpoint -:: +.. code:: shell - curl -k -X POST http(s)://:30205/provision/v1/smo-endpoint -d '{"endpoint": ""}' + curl -k -X 'POST' \ + 'http(s)://:30205/provision/v1/smo-endpoint' \ + -H 'accept: application/json' \ + -H 'Content-Type: application/json' \ + -d '{"endpoint": ""}' References