Skip to content

Commit

Permalink
Asciidoctor migration (elastic#12006)
Browse files Browse the repository at this point in the history
* Change tagging to work with asciidoctor

* Fix formatting issues

* Changes from review
  • Loading branch information
dedemorton authored May 2, 2019
1 parent bf95ab7 commit 00ba9e2
Show file tree
Hide file tree
Showing 14 changed files with 98 additions and 62 deletions.
4 changes: 2 additions & 2 deletions docs/devguide/migrate-dashboards.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@ dashboards:
Using the yml file, you can export all the dashboards for a single module or for the entire Beat using a single command:

[source,shell]
------------------
----
cd metricbeat/module/system
go run ../../../dev-tools/cmd/dashboards/export_dashboards.go -yml module.yml
-------------------
----

12 changes: 6 additions & 6 deletions docs/devguide/newdashboards.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The `setup` phase loads:
For more details about the `setup` command, run the following:

[source,shell]
-------------------------
----
./metricbeat help setup
This command does initial setup of the environment:
Expand All @@ -73,15 +73,15 @@ Flags:
--machine-learning Setup machine learning job configurations only
--modules string List of enabled modules (comma separated)
--template Setup index template only
---------------------------
----

The flags are useful when you don't want to load everything. For example, to
import only the dashboards, use the `--dashboards` flag:

[source,shell]
---------------------
----
./metricbeat setup --dashboards
-------------------------------
----

Starting with Beats 6.0.0, the dashboards are no longer loaded directly into Elasticsearch. Instead, they are imported directly into Kibana.
Thus, if your Kibana instance is not listening on localhost, or you enabled
Expand All @@ -90,9 +90,9 @@ the config for the Beat, or pass the Kibana host and credentials as
arguments to the `setup` command. For example:

[source,shell]
-------------------------
----
./metricbeat setup -E setup.kibana.host=192.168.3.206:5601 -E setup.kibana.username=elastic -E setup.kibana.password=secret
--------------------------
----

By default, the `setup` command imports the dashboards from the `kibana`
directory, which is available in the Beat package.
Expand Down
6 changes: 6 additions & 0 deletions filebeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:has_ml_jobs: yes
:has_central_config:
:has_solutions:
:ignores_max_retries:
:has_docker_label_ex:
:has_decode_csv_fields_processor:
:has_script_processor:
:has_modules_command:
:has_registry:
:deb_os:
:rpm_os:
:mac_os:
Expand Down
2 changes: 2 additions & 0 deletions journalbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:github_repo_name: beats
:discuss_forum: beats/{beatname_lc}
:beat_default_index_prefix: {beatname_lc}
:has_decode_csv_fields_processor:
:has_script_processor:
:deb_os:
:rpm_os:
:linux_os:
Expand Down
16 changes: 8 additions & 8 deletions libbeat/docs/command-reference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -82,31 +82,31 @@ endif::[]
[options="header"]
|=======================
|Commands |
ifeval::[("{beatname_lc}"=="functionbeat")]
ifeval::["{beatname_lc}"=="functionbeat"]
|<<deploy-command,`deploy`>> | {deploy-command-short-desc}.
endif::[]
|<<export-command,`export`>> |{export-command-short-desc}.
|<<help-command,`help`>> |{help-command-short-desc}.
|<<keystore-command,`keystore`>> |{keystore-command-short-desc}.
ifeval::[("{beatname_lc}"=="functionbeat")]
ifeval::["{beatname_lc}"=="functionbeat"]
|<<package-command,`package`>> |{package-command-short-desc}.
|<<remove-command,`remove`>> |{remove-command-short-desc}.
endif::[]
ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="metricbeat")]
ifdef::has_modules_command[]
|<<modules-command,`modules`>> |{modules-command-short-desc}.
endif::[]
|<<run-command,`run`>> |{run-command-short-desc}.
|<<setup-command,`setup`>> |{setup-command-short-desc}.
|<<test-command,`test`>> |{test-command-short-desc}.
ifeval::[("{beatname_lc}"=="functionbeat")]
ifeval::["{beatname_lc}"=="functionbeat"]
|<<update-command,`update`>> |{update-command-short-desc}.
endif::[]
|<<version-command,`version`>> |{version-command-short-desc}.
|=======================

Also see <<global-flags,Global flags>>.

ifeval::[("{beatname_lc}"=="functionbeat")]
ifeval::["{beatname_lc}"=="functionbeat"]
[[deploy-command]]
==== `deploy` command

Expand Down Expand Up @@ -325,7 +325,7 @@ Shows help for the `keystore` command.

See <<keystore>> for more examples.

ifeval::[("{beatname_lc}"=="functionbeat")]
ifeval::["{beatname_lc}"=="functionbeat"]
[[package-command]]
==== `package` command

Expand Down Expand Up @@ -387,7 +387,7 @@ Shows help for the `remove` command.
-----
endif::[]

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="metricbeat")]
ifdef::has_modules_command[]
[[modules-command]]
==== `modules` command

Expand Down Expand Up @@ -730,7 +730,7 @@ ifeval::["{beatname_lc}"=="metricbeat"]
-----
endif::[]

ifeval::[("{beatname_lc}"=="functionbeat")]
ifeval::["{beatname_lc}"=="functionbeat"]
[[update-command]]
==== `update` command

Expand Down
32 changes: 8 additions & 24 deletions libbeat/docs/outputconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -462,21 +462,17 @@ endif::[]

===== `max_retries`

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="winlogbeat")]

ifdef::ignores_max_retries[]
{beatname_uc} ignores the `max_retries` setting and retries indefinitely.

endif::[]

ifeval::[("{beatname_lc}"!="filebeat") and ("{beatname_lc}"!="winlogbeat")]

ifndef::ignores_max_retries[]
The number of times to retry publishing an event after a publishing failure.
After the specified number of retries, the events are typically dropped.

Set `max_retries` to a value less than 0 to retry until all events are published.

The default is 3.

endif::[]


Expand Down Expand Up @@ -729,21 +725,17 @@ The number of seconds to wait for responses from the Logstash server before timi

===== `max_retries`

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="winlogbeat")]

ifdef::ignores_max_retries[]
{beatname_uc} ignores the `max_retries` setting and retries indefinitely.

endif::[]

ifeval::[("{beatname_lc}"!="filebeat") and ("{beatname_lc}"!="winlogbeat")]

ifndef::ignores_max_retries[]
The number of times to retry publishing an event after a publishing failure.
After the specified number of retries, the events are typically dropped.

Set `max_retries` to a value less than 0 to retry until all events are published.

The default is 3.

endif::[]

===== `bulk_max_size`
Expand Down Expand Up @@ -965,21 +957,17 @@ metadata for the configured topics. The default is true.

===== `max_retries`

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="winlogbeat")]

ifdef::ignores_max_retries[]
{beatname_uc} ignores the `max_retries` setting and retries indefinitely.

endif::[]

ifeval::[("{beatname_lc}"!="filebeat") and ("{beatname_lc}"!="winlogbeat")]

ifndef::ignores_max_retries[]
The number of times to retry publishing an event after a publishing failure.
After the specified number of retries, the events are typically dropped.

Set `max_retries` to a value less than 0 to retry until all events are published.

The default is 3.

endif::[]

===== `bulk_max_size`
Expand Down Expand Up @@ -1225,21 +1213,17 @@ Redis after a network error. The default is 60s.

===== `max_retries`

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="winlogbeat")]

ifdef::ignores_max_retries[]
{beatname_uc} ignores the `max_retries` setting and retries indefinitely.

endif::[]

ifeval::["{beatname_lc}"!="filebeat" and "{beatname_lc}"!="winlogbeat"]

ifndef::ignores_max_retries[]
The number of times to retry publishing an event after a publishing failure.
After the specified number of retries, the events are typically dropped.

Set `max_retries` to a value less than 0 to retry until all events are published.

The default is 3.

endif::[]


Expand Down
14 changes: 9 additions & 5 deletions libbeat/docs/processors-using.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,11 @@ ifeval::["{beatname_lc}"=="filebeat"]
:processor-scope: input
endif::[]

ifeval::["{beatname_lc}"=="auditbeat" or "{beatname_lc}"=="metricbeat"]
ifeval::["{beatname_lc}"=="auditbeat"]
:processor-scope: module
endif::[]

ifeval::["{beatname_lc}"=="metricbeat"]
:processor-scope: module
endif::[]

Expand Down Expand Up @@ -205,7 +209,7 @@ The supported processors are:
* <<add-process-metadata,`add_process_metadata`>>
* <<add-tags, `add_tags`>>
* <<community-id,`community_id`>>
ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="journalbeat")]
ifdef::has_decode_csv_fields_processor[]
* <<decode-csv-fields,`decode_csv_fields`>>
endif::[]
* <<decode-json-fields,`decode_json_fields`>>
Expand All @@ -215,7 +219,7 @@ endif::[]
* <<drop-fields,`drop_fields`>>
* <<include-fields,`include_fields`>>
* <<rename-fields,`rename`>>
ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="winlogbeat") or ("{beatname_lc}"=="journalbeat")]
ifdef::has_script_processor[]
* <<processor-script,`script`>>
endif::[]

Expand Down Expand Up @@ -779,7 +783,7 @@ Adds the environment field to every event:
}
-------------------------------------------------------------------------------

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="journalbeat")]
ifdef::has_decode_csv_fields_processor[]
[[decode-csv-fields]]
=== Decode CSV fields

Expand Down Expand Up @@ -1525,7 +1529,7 @@ set to `true`, this condition will be ignored.
output, to avoid leaking sensitive data. If `restricted_fields` is `true`, the
field will be present in the output.

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="winlogbeat") or ("{beatname_lc}"=="journalbeat")]
ifdef::has_script_processor[]
[[processor-script]]
=== Script Processor

Expand Down
1 change: 1 addition & 0 deletions libbeat/docs/security/securing-beats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
[[securing-beats]]
== Configure {beatname_uc} to use {security}

[subs="attributes"]
++++
<titleabbrev>Use {security}</titleabbrev>
++++
Expand Down
2 changes: 1 addition & 1 deletion libbeat/docs/shared-central-management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ ifndef::no_dashboards[]
<<load-kibana-dashboards,load the dashboards>> before enrolling the
Beat.
endif::[]
ifeval::[("{beatname_lc}"=="filebeat")]
ifeval::["{beatname_lc}"=="filebeat"]
* If you plan to define module configurations in central management, set up the
ingest pipelines before enrolling the Beat. For more information, see
<<load-ingest-pipelines>>.
Expand Down
Loading

0 comments on commit 00ba9e2

Please sign in to comment.