summaryrefslogtreecommitdiffstats
path: root/docs/userguides/installation.rst
diff options
context:
space:
mode:
authorJakobKrieg <jakob.krieg@bcmsolutions.de>2020-12-01 14:17:11 +0100
committerJakobKrieg <jakob.krieg@bcmsolutions.de>2020-12-01 14:17:24 +0100
commitb7beaee4f6759c1c5997713901f6f5a1dfdb1d2d (patch)
tree1363e3e20a79c296a45fb10e916d0490bb9fefb6 /docs/userguides/installation.rst
parentd0479b3a0d9e672538b976cf38bee6b885b208b9 (diff)
CDS Read the Docs refactoring
Issue-ID: CCSDK-3011 Change-Id: Id8cff94b104bfa03643eb534e36c2bce8b0b4088 Signed-off-by: JakobKrieg <jakob.krieg@bcmsolutions.de>
Diffstat (limited to 'docs/userguides/installation.rst')
-rw-r--r--docs/userguides/installation.rst91
1 files changed, 91 insertions, 0 deletions
diff --git a/docs/userguides/installation.rst b/docs/userguides/installation.rst
new file mode 100644
index 000000000..10997294c
--- /dev/null
+++ b/docs/userguides/installation.rst
@@ -0,0 +1,91 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2019 IBM.
+
+
+Installation Guide
+==================
+
+Installation
+------------
+
+ONAP is meant to be deployed within a Kubernetes environment. Hence, the de-facto way to deploy CDS is through Kubernetes.
+
+ONAP also package Kubernetes manifest as Chart, using Helm.
+
+Prerequisite
+------------
+
+https://docs.onap.org/en/latest/guides/onap-developer/settingup/index.html
+
+Setup local Helm
+----------------
+
+helm repo
+
+* helm serve &
+* helm repo add local http://127.0.0.1:8879
+
+Get the chart
+-------------
+
+Make sure to checkout the release to use, by replacing $release-tag in bellow command
+
+git clone https://gerrit.onap.org/r/oom
+git checkout tags/$release-tag
+cd oom/kubernetes
+make cds
+
+Install CDS
+-----------
+
+helm install --name cds cds
+
+Result
+------
+
+.. code-block:: bash
+ :linenos:
+
+ $ kubectl get all --selector=release=cds
+ NAME READY STATUS RESTARTS AGE
+ pod/cds-blueprints-processor-54f758d69f-p98c2 0/1 Running 1 2m
+ pod/cds-cds-6bd674dc77-4gtdf 1/1 Running 0 2m
+ pod/cds-cds-db-0 1/1 Running 0 2m
+ pod/cds-controller-blueprints-545bbf98cf-zwjfc 1/1 Running 0 2m
+
+ NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
+ service/blueprints-processor ClusterIP 10.43.139.9 <none> 8080/TCP,9111/TCP 2m
+ service/cds NodePort 10.43.254.69 <none> 3000:30397/TCP 2m
+ service/cds-db ClusterIP None <none> 3306/TCP 2m
+ service/controller-blueprints ClusterIP 10.43.207.152 <none> 8080/TCP 2m
+
+ NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
+ deployment.apps/cds-blueprints-processor 1 1 1 0 2m
+ deployment.apps/cds-cds 1 1 1 1 2m
+ deployment.apps/cds-controller-blueprints 1 1 1 1 2m
+
+ NAME DESIRED CURRENT READY AGE
+ replicaset.apps/cds-blueprints-processor-54f758d69f 1 1 0 2m
+ replicaset.apps/cds-cds-6bd674dc77 1 1 1 2m
+ replicaset.apps/cds-controller-blueprints-545bbf98cf 1 1 1 2m
+
+ NAME DESIRED CURRENT AGE
+ statefulset.apps/cds-cds-db 1 1 2m
+
+
+
+Running CDS UI:
+---------------
+
+Client:
+~~~~~~~
+Install Node.js and angularCLI. Refer https://angular.io/guide/quickstart
+npm install in the directory cds/cds-ui/client
+npm run build - to build UI module
+
+Loopback Server:
+~~~~~~~~~~~~~~~~
+
+npm install in the directory cds/cds-ui/server
+npm start should bring you the CDS UI page in your local machine with the link https://127.0.0.1:3000/