ff51d0fd686ca93ba504247739254c2dcb18814b
[pti/o2.git] / docs / installation-guide.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. Copyright (C) 2021 Wind River Systems, Inc.
4
5
6 Installation Guide
7 ==================
8
9 .. contents::
10    :depth: 3
11    :local:
12
13 Abstract
14 --------
15
16 This document describes how to install O-RAN O2 service over O-RAN INF platform.
17
18 The audience of this document is assumed to have basic knowledge in kubernetes cli, helm chart cli.
19
20
21 Preface
22 -------
23
24 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.
25
26
27 ORAN O2 Service in E Release
28 ============================
29
30 1. Provision remote cli for kubernetes over INF platform
31 --------------------------------------------------------
32
33
34 1.1 Setup Service Account over O-RAN INF platform
35 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36
37 The following instruction must be done over INF platform controller host (controller-0)
38
39 -  Please see the O-RAN INF documentation to find out how to ssh to controller host of INF platform.
40
41 .. code:: shell
42
43   USER="admin-user"
44   NAMESPACE="kube-system"
45
46   cat <<EOF > admin-login.yaml
47   apiVersion: v1
48   kind: ServiceAccount
49   metadata:
50     name: ${USER}
51     namespace: kube-system
52   ---
53   apiVersion: rbac.authorization.k8s.io/v1
54   kind: ClusterRoleBinding
55   metadata:
56     name: ${USER}
57   roleRef:
58     apiGroup: rbac.authorization.k8s.io
59     kind: ClusterRole
60     name: cluster-admin
61   subjects:
62   - kind: ServiceAccount
63     name: ${USER}
64     namespace: kube-system
65   EOF
66
67   kubectl apply -f admin-login.yaml
68   TOKEN_DATA=$(kubectl -n kube-system describe secret $(kubectl -n kube-system get secret | grep ${USER} | awk '{print $1}') | grep "token:" | awk '{print $2}')
69   echo $TOKEN_DATA
70
71
72 1.2 Setup remote cli over another linux host (ubuntu as example)
73 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
74
75 The following instruction should be done outside of INF platform controller host
76
77 .. code:: shell
78
79   sudo apt-get install -y apt-transport-https
80   echo "deb http://mirrors.ustc.edu.cn/kubernetes/apt kubernetes-xenial main" | \
81   sudo tee -a /etc/apt/sources.list.d/kubernetes.list
82   gpg --keyserver keyserver.ubuntu.com --recv-keys 836F4BEB
83   gpg --export --armor 836F4BEB | sudo apt-key add -
84   sudo apt-get update
85   sudo apt-get install -y kubectl
86
87   source <(kubectl completion bash) # setup autocomplete in bash into the current shell, bash-completion package should be installed first.
88   echo "source <(kubectl completion bash)" >> ~/.bashrc # add autocomplete permanently to your bash shell.
89
90   curl https://get.helm.sh/helm-v3.5.3-linux-amd64.tar.gz --output helm-v3.5.3-linux-amd64.tar.gz
91   tar xvf helm-v3.5.3-linux-amd64.tar.gz
92   sudo cp linux-amd64/helm /usr/local/bin/
93
94   source <(helm completion bash)
95   echo "source <(helm completion bash)" >> ~/.bashrc
96
97   OAM_IP=<INF OAM IP>
98   NAMESPACE=orano2
99   TOKEN_DATA=<TOKEN_DATA from INF>
100
101   USER="admin-user"
102
103   kubectl config set-cluster inf-cluster --server=https://${OAM_IP}:6443 --insecure-skip-tls-verify
104   kubectl config set-credentials ${USER} --token=$TOKEN_DATA
105   kubectl config set-context ${USER}@inf-cluster --cluster=inf-cluster --user ${USER} --namespace=${NAMESPACE}
106   kubectl config use-context ${USER}@inf-cluster
107
108   kubectl get pods -A
109
110
111 2. Deploy O2 service
112 --------------------
113
114 2.1 Retrieve Helm chart for deploying of O2 service
115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
116
117 .. code:: shell
118
119   git clone -b e-release "https://gerrit.o-ran-sc.org/r/pti/o2"
120
121
122
123 2.2 Prepare override yaml
124 ~~~~~~~~~~~~~~~~~~~~~~~~~
125
126 .. code:: shell
127
128   export NAMESPACE=orano2
129   kubectl create ns ${NAMESPACE}
130
131   export OS_AUTH_URL=<INF OAM Auth URL>
132   export OS_USERNAME=<INF username>
133   export OS_PASSWORD=<INF password for user>
134
135   cat <<EOF>o2service-override.yaml
136   o2ims:
137     imagePullSecrets: admin-orano2-registry-secret
138     image:
139       repository: nexus3.o-ran-sc.org:10004/o-ran-sc/pti-o2imsdms
140       tag: 1.0.0
141       pullPolicy: IfNotPresent
142     logginglevel: "DEBUG"
143
144   ocloud:
145     OS_AUTH_URL: "${OS_AUTH_URL}"
146     OS_USERNAME: "${OS_USERNAME}"
147     OS_PASSWORD: "${OS_PASSWORD}"
148   EOF
149
150
151 2.3 Deploy by helm cli
152 ~~~~~~~~~~~~~~~~~~~~~~
153
154 .. code:: shell
155
156   helm install o2service o2/charts/ -f o2service-override.yaml
157   helm list |grep o2service
158   kubectl -n ${NAMESPACE} get pods |grep o2service
159   kubectl -n ${NAMESPACE} get services |grep o2service
160
161
162 2.4 Verify O2 service
163 ~~~~~~~~~~~~~~~~~~~~~
164
165 .. code:: shell
166
167   curl -k http(s)://<OAM IP>:30205
168   curl -k http(s)://<OAM IP>:30205/o2ims_infrastructureInventory/v1/
169
170
171 3. Register O-Cloud to SMO
172 --------------------------
173
174 - assumed you have setup SMO O2 endpoint for registration
175 - O2 service will post the O-Cloud registration data to that SMO O2 endpoint
176
177 .. code:: shell
178
179   curl -k -X 'POST' \
180     'http(s)://<OAM IP>:30205/provision/v1/smo-endpoint' \
181     -H 'accept: application/json' \
182     -H 'Content-Type: application/json' \
183     -d '{"endpoint": "<SMO O2 endpoint for registration>"}'
184
185
186 References
187 ----------
188
189 - `O-RAN-SC INF`_
190
191 .. _`O-RAN-SC INF`: https://docs.o-ran-sc.org/en/latest/projects.html#infrastructure-inf