Alice Williams
1dd560977b
* add files back from lost local files Signed-off-by: Alice Williams <[email protected]> * nest reporting CLI under main Reporting page Signed-off-by: Alice Williams <[email protected]> * rough draft examples for AWS Lambda and Cron Signed-off-by: Alice Williams <[email protected]> * better title for cron job report example Signed-off-by: Alice Williams <[email protected]> * for more details from tech reviewer Signed-off-by: Alice Williams <[email protected]> * for better cron job usage description Signed-off-by: Alice Williams <[email protected]> * for more details Signed-off-by: Alice Williams <[email protected]> * remove needs info markers and add links to events doc Signed-off-by: Alice Williams <[email protected]> * more info Signed-off-by: Alice Williams <[email protected]> * more details from demonstration Signed-off-by: Alice Williams <[email protected]> * remove reporting directory to keep both parallel in left nav Signed-off-by: Alice Williams <[email protected]> * small addition Signed-off-by: Alice Williams <[email protected]> * for two configuration settings in the function Signed-off-by: Alice Williams <[email protected]> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <[email protected]> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <[email protected]> * for more details Signed-off-by: Alice Williams <[email protected]> * for additional steps to create and test the lambda function Signed-off-by: Alice Williams <[email protected]> * for scheduling reports with lambda Signed-off-by: Alice Williams <[email protected]> * merge redundant set of steps together Signed-off-by: Alice Williams <[email protected]> * for tech review comments Signed-off-by: Alice Williams <[email protected]> * to add download correct title and link Signed-off-by: Alice Williams <[email protected]> * for reporting directory to nest new cli page Signed-off-by: Alice Williams <[email protected]> * un-nest reporting directory Signed-off-by: Alice Williams <[email protected]> * to remove reporting directory - will nest with other page in separate PR Signed-off-by: Alice Williams <[email protected]> * tech review comments and some reorg Signed-off-by: Alice Williams <[email protected]> * for tech review comments Signed-off-by: Alice Williams <[email protected]> * to minor changes Signed-off-by: Alice Williams <[email protected]> * more info about crontab sequence Signed-off-by: Alice Williams <[email protected]> * cron updates Signed-off-by: Alice Williams <[email protected]> * for cron syntax Signed-off-by: Alice Williams <[email protected]> * small updates to lambda proc Signed-off-by: Alice Williams <[email protected]> * for final writer checklist Signed-off-by: Alice Williams <[email protected]> * cron link update Signed-off-by: Alice Williams <[email protected]> * format fix Signed-off-by: Alice Williams <[email protected]> * for doc review cron & lambda sections Signed-off-by: Alice Williams <[email protected]> * for cron reference to man page Signed-off-by: Alice Williams <[email protected]> * add internal link to cron ref Signed-off-by: Alice Williams <[email protected]> * reorg single topic into 7 pages Signed-off-by: Alice Williams <[email protected]> * minor update Signed-off-by: Alice Williams <[email protected]> * link to set ses permissions Signed-off-by: Alice Williams <[email protected]> * for tech review meeting updates Signed-off-by: Alice Williams <[email protected]> * small update Signed-off-by: Alice Williams <[email protected]> * npm download command name changed to remove opensearch prepended name Signed-off-by: Alice Williams <[email protected]> * for new download via artifacts hub Signed-off-by: Alice Williams <[email protected]> * for new download instructions Signed-off-by: Alice Williams <[email protected]> * small fix signature file Signed-off-by: Alice Williams <[email protected]> * typo Signed-off-by: Alice Williams <[email protected]> * for cleaner image Signed-off-by: Alice Williams <[email protected]> * remove image for push commands we won't use Signed-off-by: Alice Williams <[email protected]> --------- Signed-off-by: Alice Williams <[email protected]>
35 lines
1.4 KiB
Markdown
35 lines
1.4 KiB
Markdown
---
|
|
layout: default
|
|
title: Downloading and installing the Reporting CLI tool
|
|
nav_order: 10
|
|
parent: Creating reports with the Reporting CLI
|
|
|
|
---
|
|
|
|
# Downloading and installing the Reporting CLI tool
|
|
|
|
You can download and install the Reporting CLI tool from either the npm software registry or the OpenSearch.org [Artifacts](https://opensearch.org/artifacts) hub. Refer to the following sections for instructions.
|
|
|
|
To learn more about the npm software registry, see the [npm](https://docs.npmjs.com/about-npm) documentation.
|
|
|
|
## Downloading and installing the Reporting CLI from npm
|
|
|
|
To download and install the Reporting CLI from npm, run the following command to initiate installation:
|
|
|
|
```
|
|
npm i @opensearch-project/reporting-cli
|
|
```
|
|
|
|
## Downloading and installing the Reporting CLI from OpenSearch.org
|
|
|
|
You can download the `opensearch-reporting-cli` tool from the OpenSearch.org [Artifacts](https://artifacts.opensearch.org/reporting-cli/opensearch-reporting-cli-1.0.0.tgz) hub.
|
|
|
|
Next, run the following command to install the .tar archive:
|
|
|
|
```
|
|
npm install -g opensearch-reporting-cli-1.0.0.tgz
|
|
```
|
|
|
|
Optionally, you can verify signatures by downloading the [Reporting CLI signature file](https://artifacts.opensearch.org/reporting-cli/opensearch-reporting-cli-1.0.0.tgz.sig).
|
|
|
|
To learn more about verifying signatures, see [How to verify signatures for downloadable artifacts](https://opensearch.org/verify-signatures.html). |