OpenSearch/marvel/docs/getting-started.asciidoc
uboness a4c505ceb1 Changed the Marvel module name to Marvel Agent
- this results in a `marvel-agent-2.0.0.zip` artifact, to better differentiate it from the kibana marvel plugin
- post 2.0 when we move the marvel kibana codebase to x-plugins we'll need to differentiate between these two modules anyway.

Closes elastic/elasticsearch#846

Original commit: elastic/x-pack-elasticsearch@6b6a76f7dd
2015-10-21 14:03:23 +02:00

48 lines
1.4 KiB
Plaintext

[[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 license
----------------------------------------------------------
.. Run `bin/plugin install` to install the Marvel plugin.
+
[source,shell]
----------------------------------------------------------
bin/plugin install marvel-agent
----------------------------------------------------------
+
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:
*
*