Merge pull request #26 from citrix/keytext

Updated the cert and key related text after hiding the cerificate and…

Author: sreejithgs

docs/coe-troubleshooting.md

@@ -2,47 +2,47 @@
 
 This document explains how to troubleshoot issues that you may encounter while using Citrix ADC Observability Exporter.
 
-    -  How do I verify that Citrix ADC sends application data logs to Citrix ADC Observability Exporter?
+-  How do I verify that Citrix ADC sends application data logs to Citrix ADC Observability Exporter?
 
-        Run the following command to verify that Citrix ADC sends application data logs to Citrix ADC Observability Exporter:
+    Run the following command to verify that Citrix ADC sends application data logs to Citrix ADC Observability Exporter:
 
-          nsconmsg -g lstream_tot_trans_written -d current
+        nsconmsg -g lstream_tot_trans_written -d current
 
-      The counter value indicates that the number of application transactions (for example, HTTP transactions) which have been sent to Citrix ADC Observability Exporter.
+    The counter value indicates that the number of application transactions (for example, HTTP transactions) which have been sent to Citrix ADC Observability Exporter.
 
-      If the application traffic rate (for example, HTTP req/sec) that is sent to Citrix ADC Observability Exporter is not equal to `lstream_tot_trans_written`, you can verify the same using the following command:
+    If the application traffic rate (for example, HTTP req/sec) that is sent to Citrix ADC Observability Exporter is not equal to `lstream_tot_trans_written`, you can verify the same using the following command:
 
-          nsconmsg -g nslstream_err_ulf_data_not_sendable -d current
+        nsconmsg -g nslstream_err_ulf_data_not_sendable -d current
 
-      The counter value indicates that Citrix ADC cannot send the data to Citrix ADC Observability Exporter due to network congestion, unavailability of network bandwidth, and so on and the data is stored in the available buffers.
+    The counter value indicates that Citrix ADC cannot send the data to Citrix ADC Observability Exporter due to network congestion, unavailability of network bandwidth, and so on and the data is stored in the available buffers.
 
-      Information about various transaction data and individual fields, and their datatype are available in the following location on the Citrix ADC:
+    Information about various transaction data and individual fields, and their datatype are available in the following location on the Citrix ADC:
 
-          shell
-          /netscaler/appflow/ns_ipfix.yaml
+        shell
+        /netscaler/appflow/ns_ipfix.yaml
 
-      To verify the current record type exported from Citrix ADC to Citrix ADC Observability Exporter, use the following command:
+    To verify the current record type exported from Citrix ADC to Citrix ADC Observability Exporter, use the following command:
 
-          nsconmsg -g appflow_tmpl -d current
+        nsconmsg -g appflow_tmpl -d current
 
-      Location of metrics data export logs to Citrix ADC for time series data:
+    Location of metrics data export logs to Citrix ADC for time series data:
 
-          /var/nslog/metrics_prom.log
+        /var/nslog/metrics_prom.log
 
-      To verify kafka related counters, run the following command:
+    To verify kafka related counters, run the following command:
 
-         kubectl exec -it <cpx-pod-name> [-c <cpx-container-name>] [-n <namespace-name>] -- bash
+        kubectl exec -it <cpx-pod-name> [-c <cpx-container-name>] [-n <namespace-name>] -- bash
 
-          tail -f /var/ulflog/counters/lstrmd_counters_codes.log | grep -iE "(http_reqs_done|kafka)"
+        tail -f /var/ulflog/counters/lstrmd_counters_codes.log | grep -iE "(http_reqs_done|kafka)"
 
-      Find the logs in the following location to verify that the Citrix ADC Observability Exporter configuration is applied correctly:
+    Find the logs in the following location to verify that the Citrix ADC Observability Exporter configuration is applied correctly:
 
-          vi /var/logproxy/lstreamd/conf/lstreamd.conf
+        vi /var/logproxy/lstreamd/conf/lstreamd.conf
 
-      If Citrix ADC Observability Exporter fails, you can collect logs available at the following location and contact Citrix Support.
+    If Citrix ADC Observability Exporter fails, you can collect logs available at the following location and contact Citrix Support.
 
-          /cores/ (Loation of coredump files, if any.)
-          /var/ulflog/ (Location of `libulfd` logs and counter details.)
-          /var/log  (Location of console logs, lstreamd logs and so on.)
+        /cores/ (Loation of coredump files, if any.)
+        /var/ulflog/ (Location of `libulfd` logs and counter details.)
+        /var/log  (Location of console logs, lstreamd logs and so on.)
 
 For information on Citrix ADC CPX related troubleshooting, see [Citrix ADC CPX Troubleshooting](https://docs.citrix.com/en-us/citrix-adc-cpx/current-release/cpx-troubleshooting.html).

docs/deploy-coe-with-Kafka.md

@@ -2,13 +2,13 @@
 
 Citrix ADC Observability Exporter is a container that collects metrics and transactions from Citrix ADC. It also transforms the data into the formats (such as AVRO) that are supported in Kafka and exports the data to the endpoint. Kafka is an open-source and distributed event streaming platform for high-performance data pipelines and streaming analytics.
 
-## Deploy Citrix Observability Exporter
+## Deploy Citrix ADC Observability Exporter
 
 You can deploy Citrix ADC Observability Exporter using the YAML file. Based on the Citrix ADC deployment, you can use Citrix ADC Observability Exporter to export metrics and transaction data from Citrix ADC. You can deploy Citrix ADC CPX either as a pod inside the Kubernetes cluster or on Citrix ADC MPX or VPX form factor outside the cluster.
 
 The following diagram illustrates a Citrix ADC as an Ingress Gateway with Citrix ADC Observability Exporter as a sidecar. It sends Citrix ADC application transaction data to Kafka.
 
-![Citrix Observability Exporter Deployment](media/coe-kafka-architecture.png)
+![Citrix ADC Observability Exporter Deployment](media/coe-kafka-architecture.png)
 
 ### Prerequisites
 
@@ -24,7 +24,7 @@ Perform the following steps to deploy Citrix ADC Observability Exporter:
 
   **Note**: If you have a pre-deployed web application, skip the step 1 and 2.
 
-  1.  Create a secret using the certificate and key. Access the certificate from [ingress.crt](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/ingress.crt) and the key from [ingress.key](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/ingress.key). You can also use your own certificate and key.
+  1.  Create a secret [ingress.crt](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/ingress.crt) and key [ingress.key](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/ingress.key) using your own certificate and key.
 
       In this example, a secret, called *ing* in the default namespace, is created.
 
@@ -56,7 +56,7 @@ Perform the following steps to deploy a Citrix ADC CPX instance with the Citrix
 
   **Note**: If you have used a different namespace, other than *default*, then you must change from `coe-kafka.default.svc.cluster.local` to `coe-kafka.<desired-namespace>.svc.cluster.local`.
 
-  ## Deploy Citrix ADC Observability Exporter using YAML
+## Deploy Citrix ADC Observability Exporter using YAML
 
 You can deploy Citrix ADC Observability Exporter using the YAML file. Download the [coe-kafka.yaml](https://raw.githubusercontent.com/citrix/citrix-observability-exporter/master/examples/kafka/coe-kafka.yaml) file that you can use for the Citrix ADC Observability Exporter deployment.
 
@@ -196,7 +196,7 @@ To edit the YAML file for the required changes, perform the following steps:
               protocol: TCP
           selector:
               app: coe-kafka
-          ```
+        ```
 
 ## Verify the Citrix ADC Observability Exporter deployment
 
@@ -212,7 +212,7 @@ To verify the Citrix ADC Observability Exporter deployment, perform the followin
 
         For example, from step 1, access http://10.102.61.56:31202/ in which, `10.102.61.56` is one of the Kubernetes node IPs.
 
-      ![](media/coe-kafka-http-methods.png)
+      ![HTTP methods](media/coe-kafka-http-methods.png)
 
   3.  Use Kafka Consumer to view the transaction data. Access kafka Consumer from [PythonKafkaConsumer](https://kafka-python.readthedocs.io/en/master/apidoc/KafkaConsumer.html).
 

docs/deploy-coe-with-es.md

@@ -20,7 +20,7 @@ Perform the following steps to deploy Citrix Observability Exporter:
 
 **Note**: If you have a pre-deployed web application, skip the steps 1 and 2.
 
-  1.  Create a secret using the certificate and key. Access the certificate from [ingress.crt](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/ingress.crt) and the key from [ingress.key](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/ingress.key). You can also use your own certificate and key. 
+  1.  Create a secret [ingress.crt](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/ingress.crt) and key [ingress.key](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/ingress.key) using your own certificate and key.
 
       In this example, a secret, called *ing* in the default namespace, is created.
 
@@ -89,35 +89,35 @@ To verify the Citrix ADC Observability Exporter deployment, perform the followin
 
       For example, from Step 1, access http://10.102.40.41:30176/ in which, `10.102.40.41` is one of the Kubernetes node IPs.
 
-      ![](media/coe-es-send-requests.png)
+      ![Requests](media/coe-es-send-requests.png)
 
   3.  Access Kibana with a browser using the URL: `https://<kubernetes-node-IP>:<kibana nodeport>/`.
 
       For example, from step 1, access http://10.102.40.41:32529/ in which, `10.102.40.41` is one of the Kubernetes node IPs.
 
       a. Click **Explore on my own**.
 
-         ![](media/coe-es-click-explore.png)
+       ![Explore](media/coe-es-click-explore.png)
 
       b. Click **Connect to your Elasticsearch index**.
 
-         ![](media/coe-es-connect-to-index.png)
+        ![Connect to Elastic index](media/coe-es-connect-to-index.png)
 
       c. Click **Saved Objects**.
 
       d. Download and import the Kibana Dashboard from [KibanaAppTrans.ndjson](https://raw.githubusercontent.com/citrix/citrix-observability-exporter/master/dashboards/KibanaAppTrans.ndjson).
 
-        ![](media/coe-es-saved-objects.png)
+       ![Saved objects](media/coe-es-saved-objects.png)
 
       e. Click **App Transaction dashboard**.
 
-         ![](media/coe-es-transact-dashboard.png)
+       ![Dashboard](media/coe-es-transact-dashboard.png)
 
-         The dashboard appears.
+        The dashboard appears.
 
-         ![](media/coe-es-indices-dashboard.png)
+       ![Dashboard](media/coe-es-indices-dashboard.png)
 
-         ![Elasticsearch indexes based on configuration](media/coe-es-indices-basedon-config.png)
+       ![Elasticsearch indexes based on configuration](media/coe-es-indices-basedon-config.png)
 
 ## Integrate Citrix ADC with multiple Citrix ADC Observability Exporter instances manually
 
@@ -170,7 +170,7 @@ To verify if Citrix ADC sends application data logs to Citrix ADC Observability
 
   The counter value indicates that the number of application transactions (for example, HTTP transactions) which have been sent to Citrix ADC Observability Exporter.
 
-  ![](media/coe-es-counter-value.png)
+  ![Counter value](media/coe-es-counter-value.png)
 
   If the application traffic rate (for example, HTTP req/sec) that is sent to Citrix ADC Observability Exporter is not equal to `lstream_tot_trans_written`, you can verify the same using the following command:
 
@@ -183,13 +183,13 @@ To verify if Citrix ADC sends application data logs to Citrix ADC Observability
       shell
       /netscaler/appflow/ns_ipfix.yaml
 
-  ![](media/coe-es-shell-ipfix.png)
+  ![Data location](media/coe-es-shell-ipfix.png)
 
   To verify that if application transaction records are exported from Citrix ADC to Citrix ADC Observability Exporter, use the following command:
 
     nsconmsg -g appflow_tmpl -d current
 
-  ![](media/coe-es-appflow-current.png)
+  ![Performance data](media/coe-es-appflow-current.png)
 
   Location of metrics data export logs to Citrix ADC for time series data:
 

docs/deploy-coe-with-prometheus.md

@@ -4,7 +4,7 @@ You can configure Prometheus as an endpoint to pull data from Citrix ADC Observa
 
 Citrix ADC Observability Exporter has a push-gateway server that listens to port 5563 to serve metrics based on pull requests from Prometheus. Citrix ADC Observability Exporter exports time series data to Prometheus. 
 
-![](media/coe-prometheus-grafana-architecture.png)
+![Prometheus and Grafana architecture](media/coe-prometheus-grafana-architecture.png)
 
 ## Configure Citrix ADC Observability Exporter
 
@@ -20,7 +20,7 @@ Perform the following steps to deploy a sample webserver application:
 
 **Note**: If you have a pre-deployed web application, skip the steps from step 1 to step 3.
 
-  1.  Create a secret using the certificate and key. Access the certificate from [ingress.crt](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/ingress.crt) and the key from [ingress.key](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/ingress.key). You can also use your own certificate and key.
+  1.  Create a secret [ingress.crt](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/ingress.crt) and key [ingress.key](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/ingress.key) using your own certificate and key.
 
       In this example, a secret, called *ing* in the default namespace, is created.
 
@@ -117,7 +117,7 @@ In the current deployment, a Prometheus server has already been added as a data
 
   You can modify the data and its representation in Grafana. For more information, see [Grafana Documentation](https://grafana.com/docs/grafana/latest/panels/panels-overview/).
 
-  ![](media/coe-prom-grafana-visualization.png)
+  ![Grafana dashboard](media/coe-prom-grafana-visualization.png)
 
   **Import pre-built dashboards for Grafana**