summaryrefslogtreecommitdiffstats
path: root/docs/sections
diff options
context:
space:
mode:
authorVijay Venkatesh Kumar <vv770d@att.com>2020-03-30 15:39:03 +0000
committerGerrit Code Review <gerrit@onap.org>2020-03-30 15:39:03 +0000
commiteec78e919705108f867ff9e68fe8017d88247b38 (patch)
tree9e6feffaea6ef9b8d60afd8a54301d41a364ec94 /docs/sections
parent6d1b9c074e7a843dbb9453ee90de15eba93a81be (diff)
parent7e6e7604d65abae421df970d1b477bab361fc2c5 (diff)
Merge "Add datalake deployment guide."
Diffstat (limited to 'docs/sections')
-rw-r--r--docs/sections/services/datalake-handler/images/blueprint-list.pngbin0 -> 63896 bytes
-rw-r--r--docs/sections/services/datalake-handler/images/bootstrap-pod.pngbin0 -> 11816 bytes
-rw-r--r--docs/sections/services/datalake-handler/images/feeder-log.pngbin0 -> 140222 bytes
-rw-r--r--docs/sections/services/datalake-handler/installation.rst102
4 files changed, 99 insertions, 3 deletions
diff --git a/docs/sections/services/datalake-handler/images/blueprint-list.png b/docs/sections/services/datalake-handler/images/blueprint-list.png
new file mode 100644
index 00000000..e934205b
--- /dev/null
+++ b/docs/sections/services/datalake-handler/images/blueprint-list.png
Binary files differ
diff --git a/docs/sections/services/datalake-handler/images/bootstrap-pod.png b/docs/sections/services/datalake-handler/images/bootstrap-pod.png
new file mode 100644
index 00000000..d0e275ec
--- /dev/null
+++ b/docs/sections/services/datalake-handler/images/bootstrap-pod.png
Binary files differ
diff --git a/docs/sections/services/datalake-handler/images/feeder-log.png b/docs/sections/services/datalake-handler/images/feeder-log.png
new file mode 100644
index 00000000..15b23777
--- /dev/null
+++ b/docs/sections/services/datalake-handler/images/feeder-log.png
Binary files differ
diff --git a/docs/sections/services/datalake-handler/installation.rst b/docs/sections/services/datalake-handler/installation.rst
index 2235198a..5d8b3341 100644
--- a/docs/sections/services/datalake-handler/installation.rst
+++ b/docs/sections/services/datalake-handler/installation.rst
@@ -1,4 +1,100 @@
-Installation
-============
+Deployment Steps
+################
+DL-handler consists of two pods- the feeder and admin UI. It can be deployed by using cloudify blueprint. Datalake can be easily deployed through DCAE cloudify manager. The following steps guides you launch Datalake though cloudify manager.
-DataLake handler microservice can be deployed using ... (TODO) \ No newline at end of file
+Pre-requisite
+----------------
+- Make sure mariadb-galera from OOM is properly deployed and functional.
+- An external database, such as Elasticsearch and MongoDB is deployed.
+
+After datalake getting deployed, the admin UI can be used to configure the sink database address and credentials.
+
+Log-in to the DCAE Bootstrap POD
+---------------------------------------------------
+
+First, we should find the bootstrap pod name through the following command and make sure that DCAE coudify manager is properly deployed.
+ .. image :: .images/bootstrap-pod.png
+
+Login to the DCAE bootstrap pod through the following command.
+ .. code-block :: bash
+
+ #kubectl exec -it <DCAE bootstrap pod> /bin/bash -n onap
+
+Validate Blueprint
+-------------------
+Before the blueprints uploading to Cloudify manager, the blueprints shoule be validated first throuhg the following command.
+ .. code-block :: bash
+
+ #cfy blueprint validate /bluerints/k8s-datalake-feeder.yaml
+ #cfy blueprint validate /blueprints/k8s-datalake-admin-ui.yaml
+
+Upload the Blueprint to Cloudify Manager.
+-----------------------------------------
+After validating, we can start to proceed blueprints uploading.
+ .. code-block :: bash
+
+ #cfy blueprint upload -b datalake-feeder /bluerints/k8s-datalake-feeder.yaml
+ #cfy blueprint upload -b datalake-admin-ui /blueprints/k8s-datalake-admin-ui.yaml
+
+Verify Uploaded Blueprints
+--------------------------
+Using "cft blueprint list" to varify your work.
+ .. code-block :: bash
+
+ #cfy blueprint list
+
+You can see the following returned message to show the blueprints have been correctly uploaded.
+ .. image :: ./imagesblueprint-list.png
+
+
+Verify Plugin Versions
+------------------------------------------------------------------------------
+If the version of the plugin used is different, update the blueprint import to match.
+ .. code-block :: bash
+
+ #cfy plugins list
+
+Create Deployment
+-----------------
+Here we are going to create deployments for both feeder and admin UI.
+ .. code-block :: bash
+
+ #cfy deployments create -b datalake-feeder feeder-deploy
+ #cfy deployments create -b datalake-admin-ui admin-ui-deploy
+
+Launch Service
+---------------
+Next, we are going to launch the datalake.
+ .. code-block :: bash
+
+ #cfy executions start -d feeder-deploy install
+ #cfy executions start -d admin-ui-deploy install
+
+
+Verify the Deployment Result
+-----------------------------
+The following command can be used to list the datalake logs.
+ .. code-block :: bash
+ #kubectl logs <datalake-pod> -n onap
+
+The output should looks like.
+ .. image :: ./feeder-log.png
+
+If you find any Java exception from log, make sure that the external database and datalake configuration are properly configured.
+Admin UI can be used to configure the external database configuration.
+
+
+Uninstall
+----------
+Uninstall running component and delete deployment
+ .. code-block :: bash
+
+ #cfy uninstall feeder-deploy
+ #cfy uninstall admin-ui-deploy
+
+Delete Blueprint
+------------------
+ .. code-block :: bash
+
+ #cfy blueprints delete datalake-feeder
+ #cfy blueprints deltet datalake-admin-ui