Skip to content

Commit b2d2e37

Browse files
Updated default namespace related information in the doc
1 parent adb979f commit b2d2e37

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

docs/deploy-coe-with-prometheus.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ Citrix ADC Observability Exporter has a push-gateway server that listens to port
66

77
![Prometheus and Grafana architecture](media/coe-prometheus-grafana-architecture.png)
88

9-
## Configure Citrix ADC Observability Exporter
9+
## Deploy Citrix ADC Observability Exporter
1010

1111
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.
1212

1313
**Prerequisites**
1414

1515
- Ensure that you have a Kubernetes cluster with kube-dns or CoreDNS addon enabled.
1616

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
1818

19-
Perform the following steps to deploy a sample webserver application:
19+
The following is an example procedure for deploying a sample webserver application.
2020

2121
**Note**: If you have a pre-deployed web application, skip the steps from step 1 to step 3.
2222

@@ -38,7 +38,7 @@ Perform the following steps to deploy a sample webserver application:
3838

3939
For more information about Annotations, see [Ingress annotations help](https://github.com/citrix/citrix-k8s-ingress-controller/blob/666d6267e5b09683740528c5e8dd46f16d7d16e0/docs/configure/annotations.md).
4040

41-
## Deploy Citrix ADC CPX with the Citrix ADC Observability Exporter support
41+
### Deploy Citrix ADC CPX with the Citrix ADC Observability Exporter support
4242

4343
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.
4444

@@ -52,7 +52,7 @@ You can deploy Citrix ADC CPX as a side car with the Citrix ADC Observability Ex
5252

5353
**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`.
5454

55-
## Deploy Prometheus and Grafana using YAML files
55+
### Deploy Prometheus and Grafana using YAML files
5656

5757
To deploy Prometheus and Grafana using YAML files, perform the following steps:
5858

@@ -64,7 +64,7 @@ To deploy Prometheus and Grafana using YAML files, perform the following steps:
6464

6565
**Note**: Prometheus and Grafana are deployed in the default namespace of the same Kubernetes cluster.
6666

67-
## Deploy Citrix ADC Observability Exporter using the YAML file
67+
### Deploy Citrix ADC Observability Exporter using the YAML file
6868

6969
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).
7070

@@ -74,7 +74,7 @@ To deploy Prometheus and Grafana using YAML files, perform the following steps:
7474

7575
**Note**: Modify the YAML file for Citrix ADC Observability Exporter if you have a custom namespace.
7676

77-
## Configure Citrix ADC to export metrics (optional)
77+
### Configure Citrix ADC to export metrics (optional)
7878

7979
**Note**: If you do not use CIC to configure, then you can do the following manual configuration on your Citric ADC.
8080

@@ -86,7 +86,7 @@ To deploy Prometheus and Grafana using YAML files, perform the following steps:
8686
add service coe_metric_collector_svc_192.168.1.102 COE_instance HTTP 5563
8787
set analytics profile ns_analytics_time_series_profile -collector coe_metric_collector_svc_192.168.1.102 -Metrics ENABLED -OutputMode Prometheus
8888

89-
## Configure Prometheus (optional) to pull telemetry data
89+
### Configure Prometheus (optional) to pull telemetry data
9090

9191
Prometheus services are available as Docker images on [Quay container registry](https://quay.io/) and Docker Hub.
9292

@@ -101,11 +101,11 @@ To deploy Prometheus and Grafana using YAML files, perform the following steps:
101101
static_configs:
102102
- targets: ['192.168.1.102:5563']
103103

104-
## Configure Grafana
104+
### Configure Grafana
105105

106106
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/).
107107

108-
## Create Grafana visualization
108+
### Create Grafana visualization
109109

110110
You can create a Grafana dashboard and select the key metrics and the visualization type that is suitable for the data.
111111

0 commit comments

Comments
 (0)