README.md in fluent-plugin-jfrog-metrics-0.1.0 vs README.md in fluent-plugin-jfrog-metrics-0.1.2
- old
+ new
@@ -71,17 +71,27 @@
wget https://raw.githubusercontent.com/jfrog/metrics/master/splunk/splunk_metrics.conf
````
#### Configuration parameters
Integration is done by setting up Xray. Obtain JPD url and access token for API. Configure the source directive parameters specified below
-* **tag** (string) (required): The value is the tag assigned to the generated events.
-* **jpd_url** (string) (required): JPD url required to pull Xray SIEM violations
-* **apikey** (string) (required): API Key is the [Artifactory API Key](https://www.jfrog.com/confluence/display/JFROG/User+Profile#UserProfile-APIKey) for authentication
+* **tag** (string) (required): The value is the tag assigned to the generated metrics.
+* **jpd_url** (string) (required): JPD url required to pull metrics, (note - if deployed on K8s use the localhost and port number combination per sidecar)
* **username** (string) (required): USER is the Artifactory username for authentication
+* **apikey** (string) (required if token is not used, do refer Note section for specifics): API Key is the [Artifactory API Key](https://www.jfrog.com/confluence/display/JFROG/User+Profile#UserProfile-APIKey) for authentication
+* **token** (string) (required if apikey is not used, do refer Note section for specifics): Admin token is the [Artifactory Scoped Tokens](https://www.jfrog.com/confluence/display/JFROG/Access+Tokens#AccessTokens-GeneratingAdminTokens) for authentication
* **metric_prefix** (string) (required): This values pulls the specific metrics. Values can be - jfrog.artifactory, jfrog.xray
* **interval** (integer) (optional): Wait interval between pulling new events
* Default value: `60`
-
+* **common_jpd** (true / false) (optional): This flag should be set as true only for non-kubernetes installations or installations where JPD base URL is same to access both Artifactory and Xray,
+ * ex: https://sample_base_url/artifactory or https://sample_base_url/xray
+ * Default value: false
+
+Note:
+
+* For Artifactory v7.4 and below only API Key must be used,
+* For Artifactory v7.4 to 7.29 either Token or API Key can be used,
+* For Artifactory v7.30 and above token only must be used.
+
## Copyright
* Copyright(c) 2020 - JFrog
* License
* Apache License, Version 2.0