OpenSearch/marvel/docs/getting-started.asciidoc

48 lines
1.5 KiB
Plaintext
Raw Normal View History

[[getting-started]]
== Getting Started
This getting started guide walks you through installing Marvel
and using the Marvel Kibana app to monitor your Elastisearch cluster.
To install Marvel:
. Install the Marvel plugin on each node in your cluster:
.. Run `bin/plugin install` from `ES_HOME` to install the License plugin:
+
[source,shell]
----------------------------------------------------------
bin/plugin install elasticsearch/license/latest
----------------------------------------------------------
.. Run `bin/plugin install` to install the Marvel plugin.
+
[source,shell]
----------------------------------------------------------
bin/plugin install elasticsearch/marvel/latest
----------------------------------------------------------
+
NOTE: If you are using a <<package-installation, DEB/RPM distribution>> of Elasticsearch, run the installation with superuser permissions. To perform an offline installation, <<offline-installation, download the Marvel binaries>>.
.. Start Elasticsearch.
+
[source,shell]
----------------------------------------------------------
bin/elasticsearch
----------------------------------------------------------
. Install the Marvel app into Kibana.
. Run Kibana and open the Marvel app to verify the installation. You should
see an overview of your cluster's status:
+
// image:images/overview_thumb.png["Overview Dashboard",link="images/overview.png"]
Now you're ready to use Marvel to monitor and analyze your cluster! For example, you can:
*
*