You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/deploy-coe-with-prometheus.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,17 +6,17 @@ Citrix ADC Observability Exporter has a push-gateway server that listens to port
6
6
7
7

8
8
9
-
## Configure Citrix ADC Observability Exporter
9
+
## Deploy Citrix ADC Observability Exporter
10
10
11
11
You can deploy Citrix ADC Observability Exporter using the YAML file. Based on your Citrix ADC deployment, deploy Citrix ADC Observability Exporter either outside or inside Kubernetes clusters. You can deploy Citrix ADC Observability Exporter as a pod inside the Kubernetes cluster or on Citrix ADC MPX or VPX appliance outside the cluster.
12
12
13
13
**Prerequisites**
14
14
15
15
- Ensure that you have a Kubernetes cluster with kube-dns or CoreDNS addon enabled.
16
16
17
-
In the following procedure, the YAML file is used to deploy Citrix ADC Observability Exporter in the Kubernetes *defauIt* namespace. If you want to deploy in a private namespace other than the *default*, edit the YAML file to specify the namespace.
17
+
### Deploy a sample application
18
18
19
-
Perform the following steps to deploy a sample webserver application:
19
+
The following is an example procedure for deploying a sample webserver application.
20
20
21
21
**Note**: If you have a pre-deployed web application, skip the steps from step 1 to step 3.
22
22
@@ -38,7 +38,7 @@ Perform the following steps to deploy a sample webserver application:
38
38
39
39
For more information about Annotations, see [Ingress annotations help](https://github.com/citrix/citrix-k8s-ingress-controller/blob/666d6267e5b09683740528c5e8dd46f16d7d16e0/docs/configure/annotations.md).
40
40
41
-
## Deploy Citrix ADC CPX with the Citrix ADC Observability Exporter support
41
+
###Deploy Citrix ADC CPX with the Citrix ADC Observability Exporter support
42
42
43
43
You can deploy Citrix ADC CPX as a side car with the Citrix ADC Observability Exporter support enabled along with Citrix ingress controller. You can modify the Citrix ADC CPX YAML file `cpx-ingress-es.yaml` to include the configuration information that is required for the Citrix ADC Observability Exporter support.
44
44
@@ -52,7 +52,7 @@ You can deploy Citrix ADC CPX as a side car with the Citrix ADC Observability Ex
52
52
53
53
**Note**: If you have used a namespace other than *default*, change `coe-prometheus.default.svc.cluster.local to` to `coe-prometheus.<desired-namespace>.svc.cluster.local`.
54
54
55
-
## Deploy Prometheus and Grafana using YAML files
55
+
###Deploy Prometheus and Grafana using YAML files
56
56
57
57
To deploy Prometheus and Grafana using YAML files, perform the following steps:
58
58
@@ -64,7 +64,7 @@ To deploy Prometheus and Grafana using YAML files, perform the following steps:
64
64
65
65
**Note**: Prometheus and Grafana are deployed in the default namespace of the same Kubernetes cluster.
66
66
67
-
## Deploy Citrix ADC Observability Exporter using the YAML file
67
+
###Deploy Citrix ADC Observability Exporter using the YAML file
68
68
69
69
You can deploy Citrix ADC Observability Exporter using the YAML file. Download the YAML file from [coe-prometheus.yaml](https://raw.githubusercontent.com/citrix/citrix-observability-exporter/master/examples/prometheus/coe-prometheus.yaml).
70
70
@@ -74,7 +74,7 @@ To deploy Prometheus and Grafana using YAML files, perform the following steps:
74
74
75
75
**Note**: Modify the YAML file for Citrix ADC Observability Exporter if you have a custom namespace.
76
76
77
-
## Configure Citrix ADC to export metrics (optional)
77
+
###Configure Citrix ADC to export metrics (optional)
78
78
79
79
**Note**: If you do not use CIC to configure, then you can do the following manual configuration on your Citric ADC.
80
80
@@ -86,7 +86,7 @@ To deploy Prometheus and Grafana using YAML files, perform the following steps:
86
86
add service coe_metric_collector_svc_192.168.1.102 COE_instance HTTP 5563
87
87
set analytics profile ns_analytics_time_series_profile -collector coe_metric_collector_svc_192.168.1.102 -Metrics ENABLED -OutputMode Prometheus
88
88
89
-
## Configure Prometheus (optional) to pull telemetry data
89
+
###Configure Prometheus (optional) to pull telemetry data
90
90
91
91
Prometheus services are available as Docker images on [Quay container registry](https://quay.io/) and Docker Hub.
92
92
@@ -101,11 +101,11 @@ To deploy Prometheus and Grafana using YAML files, perform the following steps:
101
101
static_configs:
102
102
- targets: ['192.168.1.102:5563']
103
103
104
-
## Configure Grafana
104
+
###Configure Grafana
105
105
106
106
In the current deployment, a Prometheus server has already been added as a data source. If you use an existing Prometheus server for the deployment, ensure to add the same as a data source on your Grafana. For more information, see [Grafana support for Prometheus](https://prometheus.io/docs/visualization/grafana/).
107
107
108
-
## Create Grafana visualization
108
+
###Create Grafana visualization
109
109
110
110
You can create a Grafana dashboard and select the key metrics and the visualization type that is suitable for the data.
0 commit comments