Skip to content

Commit 89f9e31

Browse files
committed
updated metrics exporter support note
1 parent 8d25f6e commit 89f9e31

2 files changed

Lines changed: 15 additions & 7 deletions

File tree

docs/deploy/deploy-cic-adc-admin-partition.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Citrix ingress controller is used to automatically configure one or more Citrix
44

55
For Citrix ADC with admin partitions, you must deploy a single instance of Citrix ingress controller for each partition. And, the partition must be associated with a [partition user](https://docs.citrix.com/en-us/citrix-adc/13/admin-partition.html#user-access-and-roles) specific to the Citrix ingress controller instance.
66

7+
**Note:**
8+
9+
Citrix ADC metrics exporter supports exporting metrics from the admin partitions of Citrix ADC.
10+
711
## Prerequisites
812

913
Ensure that:

docs/metrics/promotheus-grafana.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ You can use the [Citrix ADC metrics exporter](https://github.com/citrix/citrix-a
66

77
Citrix ADC metrics exporter is a simple server that collects Citrix ADC stats and exports them to Prometheus using `HTTP`. You can then add Prometheus as a data source to Grafana and graphically view the Citrix ADC stats. For more information see, [Citrix ADC metrics exporter](https://github.com/citrix/citrix-adc-metrics-exporter).
88

9+
> **Note:**
10+
>
11+
> Citrix ADC metrics exporter supports exporting metrics from the admin partitions of Citrix ADC.
12+
913
## Launch prometheus operator
1014

1115
The Prometheus Operator has an expansive method of monitoring services on Kubernetes. To get started, this topic uses `kube-prometheus` and its manifest files. The manifest files help you to deploy a basic working model. Deploy the Prometheus Operator in your Kubernetes environment using the following commands:
@@ -89,7 +93,7 @@ This topic describes how to integrate the [Citrix ADC metrics exporter](https://
8993
9094
**Citrix ADC VPX Ingress device**:
9195
92-
To monitor an ingress Citrix ADC VPX device, the Citrix ADC metrics exporter is run as a pod within the Kubernetes cluster. The IP address of the Citrix ADC VPX ingress device is provided as an argument to the Citrix ADC metrics exporter. To provide the login credentials to access ADC, create a secret and mount the volume at mountpath "/mnt/nslogin".
96+
To monitor an ingress Citrix ADC VPX device, the Citrix ADC metrics exporter is run as a pod within the Kubernetes cluster. The IP address of the Citrix ADC VPX ingress device is provided as an argument to the Citrix ADC metrics exporter. To provide the login credentials to access ADC, create a secret and mount the volume at mount path "/mnt/nslogin".
9397
```
9498
kubectl create secret generic nslogin --from-literal=username=<citrix-adc-user> --from-literal=password=<citrix-adc-password> -n <namespace>
9599
```
@@ -140,7 +144,7 @@ The IP address and the port of the Citrix ADC VPX device needs to be provided in
140144

141145
**Citrix ADC CPX Ingress device**:
142146

143-
To monitor a Citrix ADC CPX ingress device, the Citrix ADC metrics exporter is added as a sidecar to the Citrix ADC CPX.The following is a sample YAML file of a Citrix ADC CPX ingress device with the exporter as a side car:
147+
To monitor a Citrix ADC CPX ingress device, the Citrix ADC metrics exporter is added as a sidecar to the Citrix ADC CPX. The following is a sample YAML file of a Citrix ADC CPX ingress device with the exporter as a side car:
144148

145149
```YAML
146150
---
@@ -225,7 +229,7 @@ Here, the exporter uses the local IP address (`192.0.0.2`) to fetch metrics from
225229

226230
**Citrix ADC CPX (east-west) device**:
227231

228-
To monitor a Citrix ADC CPX (east-west) device, the Citrix ADC metrics exporter is added as a sidecar to the Citrix ADCCPX.The following is a sample YAML file of a Citrix ADC CPX (east-west) device with the exporter as a side car:
232+
To monitor a Citrix ADC CPX (east-west) device, the Citrix ADC metrics exporter is added as a sidecar to the Citrix ADC CPX. The following is a sample YAML file of a Citrix ADC CPX (east-west) device with the exporter as a side car:
229233

230234
```YAML
231235
apiVersion: apps/v1
@@ -324,7 +328,7 @@ spec:
324328
The `ServiceMonitor` directs Prometheus to detect Exporters in the `default` and `monitoring` namespaces only. To detect Exporters from other namespaces add the names of those namespaces under the `namespaceSelector:` field.
325329

326330
!!! note "Note"
327-
If the Exporter that needs to be monitored exists in a namespace other than the `default` or `monitoring` namespace, then additional RBAC privileges must be provided to Prometheus to access those namespaces. The following is sample YAML (`prometheus-clusterRole.yaml`) file the provides Prometheus full access to resources across the namespaces:
331+
If the Exporter that needs to be monitored exists in a namespace other than the `default` or `monitoring` namespace, then additional RBAC privileges must be provided to Prometheus to access those namespaces. The following is a sample YAML (`prometheus-clusterRole.yaml`) file that provides Prometheus full access to resources across the namespaces:
328332

329333
```yml
330334
apiVersion: rbac.authorization.k8s.io/v1
@@ -350,17 +354,17 @@ To provide additional privileges Prometheus, deploy the sample YAML using the fo
350354

351355
kubectl apply -f prometheus-clusterRole.yaml
352356

353-
### View the metrics in grafana
357+
### View the metrics in Grafana
354358

355359
The Citrix ADC instances that are detected for monitoring appears in the **Targets** page of the prometheus container. You can be access the **Targets** page using the following URL: `http://<k8s_cluster_ip>:<prometheus_nodeport>/targets`:
356360

357361
![Metrics](../media/metrics.png)
358362

359363
To view the metrics graphically:
360364

361-
1. Log into grafana using `http://<k8s_cluster_ip>:<grafafa_nodeport>` with default credentials *admin:admin*
365+
1. Log into Grafana using `http://<k8s_cluster_ip>:<grafafa_nodeport>` with default credentials *admin:admin*
362366

363-
1. On the left panel, select **+** and click **Import** to import the [sample grafana dashboard](https://github.com/citrix/citrix-adc-metrics-exporter/blob/master/sample_lb_stats.json).
367+
1. On the left panel, select **+** and click **Import** to import the [sample Grafana dashboard](https://github.com/citrix/citrix-adc-metrics-exporter/blob/master/sample_lb_stats.json).
364368

365369
![metrics-graph](../media/metrics-graph.png)
366370

0 commit comments

Comments
 (0)