From 7e6e7604d65abae421df970d1b477bab361fc2c5 Mon Sep 17 00:00:00 2001 From: Kate Hsuan Date: Thu, 26 Mar 2020 14:15:13 +0800 Subject: Add datalake deployment guide. Issue-ID: DCAEGEN2-2028 Signed-off-by: Kate Hsuan Change-Id: I882ad3e9b33f03fe7df98b8cc89c507fbd8062e6 --- .../datalake-handler/images/blueprint-list.png | Bin 0 -> 63896 bytes .../datalake-handler/images/bootstrap-pod.png | Bin 0 -> 11816 bytes .../datalake-handler/images/feeder-log.png | Bin 0 -> 140222 bytes .../services/datalake-handler/installation.rst | 102 ++++++++++++++++++++- 4 files changed, 99 insertions(+), 3 deletions(-) create mode 100644 docs/sections/services/datalake-handler/images/blueprint-list.png create mode 100644 docs/sections/services/datalake-handler/images/bootstrap-pod.png create mode 100644 docs/sections/services/datalake-handler/images/feeder-log.png 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 Binary files /dev/null and b/docs/sections/services/datalake-handler/images/blueprint-list.png 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 Binary files /dev/null and b/docs/sections/services/datalake-handler/images/bootstrap-pod.png 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 Binary files /dev/null and b/docs/sections/services/datalake-handler/images/feeder-log.png 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 /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 -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 -- cgit 1.2.3-korg