Skip to content
This repository was archived by the owner on Aug 16, 2022. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/cli/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
layout: default
title: ODFE CLI
title: Open Distro CLI
nav_order: 52
has_children: false
---

# ODFE CLI
# Open Distro CLI

The Open Distro for Elasticsearch command line interface (odfe-cli) lets you manage your ODFE cluster from the command line and automate tasks.
The Open Distro command line interface (odfe-cli) lets you manage your Open Distro cluster from the command line and automate tasks.

Currently, odfe-cli supports the [Anomaly Detection](../ad/) and [k-NN](../knn/) plugins, along with arbitrary REST API paths. Among other things, you can use odfe-cli create and delete detectors, start and stop them, and check k-NN statistics.
Currently, the Open Distro CLI supports the [Anomaly Detection](../ad/) and [k-NN](../knn/) plugins, along with arbitrary REST API paths. Among other things, you can use the CLI create and delete detectors, start and stop them, and check k-NN statistics.

Profiles let you easily access different clusters or sign requests with different credentials. odfe-cli supports unauthenticated requests, HTTP basic signing, and IAM signing for Amazon Web Services.
Profiles let you easily access different clusters or sign requests with different credentials. The CLI supports unauthenticated requests, HTTP basic signing, and IAM signing for Amazon Web Services.

This example moves a detector (`ecommerce-count-quantity`) from a staging cluster to a production cluster:

Expand Down
6 changes: 3 additions & 3 deletions docs/other/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ has_toc: false

# Other resources

- [Open Distro for Elasticsearch blog](https://opendistro.github.io/for-elasticsearch/blog/) -- includes release announcements, technical walkthroughs, and case studies.
- [Ansible playbook](https://github.com/saravanan30erd/opendistro_standalone_installation) -- helps with installing a production-ready Open Distro Elasticsearch cluster with Kibana using the [standalone plugin installation](../install/plugins/) method.
- [Ansible role](https://github.com/trombik/ansible-role-opendistroforelasticsearch) -- a reusable Ansible configuration for Open Distro for Elasticsearch (Elasticsearch only, no Kibana).
- [Open Distro blog](https://opendistro.github.io/for-elasticsearch/blog/) -- includes release announcements, technical walkthroughs, and case studies.
- [Ansible playbook](https://github.com/saravanan30erd/opendistro_standalone_installation) -- helps with installing a production-ready Open Distro cluster with Kibana using the [standalone plugin installation](../install/plugins/) method.
- [Ansible role](https://github.com/trombik/ansible-role-opendistroforelasticsearch) -- a reusable Ansible configuration for Open Distro (Elasticsearch OSS only, no Kibana).
4 changes: 2 additions & 2 deletions docs/pa/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ has_children: true

Performance Analyzer is an agent and REST API that allows you to query numerous performance metrics for your cluster, including aggregations of those metrics, independent of the Java Virtual Machine (JVM). PerfTop is the default command line interface (CLI) for displaying those metrics.

To download PerfTop, see [Download](https://opendistro.github.io/for-elasticsearch/downloads.html) on the Open Distro for Elasticsearch website.
To download PerfTop, see [Download](https://opendistro.github.io/for-elasticsearch/downloads.html) on the Open Distro website.

You can also install it using [npm](https://www.npmjs.com/):

Expand Down Expand Up @@ -40,7 +40,7 @@ If you're running PerfTop from a node (i.e. locally), specify port 9600:
./perf-top-linux --dashboard dashboards/<dashboard>.json --endpoint localhost:9600
```

Otherwise, just specify the Elasticsearch endpoint:
Otherwise, just specify the Elasticsearch OSS endpoint:

```bash
./perf-top-macos --dashboard dashboards/<dashboard>.json --endpoint my-cluster.my-domain.com
Expand Down
12 changes: 6 additions & 6 deletions docs/pa/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ This list is extensive. We recommend using Ctrl/Cmd + F to find what you're look
<tr>
<td>Cache_FieldData_Eviction
</td>
<td>The number of times Elasticsearch has evicted data from the fielddata heap space (occurs when the heap space is full) in the past five seconds.
<td>The number of times Elasticsearch OSS has evicted data from the fielddata heap space (occurs when the heap space is full) in the past five seconds.
</td>
</tr>
<tr>
Expand All @@ -186,7 +186,7 @@ This list is extensive. We recommend using Ctrl/Cmd + F to find what you're look
<tr>
<td>Cache_Request_Eviction
</td>
<td>The number of times Elasticsearch evicts data from shard request cache (occurs when the request cache is full) in the past five seconds.
<td>The number of times Elasticsearch OSS evicts data from shard request cache (occurs when the request cache is full) in the past five seconds.
</td>
</tr>
<tr>
Expand Down Expand Up @@ -366,7 +366,7 @@ This list is extensive. We recommend using Ctrl/Cmd + F to find what you're look
</td>
<td rowspan="3">DiskName
</td>
<td>Disk utilization rate: percentage of disk time spent reading and writing by the Elasticsearch process in the past five seconds.
<td>Disk utilization rate: percentage of disk time spent reading and writing by the Elasticsearch OSS process in the past five seconds.
</td>
</tr>
<tr>
Expand Down Expand Up @@ -545,16 +545,16 @@ ShardID | ID for the shard (e.g. `1`).
IndexName | Name of the index (e.g. `my-index`).
Operation | Type of operation (e.g. `shardbulk`).
ShardRole | `primary`, `replica`
Exception | Elasticsearch exceptions (e.g. `org.elasticsearch.index_not_found_exception`).
Exception | Elasticsearch OSS exceptions (e.g. `org.elasticsearch.index_not_found_exception`).
Indices | The list of indices in the request URI.
HTTPRespCode | Response code from Elasticsearch (e.g. `200`).
HTTPRespCode | Response code from Elasticsearch OSS (e.g. `200`).
MemType | `totYoungGC`, `totFullGC`, `Survivor`, `PermGen`, `OldGen`, `Eden`, `NonHeap`, `Heap`
DiskName | Name of the disk (e.g. `sda1`).
DestAddr | Destination address (e.g. `010015AC`).
Direction | `in`, `out`
ThreadPoolType | The Elasticsearch thread pools (e.g. `index`, `search`,`snapshot`).
CBType | `accounting`, `fielddata`, `in_flight_requests`, `parent`, `request`
MasterTaskInsertOrder | The order in which the task was inserted (e.g. `3691`).
MasterTaskPriority | Priority of the task (e.g. `URGENT`). Elasticsearch executes higher priority tasks before lower priority ones, regardless of `insert_order`.
MasterTaskPriority | Priority of the task (e.g. `URGENT`). Elasticsearch OSS executes higher priority tasks before lower priority ones, regardless of `insert_order`.
MasterTaskType | `shard-started`, `create-index`, `delete-index`, `refresh-mapping`, `put-mapping`, `CleanupSnapshotRestoreState`, `Update snapshot state`
MasterTaskMetadata | Metadata for the task (if any).
Loading