Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Creates Getting Started book #110

Merged
merged 3 commits into from
Aug 31, 2018
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
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ laptop.
IMPORTANT: Implementing security is a critical step in setting up the {stack}.
To get up and running quickly with a sample installation, you skip those steps
right now. Before sending sensitive data across the network, make sure you
<<elasticsearch-security,secure the stack>> and enable
<<encrypting-communications,encrypted communications>>.
{stack-ov}/elasticsearch-security.html[secure the {stack}] and enable
{stack-ov}/encrypting-communications.html[encrypted communications].

[float]
[[install-prereqs]]
Expand Down Expand Up @@ -864,8 +864,8 @@ how to use {ls} to filter events collected by {metricbeat}.
Next, you'll want to set up {security} and activate your trial license so
you can unlock the full capabilities of the {stack}. To learn how, read:

* <<elasticsearch-security,Securing the {stack}>>
* <<license-management,License Management>>
* {stack-ov}/elasticsearch-security.html[Securing the {stack}]
* {stack-ov}/license-management.html[License Management]

Later, when you're ready to set up a production environment, also see the
{stack-ref}/installing-elastic-stack.html[{stack} Installation and Upgrade
Expand Down
20 changes: 20 additions & 0 deletions docs/en/getting-started/index.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
= Getting Started

:doctype: book

:forum: https://discuss.elastic.co/c/x-pack
:security-forum: https://discuss.elastic.co/c/shield
:watcher-forum: https://discuss.elastic.co/c/watcher
:monitoring-forum: https://discuss.elastic.co/c/marvel
:graph-forum: https://discuss.elastic.co/c/graph

:blog-ref: https://www.elastic.co/blog/
:wikipedia: https://en.wikipedia.org/wiki

:kib-repo-dir: {docdir}/../../../../kibana/docs
:xes-repo-dir: {docdir}/../../../../elasticsearch/x-pack/docs/en

include::{asciidoc-dir}/../../shared/versions.asciidoc[]
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]

include::get-started-stack.asciidoc[]
5 changes: 3 additions & 2 deletions docs/en/stack/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]

include::introduction.asciidoc[]

include::getting-started/get-started-stack.asciidoc[]

:edit_url: https://github.com/elastic/stack-docs/edit/{branch}/docs/en/stack/security/index.asciidoc
include::security/index.asciidoc[]

Expand All @@ -41,3 +39,6 @@ include::limitations.asciidoc[]

:edit_url:
include::license.asciidoc[]

:edit_url:
include::redirects.asciidoc[]
2 changes: 1 addition & 1 deletion docs/en/stack/introduction.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ For a quick overview, see: https://www.elastic.co/products
[float]
=== Where to Go Next

* <<get-started-elastic-stack, Getting started with the {stack}>>
* {stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}]
* <<security-getting-started, Getting Started with Security>>
* <<xpack-monitoring, Getting Started with Monitoring>>
* <<watcher-getting-started, Getting Started with Alerting and Notification>>
Expand Down
5 changes: 3 additions & 2 deletions docs/en/stack/ml/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ data:
[[ml-gs-sysoverview]]
=== Before you begin

. Install {es} and {kib}. You can follow the steps in <<get-started-elastic-stack>>.
. Install {es} and {kib}. You can follow the steps in
{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}].
{es} stores the data and the analysis results. {kib} provides a helpful user
interface for creating and viewing jobs.
+
Expand All @@ -42,7 +43,7 @@ example, http://127.0.0.1:5601[http://127.0.0.1:5601].
. Obtain a license that includes the {ml} features.
+
--
include::{docdir}/getting-started/get-started-trial.asciidoc[]
include::{docdir}/get-started-trial.asciidoc[]
--

. If {security} is enabled in your cluster, you need a user that has appropriate
Expand Down
12 changes: 12 additions & 0 deletions docs/en/stack/redirects.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
["appendix",role="exclude",id="redirects"]
= Deleted pages

The following pages have moved or been deleted.


[role="exclude",id="get-started-elastic-stack"]
=== Getting started with the Elastic Stack

See {stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}].


14 changes: 9 additions & 5 deletions docs/en/stack/security/get-started-security.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ roles in {es}, {kib}, {ls}, and {metricbeat}.
=== Before you begin

. Install and configure {es}, {kib}, {ls}, and {metricbeat} as described in
<<get-started-elastic-stack>>.
{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}].

. Stop {ls}. The method for starting and stopping {ls} varies depending on whether
you are running it from the command line or running it as a service. For example,
Expand All @@ -28,7 +28,7 @@ example, http://127.0.0.1:5601[http://127.0.0.1:5601].
[[get-started-license]]
=== Install a trial license

include::{docdir}/getting-started/get-started-trial.asciidoc[]
include::{docdir}/get-started-trial.asciidoc[]

[role="xpack"]
[[get-started-enable-security]]
Expand Down Expand Up @@ -114,7 +114,8 @@ choose a role yet--we'll come back to that in subsequent steps.
. Click *Create user* and create a `logstash_internal` user.
+
--
In <<get-started-elastic-stack>>, you configured {ls} to listen for {metricbeat}
In {stack-gs}/get-started-elastic-stack.html[Geting started with the {stack}],
you configured {ls} to listen for {metricbeat}
input and to send the events to {es}. You therefore need to create a user
that {ls} can use to communicate with {es}. For example:

Expand Down Expand Up @@ -154,7 +155,8 @@ image::security/images/assign-role.jpg["Assigning a role to a user in Kibana"]

This user now has the minimum privileges required to use {kib}.

If you completed all of the steps in <<get-started-elastic-stack>>, you should
If you completed all of the steps in
{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}], you should
have {metricbeat} data stored in {es}. Let's create two roles that grant
different levels of access to that data.

Expand Down Expand Up @@ -285,7 +287,9 @@ To start {ls} as a service, see

. If you were connecting directly from {metricbeat} to {es}, you would need
to configure authentication credentials for the {es} output in the {metricbeat}
configuration file. In <<get-started-elastic-stack>>, however, you configured
configuration file. In
{stack-gs}/get-started-elastic-stack.html[Getting started with the {stack}],
however, you configured
{metricbeat} to send the data to {ls} for additional parsing, so no extra
settings are required in {metricbeat}. For more information, see
{metricbeat-ref}/securing-metricbeat.html[Securing {metricbeat}].
Expand Down