Skip to content

Commit 4b39496

Browse files
authored
Update README.md
1 parent 261f846 commit 4b39496

1 file changed

Lines changed: 14 additions & 6 deletions

File tree

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,18 @@ The exporter can be setup as given in the diagram using;
6161
```
6262
nohup python exporter.py --target-nsip=10.0.0.1 --port 8888 --config-file=config.yaml &
6363
```
64-
This directs the exporter container to scrape 10.0.0.1 IP, and the expose the stats it collects on port 8888.
64+
This directs the exporter container to scrape 10.0.0.1 IP, and the expose the stats it collects on port 8888.
65+
6566
File 'config.yaml' should contain username and password of the ADC to which exporter connects to. For reference, refer config.yaml.example which specifies the format for providing the login credentials.
67+
6668
Login credentials can also be provided using environment variables using NS_USER, NS_PASSWORD.Though config file input is the preferred method for security concerns.
6769

6870
The user can then access the exported metrics directly thorugh port 8888 on the machine where the exporter is running, or Prometheus and Grafana can be setup to view the exported metrics though their GUI.
6971

7072
### Additionals:
71-
As an optional configuration, Citrix ADC exporter allows you to validate the SSL server certificate provided by Citrix ADC. For this:
73+
As an optional configuration, Citrix ADC exporter allows you to validate the SSL server certificate provided by Citrix ADC.
74+
75+
For this:
7276
In config.yaml, '--validate-cert' option should be set to 'yes', and certificate path should be provided using'--cacert-path' argument. Please confirm that certificate and '--cert-path' provided is valid. Additionaly, '--validate-cert(default='no')' and '--secure(default='yes')' options should be set to 'yes'.
7377

7478

@@ -114,8 +118,10 @@ To setup the exporter as given in the diagram, the following command can be used
114118
```
115119
docker run -dt -p 8888:8888 --mount type=bind,source=/path/to/config.yaml,target=/exporter/config.yaml --name citrix-adc-exporter quay.io/citrix/citrix-adc-metrics-exporter:1.4.2 --target-nsip=10.0.0.1 --port=8888 --config-file=/exporter/config.yaml
116120
```
117-
This directs the exporter container to scrape the 10.0.0.1 IP, and the expose the stats it collects on port 8888.
118-
File 'config.yaml' should contain username and password of the ADC to which exporter connects to. For reference, refer config.yaml.example which specifies the format for providing the login credentials. Config.yaml file then needs to be mounted to the container at fixed target specified('/exporter/config.yaml') only.
121+
This directs the exporter container to scrape the 10.0.0.1 IP, and the expose the stats it collects on port 8888.
122+
123+
File 'config.yaml' should contain username and password of the ADC to which exporter connects to. For reference, refer config.yaml.example which specifies the format for providing the login credentials. Config.yaml file then needs to be mounted to the container at fixed target specified('/exporter/config.yaml') only.
124+
119125
Login credentials can also be provided using environment variables using NS_USER, NS_PASSWORD.Though config file input is the preferred method for security concerns.
120126

121127
The user can then access the exported metrics directly thorugh port 8888 on the machine where the exporter is running, or Prometheus and Grafana can be setup to view the exported metrics though their GUI.
@@ -124,8 +130,10 @@ The user can then access the exported metrics directly thorugh port 8888 on the
124130

125131

126132
### Additionals:
127-
As an optional configuration, Citrix ADC exporter allows you to validate the SSL server certificate provided by Citrix ADC. For this:
128-
In config.yaml, '--validate-cert' option should be set to 'yes', and certificate path should be provided using'--cacert-path' argument. Please confirm that certificate and '--cert-path' provided is valid. Additionaly, '--validate-cert(default='no')' and '--secure(default='yes')' options are set to 'yes' for certificate to be considered.
133+
As an optional configuration, Citrix ADC exporter allows you to validate the SSL server certificate provided by Citrix ADC.
134+
135+
For this:
136+
In config.yaml, '--validate-cert' option should be set to 'yes', and certificate path should be provided using'--cacert-path' argument. Please confirm that certificate and '--cert-path' provided is valid. Additionaly, '--validate-cert(default='no')' and '--secure(default='yes')' options should be set to 'yes' for certificate to be considered.
129137

130138
Certificate should then be mounted at the '--cacert-path' provided. For instance, if cert is 'cacert.pem' and '--cacert-path' provided in 'config.yaml' is '/exporter/cacert.pem'
131139

0 commit comments

Comments
 (0)