Gitiles
Code Review Sign In
gerrit.nordix.org / onap / ccsdk / cds / 1337eccc2be949d860f3c5b1f0148c061c3c669b / . / docs / installation.rst
blob: ef51fa034e5091750930f8b78e5d46697e2e76fa [file] [log] [blame]
Ezhilarasie4388f52019-04-23 20:34:32 +0530[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3.. Copyright (C) 2019 IBM.
4
Ezhilarasidfaa1fd2019-09-16 15:23:27 +0530[diff] [blame]5
6User Guide
7==========
8
Ezhilarasie4388f52019-04-23 20:34:32 +0530[diff] [blame]9Installation
Ezhilarasiaff5fcd2019-08-30 16:56:49 +0530[diff] [blame]10------------
Ezhilarasie4388f52019-04-23 20:34:32 +0530[diff] [blame]11
12ONAP is meant to be deployed within a Kubernetes environment. Hence, the de-facto way to deploy CDS is through Kubernetes.
13
14ONAP also package Kubernetes manifest as Chart, using Helm.
15
16Prerequisite
Ezhilarasiaff5fcd2019-08-30 16:56:49 +0530[diff] [blame]17------------
Ezhilarasie4388f52019-04-23 20:34:32 +0530[diff] [blame]18
19https://docs.onap.org/en/latest/guides/onap-developer/settingup/index.html
20
21Setup local Helm
Ezhilarasiaff5fcd2019-08-30 16:56:49 +0530[diff] [blame]22----------------
Ezhilarasie4388f52019-04-23 20:34:32 +0530[diff] [blame]23
24helm repo
25
26* helm serve &
27* helm repo add local http://127.0.0.1:8879
28
29Get the chart
Ezhilarasiaff5fcd2019-08-30 16:56:49 +0530[diff] [blame]30-------------
Ezhilarasie4388f52019-04-23 20:34:32 +0530[diff] [blame]31
32Make sure to checkout the release to use, by replacing $release-tag in bellow command
33
34git clone https://gerrit.onap.org/r/oom
35git checkout tags/$release-tag
36cd oom/kubernetes
37make cds
38
39Install CDS
Ezhilarasiaff5fcd2019-08-30 16:56:49 +0530[diff] [blame]40-----------
Ezhilarasie4388f52019-04-23 20:34:32 +0530[diff] [blame]41
42helm install --name cds cds
43
44Result
Ezhilarasiaff5fcd2019-08-30 16:56:49 +0530[diff] [blame]45------
Ezhilarasie4388f52019-04-23 20:34:32 +0530[diff] [blame]46
Ezhilarasiaff5fcd2019-08-30 16:56:49 +0530[diff] [blame]47.. code-block:: json
48 :linenos:
49
50 $ kubectl get all --selector=release=cds
51 NAME READY STATUS RESTARTS AGE
52 pod/cds-blueprints-processor-54f758d69f-p98c2 0/1 Running 1 2m
53 pod/cds-cds-6bd674dc77-4gtdf 1/1 Running 0 2m
54 pod/cds-cds-db-0 1/1 Running 0 2m
55 pod/cds-controller-blueprints-545bbf98cf-zwjfc 1/1 Running 0 2m
56 NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
57 service/blueprints-processor ClusterIP 10.43.139.9 <none> 8080/TCP,9111/TCP 2m
58 service/cds NodePort 10.43.254.69 <none> 3000:30397/TCP 2m
59 service/cds-db ClusterIP None <none> 3306/TCP 2m
60 service/controller-blueprints ClusterIP 10.43.207.152 <none> 8080/TCP 2m
61 NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
62 deployment.apps/cds-blueprints-processor 1 1 1 0 2m
63 deployment.apps/cds-cds 1 1 1 1 2m
64 deployment.apps/cds-controller-blueprints 1 1 1 1 2m
65 NAME DESIRED CURRENT READY AGE
66 replicaset.apps/cds-blueprints-processor-54f758d69f 1 1 0 2m
67 replicaset.apps/cds-cds-6bd674dc77 1 1 1 2m
68 replicaset.apps/cds-controller-blueprints-545bbf98cf 1 1 1 2m
69 NAME DESIRED CURRENT AGE
Ezhilarasidfaa1fd2019-09-16 15:23:27 +0530[diff] [blame]70 statefulset.apps/cds-cds-db 1 1 2m
71
72
73
74Running CDS UI:
75---------------
76
77Client:
78~~~~~~~
79Install Node.js and angularCLI. Refer https://angular.io/guide/quickstart
80npm install in the directory cds/cds-ui/client
81npm run build - to build UI module
82
83
84Loopback Server:
85~~~~~~~~~~~~~~~~
86
87npm install in the directory cds/cds-ui/server
88npm start should bring you the CDS UI page in your local machine with the link https://127.0.0.1:3000/