Merge pull request #28 from sruti1312/pa-changes

Update PA docs

docs/opensearch/install/docker.md

@@ -192,25 +192,25 @@ You can also configure `docker-compose.yml` and `opensearch.yml` [to take your o
 1. Enable the Performance Analyzer plugin:
 
    ```bash
-   curl -XPOST localhost:9200/_opensearch/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}'
+   curl -XPOST localhost:9200/_plugins/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}'
    ```
 
    If you receive the `curl: (52) Empty reply from server` error, you are likely protecting your cluster with the security plugin and you need to provide credentials. Modify the following command to use your username and password:
 
    ```bash
-   curl -XPOST https://localhost:9200/_opensearch/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k
+   curl -XPOST https://localhost:9200/_plugins/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k
    ```
 
 1. Enable the Root Cause Analyzer (RCA) framework
 
    ```bash
-   curl -XPOST localhost:9200/_opensearch/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}'
+   curl -XPOST localhost:9200/_plugins/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}'
    ```
 
    Similar to step 1, if you run into `curl: (52) Empty reply from server`, run the command below to enable RCA
 
    ```bash
-   curl -XPOST https://localhost:9200/_opensearch/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k
+   curl -XPOST https://localhost:9200/_plugins/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k
    ```
 
 1. By default, Performance Analyzer's endpoints are not accessible from outside the Docker container.

docs/opensearch/install/plugins.md

@@ -244,7 +244,7 @@ Performance Analyzer requires some manual configuration after installing the plu
 1. Send a test request:
 
    ```bash
-   curl -XGET "localhost:9600/_opensearch/_performanceanalyzer/metrics?metrics=Latency,CPU_Utilization&agg=avg,max&dim=ShardID&nodes=all"
+   curl -XGET "localhost:9600/_plugins/_performanceanalyzer/metrics?metrics=Latency,CPU_Utilization&agg=avg,max&dim=ShardID&nodes=all"
    ```
 {% endcomment %}
 

docs/opensearch/install/tar.md

@@ -118,25 +118,25 @@ In a tarball installation, Performance Analyzer collects data when it is enabled
 1. In a separate window, enable the Performance Analyzer plugin:
 
    ```bash
-   curl -XPOST localhost:9200/_opensearch/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}'
+   curl -XPOST localhost:9200/_plugins/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}'
    ```
 
    If you receive the `curl: (52) Empty reply from server` error, you are likely protecting your cluster with the security plugin and you need to provide credentials. Modify the following command to use your username and password:
 
    ```bash
-   curl -XPOST https://localhost:9200/_opensearch/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k
+   curl -XPOST https://localhost:9200/_plugins/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k
    ```
 
 1. Finally, enable the Root Cause Analyzer (RCA) framework
 
    ```bash
-   curl -XPOST localhost:9200/_opensearch/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}'
+   curl -XPOST localhost:9200/_plugins/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}'
    ```
 
    Similar to step 4, if you run into `curl: (52) Empty reply from server`, run the command below to enable RCA
 
    ```bash
-   curl -XPOST https://localhost:9200/_opensearch/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k
+   curl -XPOST https://localhost:9200/_plugins/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k
    ```
 
 {% comment %}

docs/pa/api.md

@@ -10,7 +10,7 @@ nav_order: 1
 Performance Analyzer uses a single HTTP method and URI for most requests:
 
 ```
-GET <endpoint>:9600/_opensearch/_performanceanalyzer/metrics
+GET <endpoint>:9600/_plugins/_performanceanalyzer/metrics
 ```
 
 Note the use of port 9600. Provide parameters for metrics, aggregations, dimensions, and nodes (optional):
@@ -25,7 +25,7 @@ For a full list of metrics, see [Metrics reference](../reference/). Performance
 #### Sample request
 
 ```
-GET localhost:9600/_opensearch/_performanceanalyzer/metrics?metrics=Latency,CPU_Utilization&agg=avg,max&dim=ShardID&nodes=all
+GET localhost:9600/_plugins/_performanceanalyzer/metrics?metrics=Latency,CPU_Utilization&agg=avg,max&dim=ShardID&nodes=all
 ```
 
 
@@ -104,7 +104,7 @@ Performance Analyzer has one additional URI that returns the unit for each metri
 #### Sample request
 
 ```
-GET localhost:9600/_opensearch/_performanceanalyzer/metrics/units
+GET localhost:9600/_plugins/_performanceanalyzer/metrics/units
 ```
 
 

docs/pa/index.md

@@ -25,25 +25,25 @@ npm install -g @aws/opensearch-perftop
 The basic syntax is:
 
 ```bash
-./perf-top-<operating_system> --dashboard <dashboard>.json --endpoint <endpoint>
+./opensearch-perf-top-<operating_system> --dashboard <dashboard>.json --endpoint <endpoint>
 ```
 
 If you're using npm, the syntax is similar:
 
 ```bash
-perf-top --dashboard <dashboard> --endpoint <endpoint>
+opensearch-perf-top --dashboard <dashboard> --endpoint <endpoint>
 ```
 
 If you're running PerfTop from a node (i.e. locally), specify port 9600:
 
 ```bash
-./perf-top-linux --dashboard dashboards/<dashboard>.json --endpoint localhost:9600
+./opensearch-perf-top-linux --dashboard dashboards/<dashboard>.json --endpoint localhost:9600
 ```
 
 Otherwise, just specify the OpenSearch endpoint:
 
 ```bash
-./perf-top-macos --dashboard dashboards/<dashboard>.json --endpoint my-cluster.my-domain.com
+./opensearch-perf-top-macos --dashboard dashboards/<dashboard>.json --endpoint my-cluster.my-domain.com
 ```
 
 PerfTop has four pre-built dashboards in the `dashboards` directory, but you can also [create your own](dashboards/).
@@ -83,10 +83,10 @@ mount -o remount /dev/shm
 
 ### Security
 
-Performance Analyzer supports encryption in transit for requests. It currently does *not* support client or server authentication for requests. To enable encryption in transit, edit `performance-analyzer.properties` in your `$ES_HOME` directory:
+Performance Analyzer supports encryption in transit for requests. It currently does *not* support client or server authentication for requests. To enable encryption in transit, edit `performance-analyzer.properties` in your `$OPENSEARCH_HOME` directory:
 
 ```bash
-vi $ES_HOME/plugins/opensearch_performance_analyzer/pa_config/performance-analyzer.properties
+vi $OPENSEARCH_HOME/plugins/opensearch-performance-analyzer/pa_config/performance-analyzer.properties
 ```
 
 Change the following lines to configure encryption in transit. Note that `certificate-file-path` must be a certificate for the server, not a root CA:

docs/pa/rca/api.md

@@ -12,10 +12,10 @@ nav_order: 1
 
 ```
 # Request all available RCAs
-GET localhost:9600/_opensearch/_performanceanalyzer/rca
+GET localhost:9600/_plugins/_performanceanalyzer/rca
 
 # Request a specific RCA
-GET localhost:9600/_opensearch/_performanceanalyzer/rca?name=HighHeapUsageClusterRca
+GET localhost:9600/_plugins/_performanceanalyzer/rca?name=HighHeapUsageClusterRca
 ```
 
 

docs/pa/rca/reference.md

@@ -8,4 +8,4 @@ nav_order: 3
 
 # RCA reference
 
-You can find a reference of available RCAs and their purposes on [Github](https://github.com/opensearch-project/performance-analyzer-rca/tree/master/docs).
+You can find a reference of available RCAs and their purposes on [Github](https://github.com/opensearch-project/performance-analyzer-rca/tree/main/docs).