Merge pull request #6 from opendistro/master

merge

Author: ashwinkumar12345

README.md

@@ -50,8 +50,7 @@ This repository contains the documentation for Open Distro for Elasticsearch, a
 ## New releases
 
 1. Branch.
-1. Run a find and replace for `:x.y.z`, `-x.y.z`, and `_x.y.z` and replace with the new version string.
-1. Run a find for the underlying Elasticsearch version and update it as necessary (probably just `docs/install/deb.md`).
+1. Change the `odfe_version` and `es_version` variables in `_config.yml`.
 1. Start up a new cluster using the updated Docker Compose file in `docs/install/docker.md`.
 1. Update the version table in `version-history.md`.
 

_config.yml

@@ -20,6 +20,9 @@ baseurl: "/for-elasticsearch-docs" # the subpath of your site, e.g. /blog
 url: "https://opendistro.github.io" # the base hostname & protocol for your site, e.g. http://example.com
 permalink: pretty
 
+odfe_version: 1.10.1
+es_version: 7.9.1
+
 # Build settings
 markdown: kramdown
 remote_theme: pmarsceill/[email protected]
@@ -75,7 +78,7 @@ heading_anchors: false
 # Adds on-hover anchor links to h2-h6
 anchor_links: true
 
-footer_content: 
+footer_content:
 
 plugins:
   - jekyll-remote-theme

docs/ad/cli.md

@@ -0,0 +1,100 @@
+---
+layout: default
+title: Anomaly Detection CLI
+parent: Anomaly Detection
+nav_order: 3
+---
+
+# Anomaly Detection CLI
+
+Anomaly detection CLI lets you call anomaly detection APIs with the `esad` command.
+
+You can use the CLI to:
+
+* Create detectors
+* Start, stop, and delete detectors
+* Create named profiles to connect to your cluster
+
+Install the anomaly detection plugin to your Elasticsearch instance, run the CLI using macOS or Linux, and connect to any valid Elasticsearch end-point.
+
+## Install
+
+Launch your local Elasticsearch instance and make sure you have the anomaly detection plugin installed.
+
+To install the anomaly detection CLI:
+
+1. Download and extract [esad binaries](https://github.com/opendistro-for-elasticsearch/anomaly-detection/actions/runs/224422434).
+
+2. Make the `esad` file executable:
+```bash
+chmod +x ./esad
+```
+
+3. Move the binaries to your path for root users:
+```bash
+sudo mv ./esad /usr/local/bin/esad
+```
+Or add it to the current path:
+```bash
+export PATH=$PATH:$(pwd)
+```
+
+4. Check if the CLI is installed:
+```bash
+esad --version
+```
+You should see the command prints of the `esad` version you installed.
+
+
+## Configure
+
+Before using the CLI, you must configure your credentials.
+
+To quickly get started, run the `esad profile create` command:
+```
+esad profile create
+
+Enter profile's name: dev
+ES Anomaly Detection Endpoint: https://localhost:9200
+ES Anomaly Detection User: admin
+ES Anomaly Detection Password:
+```
+
+Specify a unique profile name. The `create` command doesn’t allow duplicate profiles.
+
+Alternatively, you can also use a configuration file:
+```yaml
+profiles:
+- endpoint: https://localhost:9200
+  username: admin
+  password: foobar
+  name: default
+- endpoint: https://odfe-node1:9200
+  username: admin
+  password: foobar
+  name: dev
+```
+
+Save the file in `~/.esad/config.yaml`. If save you file to a different location, set the appropriate environment variable:
+```
+export ESAD_CONFIG_FILE=/path/to/config_file
+```
+
+## Using the CLI
+
+1. The complete syntax for an `esad` command is as follows:
+```
+esad <command> <subcommand> [flags and parameters]
+```
+
+1. To start a detector:
+```
+esad start [detector-name-pattern]
+```
+
+1. To see help documentation:
+```
+esad --help
+esad <command> --help
+esad <command> <subcommand> --help
+```

docs/ad/index.md

@@ -21,6 +21,7 @@ To use the anomaly detection plugin, your computer needs to have more than one C
 ## Get started with Anomaly Detection
 
 To get started, choose **Anomaly Detection** in Kibana.
+To first test with sample streaming data, choose **Sample Detectors** and try out one of the preconfigured detectors.
 
 ### Step 1: Create a detector