Merge "Refactor resource dictionary entity and repositories."
[ccsdk/cds.git] / docs / 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 Installation
6 ------------
7
8 ONAP is meant to be deployed within a Kubernetes environment. Hence, the de-facto way to deploy CDS is through Kubernetes.
9
10 ONAP also package Kubernetes manifest as Chart, using Helm.
11
12 Prerequisite
13 ------------
14
15 https://docs.onap.org/en/latest/guides/onap-developer/settingup/index.html
16
17 Setup local Helm
18 ----------------
19
20 helm repo
21
22 * helm serve &
23 * helm repo add local http://127.0.0.1:8879
24
25 Get the chart
26 -------------
27
28 Make sure to checkout the release to use, by replacing $release-tag in bellow command
29
30 git clone https://gerrit.onap.org/r/oom
31 git checkout tags/$release-tag
32 cd oom/kubernetes
33 make cds
34
35 Install CDS
36 -----------
37
38 helm install --name cds cds
39
40 Result
41 ------
42
43 .. code-block:: json
44    :linenos:
45    
46    $ kubectl get all --selector=release=cds
47    NAME                                             READY     STATUS    RESTARTS   AGE
48    pod/cds-blueprints-processor-54f758d69f-p98c2    0/1       Running   1          2m
49    pod/cds-cds-6bd674dc77-4gtdf                     1/1       Running   0          2m
50    pod/cds-cds-db-0                                 1/1       Running   0          2m
51    pod/cds-controller-blueprints-545bbf98cf-zwjfc   1/1       Running   0          2m
52    NAME                            TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)             AGE
53    service/blueprints-processor    ClusterIP   10.43.139.9     <none>        8080/TCP,9111/TCP   2m
54    service/cds                     NodePort    10.43.254.69    <none>        3000:30397/TCP      2m
55    service/cds-db                  ClusterIP   None            <none>        3306/TCP            2m
56    service/controller-blueprints   ClusterIP   10.43.207.152   <none>        8080/TCP            2m
57    NAME                                        DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
58    deployment.apps/cds-blueprints-processor    1         1         1            0           2m
59    deployment.apps/cds-cds                     1         1         1            1           2m
60    deployment.apps/cds-controller-blueprints   1         1         1            1           2m
61    NAME                                                   DESIRED   CURRENT   READY     AGE
62    replicaset.apps/cds-blueprints-processor-54f758d69f    1         1         0         2m
63    replicaset.apps/cds-cds-6bd674dc77                     1         1         1         2m
64    replicaset.apps/cds-controller-blueprints-545bbf98cf   1         1         1         2m
65    NAME                          DESIRED   CURRENT   AGE
66    statefulset.apps/cds-cds-db   1         1         2m