Merge "Fix the fault client returns 500 instend of 404" into i-release
[pti/o2.git] / README-o2imsbuilder.md
index 6e00564..adb5e42 100644 (file)
-\r
-## Build and deploy O2 services over O-Cloud (INF)\r
-\r
-\r
-## Bring up builder container from O-Cloud controller node\r
-\r
-\r
-```sh\r
-mkdir -p /home/sysadmin/share\r
-sudo docker run -dt --privileged -v /home/sysadmin/share/:/home/sysadmin/share/ -v /var/run:/var/run --name o2imsbuilder centos:7\r
-```\r
-\r
-## Build O2 service images inside the builder container\r
-\r
-\r
-```sh\r
-sudo docker exec -it o2imsbuilder bash\r
-```\r
-\r
-\r
-```sh\r
-curl -L https://get.daocloud.io/docker/compose/releases/download/1.25.4/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose\r
-chmod +x /usr/local/bin/docker-compose\r
-docker-compose -v\r
-\r
-yum-config-manager --add-repo http://mirrors.aliyun.com/docker-ce/linux/centos/docker-ce.repo\r
-yum makecache fast\r
-yum install -y docker-ce\r
-docker ps\r
-\r
-yum install -y git\r
-\r
-cd /home/sysadmin/share/\r
-git clone "https://gerrit.o-ran-sc.org/r/pti/o2"\r
-cd o2\r
-\r
-mkdir -p temp\r
-cd temp\r
-git clone --depth 1 --branch master https://opendev.org/starlingx/config.git\r
-git clone --depth 1 --branch master https://opendev.org/starlingx/distcloud-client.git\r
-cd -\r
-\r
-docker-compose build\r
-\r
-exit\r
-\r
-```\r
-\r
-### Push O2 service images to local registry (with auth user admin)\r
-\r
-```sh\r
-sudo docker tag o2imsdms:latest registry.local:9001/admin/o2imsdms:0.1.4\r
-sudo docker image push registry.local:9001/admin/o2imsdms:0.1.4\r
-\r
-```\r
-\r
-## Deploy O2 services with helm chart over O-Cloud controller node (with auth user admin)\r
-\r
-```sh\r
-export NAMESPACE=orano2\r
-kubectl create ns ${NAMESPACE}\r
-\r
-cd /home/sysadmin/\r
-source /etc/platform/openrc\r
-cat <<EOF>ocloud-override.yaml\r
-o2ims:\r
-  imagePullSecrets: admin-orano2-registry-secret\r
-  image:\r
-    repository: registry.local:9001/admin/o2imsdms\r
-    tag: 0.1.4\r
-    pullPolicy: IfNotPresent\r
-  logginglevel: "DEBUG"\r
-\r
-ocloud:\r
-  OS_AUTH_URL: "${OS_AUTH_URL}"\r
-  OS_USERNAME: "${OS_USERNAME}"\r
-  OS_PASSWORD: "${OS_PASSWORD}"\r
-EOF\r
-\r
-sudo docker login registry.local:9001 -u ${OS_PROJECT_NAME} -p ${OS_PASSWORD}\r
-\r
-kubectl -n ${NAMESPACE} create secret docker-registry ${OS_PROJECT_NAME}-${NAMESPACE}-registry-secret \\r
---docker-server=registry.local:9001 --docker-username=${OS_PROJECT_NAME} \\r
---docker-password=${OS_PASSWORD} --docker-email=noreply@windriver.com\r
-\r
-cd /home/sysadmin/share/o2\r
-\r
-helm install o2imstest charts/ -f /home/sysadmin/ocloud-override.yaml\r
-\r
-kubectl -n ${NAMESPACE} get pods\r
-\r
-```\r
-\r
-### test api endpoint\r
-\r
-```sh\r
-curl -k http(s)://<Node IP>:30205\r
-curl -k http(s)://<Node IP>:30205/o2ims_infrastructureInventory/v1\r
-```\r
-\r
-\r
-### Debug tips\r
-\r
-```sh\r
-kubectl -n ${NAMESPACE} logs -f o2api-<xxx> -c o2api\r
-kubectl -n ${NAMESPACE} logs -f o2api-<xxx> -c postgres\r
-kubectl -n ${NAMESPACE} logs -f o2api-<xxx> -c o2pubsub\r
-kubectl -n ${NAMESPACE} logs -f o2api-<xxx> -c watcher\r
-\r
-\r
-kubectl -n ${NAMESPACE} logs -f o2api-<xxx> -c o2api\r
-\r
-kubectl -n ${NAMESPACE} exec -it o2api-<xxx> -c postgres -- bash\r
-    psql -U o2ims\r
-\r
-        \c o2ims\r
-\r
-        \d\r
-\r
-        select * from ocloud;\r
-\r
-        \q\r
-\r
-    exit\r
-\r
-```\r
-\r
-## Issues:\r
-\r
-1, there is chance the containers crash due to random bootstrap order of containers\r
+
+## Build and deploy O2 services over O-Cloud (INF)
+
+
+## Bring up builder container from O-Cloud controller node
+
+
+```sh
+mkdir -p /home/sysadmin/share
+sudo docker run -dt --privileged -v /home/sysadmin/share/:/home/sysadmin/share/ -v /var/run:/var/run --name o2imsbuilder centos:7
+```
+
+## Build O2 service images inside the builder container
+
+
+```sh
+sudo docker exec -it o2imsbuilder bash
+```
+
+
+```sh
+curl -L https://get.daocloud.io/docker/compose/releases/download/1.25.4/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
+chmod +x /usr/local/bin/docker-compose
+docker-compose -v
+
+yum-config-manager --add-repo http://mirrors.aliyun.com/docker-ce/linux/centos/docker-ce.repo
+yum makecache fast
+yum install -y docker-ce
+docker ps
+
+yum install -y git
+
+cd /home/sysadmin/share/
+git clone "https://gerrit.o-ran-sc.org/r/pti/o2"
+cd o2
+
+mkdir -p temp
+cd temp
+git clone --depth 1 --branch r/stx.7.0 https://opendev.org/starlingx/config.git
+git clone --branch master https://opendev.org/starlingx/distcloud-client.git
+(cd distcloud-client && git reset --hard eb4e7eeeb09bdf2e1b80984b378c5a8ea9930f04)
+cd -
+
+docker-compose build
+
+exit
+
+```
+
+### Push O2 service images to local registry (with auth user admin)
+
+```sh
+sudo docker tag o2imsdms:latest registry.local:9001/o-ran-sc/pti-o2imsdms:2.0.0
+sudo docker image push registry.local:9001/o-ran-sc/pti-o2imsdms:2.0.0
+
+```
+
+## Deploy O2 services with helm chart over O-Cloud controller node (with auth user admin)
+
+```sh
+export NAMESPACE=oran-o2
+kubectl create ns ${NAMESPACE}
+
+cd /home/sysadmin/
+source /etc/platform/openrc
+cat <<EOF>ocloud-override.yaml
+imagePullSecrets:
+  - default-registry-key
+
+o2ims:
+  serviceaccountname: admin-oran-o2
+  images:
+    tags:
+      o2service: registry.local:9001/o-ran-sc/pti-o2imsdms:2.0.0
+      postgres: docker.io/library/postgres:9.6
+      redis: docker.io/library/redis:alpine
+    pullPolicy: IfNotPresent
+  logginglevel: "DEBUG"
+
+ocloud:
+  OS_AUTH_URL: "${OS_AUTH_URL}"
+  OS_USERNAME: "${OS_USERNAME}"
+  OS_PASSWORD: "${OS_PASSWORD}"
+EOF
+
+sudo docker login registry.local:9001 -u ${OS_PROJECT_NAME} -p ${OS_PASSWORD}
+
+kubectl -n ${NAMESPACE} create secret docker-registry ${OS_PROJECT_NAME}-${NAMESPACE}-registry-secret \
+--docker-server=registry.local:9001 --docker-username=${OS_PROJECT_NAME} \
+--docker-password=${OS_PASSWORD} --docker-email=noreply@windriver.com
+
+cd /home/sysadmin/share/o2
+
+helm install o2imstest charts/ -f /home/sysadmin/ocloud-override.yaml
+
+kubectl -n ${NAMESPACE} get pods
+
+```
+
+### test api endpoint
+
+```sh
+curl -k http(s)://<Node IP>:30205
+curl -k http(s)://<Node IP>:30205/o2ims_infrastructureInventory/v1
+```
+
+
+### Debug tips
+
+```sh
+kubectl -n ${NAMESPACE} logs -f o2api-<xxx> -c o2api
+kubectl -n ${NAMESPACE} logs -f o2api-<xxx> -c postgres
+kubectl -n ${NAMESPACE} logs -f o2api-<xxx> -c o2pubsub
+kubectl -n ${NAMESPACE} logs -f o2api-<xxx> -c watcher
+
+
+kubectl -n ${NAMESPACE} logs -f o2api-<xxx> -c o2api
+
+kubectl -n ${NAMESPACE} exec -it o2api-<xxx> -c postgres -- bash
+    psql -U o2ims
+
+        \c o2ims
+
+        \d
+
+        select * from ocloud;
+
+        \q
+
+    exit
+
+```
+
+## Issues:
+
+1, there is chance the containers crash due to random bootstrap order of containers