X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation.rst;h=ef51fa034e5091750930f8b78e5d46697e2e76fa;hb=1e6f878cc92f42ca25f44319b70797bdcc8a4e1f;hp=ac72b425fcb7bd77a3ce40bccda4e82e30934d97;hpb=50af978b5b8f2e035d26bad24a3289b938b7cd0a;p=ccsdk%2Fcds.git diff --git a/docs/installation.rst b/docs/installation.rst index ac72b425f..ef51fa034 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -2,20 +2,24 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2019 IBM. + +User 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 @@ -23,7 +27,7 @@ helm repo * 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 @@ -33,31 +37,52 @@ cd oom/kubernetes make cds Install CDS -=========== +----------- helm install --name cds cds Result -====== - -$ 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 8080/TCP,9111/TCP 2m -service/cds NodePort 10.43.254.69 3000:30397/TCP 2m -service/cds-db ClusterIP None 3306/TCP 2m -service/controller-blueprints ClusterIP 10.43.207.152 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 \ No newline at end of file +------ + +.. code-block:: json + :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 8080/TCP,9111/TCP 2m + service/cds NodePort 10.43.254.69 3000:30397/TCP 2m + service/cds-db ClusterIP None 3306/TCP 2m + service/controller-blueprints ClusterIP 10.43.207.152 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/ \ No newline at end of file