Skip to content

Commit

Permalink
Align with beats, use deprecated.
Browse files Browse the repository at this point in the history
  • Loading branch information
simitt committed Jul 23, 2018
1 parent c924c06 commit df8223c
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 34 deletions.
4 changes: 2 additions & 2 deletions docs/configuring.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ The following topics describe how to configure APM Server:
* <<configuration-ssl>>
* <<configuration-template>>
* <<configuration-logging>>
* <<setup-kibana-endpoint, Set up the Kibana endpoint (deprecated)>>
* <<configuration-dashboards, Load the Kibana dashboards (deprecated)>>
* <<setup-kibana-endpoint>>
* <<configuration-dashboards>>
* <<configuration-rum>>
* <<using-environ-vars>>
* <<configuration-path>>
Expand Down
23 changes: 9 additions & 14 deletions docs/copied-from-beats/command-reference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@ endif::[]

ifdef::deprecate_dashboard_loading[]

:setup-command-short-desc: Sets up the initial environment,
including the ES index template and Kibana dashboards (deprecated).
:setup-command-short-desc: Sets up the initial environment, including the ES index template and Kibana dashboards (deprecated).

endif::[]

Expand Down Expand Up @@ -409,25 +408,21 @@ the end of the file is reached. By default harvesters are closed after

endif::[]

ifndef::deprecate_dashboard_loading[]
*`--setup`*::
endif::[]

ifdef::deprecate_dashboard_loading[]
*`--setup (deprecated)`*::
deprecated[{deprecate_dashboard_loading}]
endif::[]

+
ifdef::has_ml_jobs[]
Loads the initial setup, including Elasticsearch template, Kibana index pattern,
Kibana dashboards and Machine learning jobs.
endif::[]

ifndef::has_ml_jobs[]
Loads the initial setup, including Elasticsearch template, Kibana index pattern and Kibana dashboards.
endif::[]

If you want to use the command without running {beatname_uc}, use the <<setup-command,`setup`>> command instead.


ifeval::["{beatname_lc}"=="metricbeat"]

*`--system.hostfs MOUNT_POINT`*::
Expand Down Expand Up @@ -465,15 +460,12 @@ Or:
[[setup-command]]
==== `setup` command

{setup-command-short-desc}.
{setup-command-short-desc}

* The index template ensures that fields are mapped correctly in Elasticsearch.

* The Kibana dashboards make it easier for you to visualize {beatname_uc} data
in Kibana.
ifdef::deprecate_dashboard_loading[]
(deprecated)
endif::[]

ifdef::has_ml_jobs[]
* The machine learning jobs contain the configuration information and metadata
Expand Down Expand Up @@ -502,7 +494,10 @@ in the _Beats Developer Guide_.
endif::[]

ifdef::deprecate_dashboard_loading[]
*`--dashboards` (deprecated)*::
*`--dashboards`*::

deprecated[{deprecate_dashboard_loading}]
+
Sets up the Kibana dashboards only.
endif::[]

Expand Down
7 changes: 3 additions & 4 deletions docs/copied-from-beats/dashboardsconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,11 @@
//////////////////////////////////////////////////////////////////////////

[[configuration-dashboards]]
ifndef::deprecate_dashboard_loading[]
== Load the Kibana dashboards
endif::[]

ifdef::deprecate_dashboard_loading[]
== Load the Kibana dashboards (deprecated)

deprecated[{deprecate_dashboard_loading}]

endif::[]

{beatname_uc} comes packaged with example Kibana dashboards, visualizations,
Expand Down
7 changes: 1 addition & 6 deletions docs/copied-from-beats/outputconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -218,17 +218,12 @@ The index name to write events to. The default is
need to configure the `setup.template.name` and `setup.template.pattern` options
(see <<configuration-template>>).

ifndef::deprecate_dashboard_loading[]

If you are using the pre-built Kibana dashboards,
you also need to set the `setup.dashboards.index` option (see <<configuration-dashboards>>).

endif::[]

ifdef::deprecate_dashboard_loading[]

If you are using the pre-built Kibana dashboards,
you also need to set the index pattern properly when loading the dashboards via the Kibana UI.
deprecated[{deprecate_dashboard_loading}]

endif::[]

Expand Down
7 changes: 3 additions & 4 deletions docs/copied-from-beats/shared-kibana-config.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,12 @@
//////////////////////////////////////////////////////////////////////////

[[setup-kibana-endpoint]]
ifndef::deprecate_dashboard_loading[]
== Set up the Kibana endpoint
endif::[]
ifdef::deprecate_dashboard_loading[]
== Set up the Kibana endpoint (deprecated)
endif::[]

deprecated[{deprecate_dashboard_loading}]

endif::[]

ifeval::["{beatname_lc}" == "apm-server"]
The Kibana dashboards are loaded into Kibana via the Kibana API.
Expand Down
6 changes: 3 additions & 3 deletions docs/dashboards.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@

From APM Server and Kibana 6.4 on you can load dashboards directly via the Kibana UI.

NOTE: Loading index pattern and dashboards through the APM Server is deprecated.
It is recommended to use the Kibana UI instead.
==== Setup via APM Server

deprecated[{deprecate_dashboard_loading}]

==== Setup via APM Server (deprecated)
Loading via APM Server requires a <<setup-kibana-endpoint,Kibana endpoint configuration>>.
If you are accessing a secured Kibana instance, make sure you've configured credentials.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:logstashdoc: https://www.elastic.co/guide/en/logstash/{doc-branch}
:elasticsearch: https://www.elastic.co/guide/en/elasticsearch/reference/{doc-branch}
:securitydoc: https://www.elastic.co/guide/en/elastic-stack-overview/{doc-branch}
:deprecate_dashboard_loading: true
:deprecate_dashboard_loading: 6.4.0

ifdef::env-github[]
NOTE: For the best reading experience,
Expand Down

0 comments on commit df8223c

Please sign in to comment.