Refactoring and fixing Docs
[ccsdk/cds.git] / docs / userguide / installation.rst
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
5
6 Installation Guide
7 ==================
8
9 Installation
10 ------------
11
12 ONAP is meant to be deployed within a Kubernetes environment. Hence, the de-facto way to deploy CDS is through Kubernetes.
13
14 ONAP also package Kubernetes manifest as Chart, using Helm.
15
16 Prerequisite
17 ------------
18
19 https://docs.onap.org/en/latest/guides/onap-developer/settingup/index.html
20
21 Setup local Helm
22 ----------------
23
24 helm repo
25
26 * helm serve &
27 * helm repo add local http://127.0.0.1:8879
28
29 Get the chart
30 -------------
31
32 Make sure to checkout the release to use, by replacing $release-tag in bellow command
33
34 git clone https://gerrit.onap.org/r/oom
35 git checkout tags/$release-tag
36 cd oom/kubernetes
37 make cds
38
39 Install CDS
40 -----------
41
42 helm install --name cds cds
43
44 Result
45 ------
46
47 .. code-block:: bash
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
57    NAME                            TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)             AGE
58    service/blueprints-processor    ClusterIP   10.43.139.9     <none>        8080/TCP,9111/TCP   2m
59    service/cds                     NodePort    10.43.254.69    <none>        3000:30397/TCP      2m
60    service/cds-db                  ClusterIP   None            <none>        3306/TCP            2m
61    service/controller-blueprints   ClusterIP   10.43.207.152   <none>        8080/TCP            2m
62
63    NAME                                        DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
64    deployment.apps/cds-blueprints-processor    1         1         1            0           2m
65    deployment.apps/cds-cds                     1         1         1            1           2m
66    deployment.apps/cds-controller-blueprints   1         1         1            1           2m
67
68    NAME                                                   DESIRED   CURRENT   READY     AGE
69    replicaset.apps/cds-blueprints-processor-54f758d69f    1         1         0         2m
70    replicaset.apps/cds-cds-6bd674dc77                     1         1         1         2m
71    replicaset.apps/cds-controller-blueprints-545bbf98cf   1         1         1         2m
72
73    NAME                          DESIRED   CURRENT   AGE
74    statefulset.apps/cds-cds-db   1         1         2m
75
76
77
78 Running CDS UI:
79 ---------------
80
81 Client:
82 ~~~~~~~
83 Install Node.js and angularCLI. Refer https://angular.io/guide/quickstart
84 npm install in the directory cds/cds-ui/client
85 npm run build - to build UI module
86
87 Loopback Server:
88 ~~~~~~~~~~~~~~~~
89
90 npm install in the directory cds/cds-ui/server
91 npm start should bring you the CDS UI page in your local machine with the link https://127.0.0.1:3000/