Change NodePort to ClusterIP in coll, promOper pkg
[demo.git] / vnfs / DAaaS / README.md
index a9c9932..91b5817 100644 (file)
@@ -13,6 +13,29 @@ git clone https://github.com/onap/demo.git
 DA_WORKING_DIR=$PWD/demo/vnfs/DAaaS/deploy
 ```
 
+## Install Istio Service Mesh
+
+## Istio is installed in two Steps
+```bash
+1. Istio-Operator
+2. Istio-config
+```
+
+## Download the Istio Installation repo
+
+```bash
+cd DA_WORKING_DIR/00-init
+helm install --name=istio-operator --namespace=istio-system istio-operator
+helm install istio-instance --name istio --namespace istio-system
+```
+
+## Install Metallb to act as a Loadbalancer
+```bash
+cd  DA_WORKING_DIR/00-init
+NOTE: Update the IP Address Ranges before you Install Metallb
+helm install --name metallb -f values.yaml metallb
+```
+
 ## Install Rook-Ceph for Persistent Storage
 Note: This is unusual but Flex volume path can be different than the default value. values.yaml has the most common flexvolume path configured. In case of errors related to flexvolume please refer to the https://rook.io/docs/rook/v0.9/flexvolume.html#configuring-the-flexvolume-path to find the appropriate flexvolume-path and set it in values.yaml
 ```bash
@@ -84,12 +107,21 @@ helm install -n rook . -f values.yaml --namespace=rook-ceph-system
 ### Build docker images
 #### collectd-operator
 ```bash
-cd $DA_WORKING_DIR/../microservices/collectd-operator
+cd $DA_WORKING_DIR/../microservices
 
 ## Note: The image tag and respository in the Collectd-operator helm charts needs to match the IMAGE_NAME
 IMAGE_NAME=dcr.cluster.local:32644/collectd-operator:latest
-./build/build_image.sh $IMAGE_NAME
+./build_image.sh collectd-operator $IMAGE_NAME
+```
+#### visualization-operator
+```bash
+cd $DA_WORKING_DIR/../microservices
+
+## Note: The image tag and respository in the Visualization-operator helm charts needs to match the IMAGE_NAME
+IMAGE_NAME=dcr.cluster.local:32644/visualization-operator:latest
+./build_image.sh visualization-operator $IMAGE_NAME
 ```
+
 ### Install the Operator Package
 ```bash
 cd $DA_WORKING_DIR/operator
@@ -184,6 +216,57 @@ kubectl create -f edge1 [PLUGIN_NAME3]_collectdplugin_cr.yaml
 ...
 ```
 
+#Install visualization package
+```bash
+Default (For custom Grafana dashboards skip this section)
+=======
+cd $DA_WORKING_DIR/visualization
+helm install -n viz . -f values.yaml -f grafana-values.yaml
+
+Custom Grafana dashboards
+=========================
+1. Place the custom dashboard definition into the folder $DA_WORKING_DIR/visualization/charts/grafana/dashboards
+    Example dashboard definition can be found at $DA_WORKING_DIR/visualization/charts/grafana/dashboards/dashboard1.json
+2. Create a configmap.yaml that imports above created dashboard.json file as config and copy that configmap.yaml to $DA_WORKING_DIR/visualization/charts/grafana/templates/
+    Example configmap can be found at $DA_WORKING_DIR/visualization/charts/grafana/templates/configmap-add-dashboard.yaml
+3. Add custom dashboard configuration to values.yaml or an overriding values.yaml. 
+    Example configuration can be found in the "dashboardProviders" section of grafana-values.yaml
+
+4. cd $DA_WORKING_DIR/visualization
+5. For a fresh install of visualization package, do "helm install"
+    e.g., helm install -n viz . -f values.yaml -f grafana-values.yaml
+   If the custom dashboard is being added to an already running Grafana, do "helm upgrade"
+    e.g., helm upgrade -n viz . -f values.yaml -f grafana-values.yaml -f ......
+```
+
+#### Verify Visualization package
+Check if the visualization pod is up
+```
+$ kubectl get pods
+    NAME                          READY   STATUS    RESTARTS   AGE
+    viz-grafana-78dcffd75-sxnjv   1/1     Running   0          52m
+```
+
+### Login to Grafana
+```
+1. Get your 'admin' user password by running:
+    kubectl get secret --namespace default viz-grafana -o jsonpath="{.data.admin-password}" | base64 --decode ; echo
+
+2. Get the Grafana URL to visit by running these commands in the same shell:
+    export POD_NAME=$(kubectl get pods --namespace default -l "app=grafana,release=viz" -o jsonpath="{.items[0].metadata.name}")
+    kubectl --namespace default port-forward $POD_NAME 3000
+
+3. Visit the URL : http://localhost:3000 and login with the password from step 1 and the username: admin
+```
+
+#### Configure Grafana Datasources
+Using the sample [prometheus_grafanadatasource_cr.yaml](microservices/visualization-operator/examples/grafana/prometheus_grafanadatasource_cr.yaml), Configure the GrafanaDataSource CR by running the command below
+```yaml
+kubectl create -f [DATASOURCE_NAME1]_grafanadatasource_cr.yaml
+kubectl create -f [DATASOURCE_NAME2]_grafanadatasource_cr.yaml
+...
+```
+
 ## Install Minio Model repository
 * Prerequisite: Dynamic storage provisioner needs to be enabled. Either rook-ceph ($DA_WORKING_DIR/00-init) or another alternate provisioner needs to be enabled.
 ```bash