Skip to content

Latest commit

 

History

History
152 lines (117 loc) · 5.72 KB

README.md

File metadata and controls

152 lines (117 loc) · 5.72 KB
Raw

Build and Test odfe-cli codecov Documentation PRs welcome!

ODFE Command Line Interface

ODFE Command Line Interface (odfe-cli) is an open source tool that lets you manage your Open Distro for Elasticsearch cluster from the command line and automate tasks. In addition to standard Elasticsearch operations, you can configure, manage, and use the ODFE plugins, such as Alerting, Anomaly Detection, and SQL

odfe-cli is best suited for situations in which you want to quickly combine a few commands, possibly adding them to a script for easy access or automation. This example moves a detector "ecommerce-count-qualtity" from staging to prod cluster, provided both profiles are available in config file.

odfe-cli ad get ecommerce-count-qualtity --profile stg > ecommerce-count-qualtity.json
odfe-cli ad create ecommerce-count-qualtity.json --profile prod
odfe-cli ad start ecommerce-count-qualtity.json --profile prod
odfe-cli ad stop ecommerce-count-qualtity --profile stg
odfe-cli ad delete ecommerce-count-qualtity --profile stg

Installation:

You can download the binaries directly from the downloads page or from the releases section.

Supported versions and Interoperability

Odfe cli and Opendistro plugins compatibility

odfe-cli version odfe plugins odfe versions
1.0 Anomaly Detection 1.12.0

Development

Minimum requirements

odfe-cli shares minimum requirements as Go and docker to run integration tests.

Build from source

  1. Install Go > = 1.14
  2. Clone the repository: 
    cd $GOPATH/src
git clone [email protected]:opendistro-for-elasticsearch/odfe-cli.git
  3. Run build from source directory to generate binary: 
    cd odfe-cli
go build .
  4. Make binary executable: 
    chmod +x ./odfe-cli

Unit Testing

Go has a simple tool for running tests. To run every unit test, use this command:

go test ./...

However, often when writing tests, you may want to run your new test as below

cd folder-path/to/test;
go test -v -run TestName;

Integration Testing

In order to test odfe-cli end-to-end, we need a running odfe cluster. We can use Docker to accomplish this. The Docker Compose file supports the ability to run integration tests for the project in local environments respectively. If you have not installed docker-compose, you can install it from this link

Integration tests are often slower, so you may want to only run them after the unit test. In order to differentiate unit tests from integration tests, Go has a built-in mechanism for allowing you to logically separate your tests with build tags. The build tag needs to be placed as close to the top of the file as possible, and must have a blank line beneath it.
We recommend you to create all integration tests inside this folder with build tag 'integration'.

Execute test integration command from your CLI

  1. Run docker compose to start containers, by default it will launch latest odfe version. 
    docker-compose up -d;
  2. Run all integration tests with build tag 'integration' 
    go test -tags=integration ./it/...

Usage

odfe-cli --help

Create default profile

A profile is a collection of credentials that will be applied to the odfe-cli command. When a user specifies a profile, the settings and credentials of that profile will be used to execute the command. Users can create one profile with the name "default", and is used when no profile is explicitly referenced.

$ odfe-cli profile create
Enter profile's name: default
Elasticsearch Endpoint: https://localhost:9200  
User Name: admin
Password:

List existing profile

$ odfe-cli profile list -l
Name         UserName            Endpoint-url             
----         --------            ------------              
default      admin               https://localhost:9200   
prod         admin               https://odfe-node1:9200

Using profile with odfe-cli command

You can specify profiles in two ways.

  1. The first way is to add the --profile option:

    $ odfe-cli ad stop-detector invalid-logins --profile prod

    This example stops the invalid-logins detector using the credentials and settings in the prod profile.

  2. The second way is to use an environment variable.

    On Linux or macOS :

    $ export ODFE_PROFILE=prod

    Windows

    C:\> setx ODFE_PROFILE prod

    These variables last for the duration of your shell session, but you can add them to .zshenv or .bash_profile for a more permanent option.

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.