honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Fix X-Pack settings for Elasticsearch (elastic/x-pack-elasticsearch#1863) 

Original commit: elastic/x-pack-elasticsearch@8469db2909
This commit is contained in:
Lisa Cawley 2017-06-27 09:14:35 -07:00 committed by GitHub
parent 7c7bf475c1
commit f2e20f86e4
6 changed files with 245 additions and 258 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/en/index.asciidoc
View File

@ -6,19 +6,6 @@
:es-test-dir: {docdir}/../../../../elasticsearch/docs/src/test
:plugins-examples-dir: {docdir}/../../../../elasticsearch/plugins/examples
:security: X-Pack security
:monitoring: X-Pack monitoring
:watcher: Watcher
:reporting: X-Pack reporting
:graph: X-Pack graph
:searchprofiler: X-Pack search profiler
:xpackml: X-Pack machine learning
:ml: machine learning
:dfeed: datafeed
:dfeeds: datafeeds
:dfeed-cap: Datafeed
:dfeeds-cap: Datafeeds
include::{es-repo-dir}/Versions.asciidoc[]
include::{es-repo-dir}/reference/index-shared1.asciidoc[]

3
docs/en/settings/configuring-xes.asciidoc
View File

@ -2,9 +2,8 @@
[[settings-xpack]]
== Configuring X-Pack
include::x-pack-settings.asciidoc
include::x-pack-settings.asciidoc[]
include::ml-settings.asciidoc[]
include::monitoring-settings.asciidoc[]
include::security-settings.asciidoc[]
include::notification-settings.asciidoc[]

7
docs/en/settings/monitoring-settings.asciidoc
View File

@ -1,5 +1,6 @@
[role="xpack"]
[[monitoring-settings]]
== Monitoring Settings
=== Monitoring Settings
Monitoring is enabled by default when you install {xpack}. You configure
<<monitoring-collection-settings, `xpack.monitoring.collection`>>
@ -17,13 +18,13 @@ For more information, see
[float]
[[general-monitoring-settings]]
=== General Monitoring Settings
==== General Monitoring Settings
`xpack.monitoring.enabled`::
Set to `false` to disable {es} {monitoring} for Elasticsearch.
[float]
[[monitoring-collection-settings]]
=== Monitoring Collection Settings
==== Monitoring Collection Settings
`xpack.monitoring.collection.cluster.state.timeout`::

16
docs/en/settings/notification-settings.asciidoc
View File

@ -1,5 +1,6 @@
[role="xpack"]
[[notification-settings]]
== {watcher} Settings
=== {watcher} Settings
You configure `xpack.notification` settings in `elasticsearch.yml` to
send set up {watcher} and send notifications via <<email-notification-settings, email>>,
@ -8,7 +9,7 @@ Slack>>, and <<pagerduty-notification-settings, PagerDuty>>.
[float]
[[general-notification-settings]]
=== General Watcher Settings
==== General Watcher Settings
`xpack.watcher.enabled`::
Set to `false` to disable {watcher}.
@ -32,7 +33,7 @@ include::ssl-settings.asciidoc[]
[float]
[[email-notification-settings]]
=== Email Notification Settings
==== Email Notification Settings
You can configure the following email notification settings in
`elasticsearch.yml`. For more information about sending notifications
via email, see {xpack-ref}/actions-email.html#configuring-email-actions[Configuring Email].
@ -132,7 +133,7 @@ Defaults to `true`.
[float]
[[hipchat-notification-settings]]
=== HipChat Notification Settings
==== HipChat Notification Settings
You can configure the following HipChat notification settings in
`elasticsearch.yml`. For more information about sending notifications
via HipChat, see {xpack-ref}/actions-hipchat.html#configuring-hipchat-actions[Configuring HipChat].
@ -181,7 +182,7 @@ via HipChat. You can specify the following HipChat account attributes:
[float]
[[slack-notification-settings]]
=== Slack Notification Settings
==== Slack Notification Settings
You can configure the following Slack notification settings in
`elasticsearch.yml`. For more information about sending notifications
via Slack, see {xpack-ref}/actions-slack.html#configuring-slack-actions[Configuring Slack].
@ -222,7 +223,7 @@ via Slack. You can specify the following Slack account attributes:
[float]
[[jira-notification-settings]]
=== Jira Notification Settings
==== Jira Notification Settings
You can configure the following Jira notification settings in
`elasticsearch.yml`. For more information about using notifications
to create issues in Jira, see {xpack-ref}/actions-jira.html#configuring-jira-actions[Configuring Jira].
@ -250,7 +251,7 @@ issues in Jira. You can specify the following Jira account attributes:
[float]
[[pagerduty-notification-settings]]
=== PagerDuty Notification Settings
==== PagerDuty Notification Settings
You can configure the following PagerDuty notification settings in
`elasticsearch.yml`. For more information about sending notifications
via PagerDuty, see {xpack-ref}/actions-pagerduty.html#configuring-pagerduty-actions[Configuring PagerDuty].
@ -295,4 +296,3 @@ via PagerDuty. You can specify the following PagerDuty account attributes:
`attach_payload`::
Whether or not to provide the watch payload as context for
the event by default. Valid values: `true`, `false`.

33
docs/en/settings/security-settings.asciidoc
View File

@ -1,5 +1,6 @@
[role="xpack"]
[[security-settings]]
== Security Settings
=== Security Settings
You configure `xpack.security` settings to
<<anonymous-access-settings, enable anonymous access>>
@ -10,14 +11,14 @@ and <<ssl-tls-settings, encrypt communications with SSL>>.
[float]
[[general-security-settings]]
=== General Security Settings
==== General Security Settings
`xpack.security.enabled`::
Set to `false` to disable {security}.
Configure in both `elasticsearch.yml` and `kibana.yml`.
[float]
[[password-security-settings]]
=== Default Password Security Settings
==== Default Password Security Settings
`xpack.security.authc.accept_default_password`::
In `elasticsearch.yml`, set this to `false` to disable support for the default "changeme" password.
For more information, see {xpack-ref}/setting-up-authentication.html#disabling-default-password[
@ -25,7 +26,7 @@ Disable Default Password Functionality].
[float]
[[anonymous-access-settings]]
=== Anonymous Access Settings
==== Anonymous Access Settings
You can configure the following anonymous access settings in
`elasticsearch.yml`. For more information, see {xpack-ref}/anonymous-access.html[
Enabling Anonymous Access].
@ -46,7 +47,7 @@ access. Defaults to `true`.
[float]
[[field-document-security-settings]]
=== Document and Field Level Security Settings
==== Document and Field Level Security Settings
You can set the following document and field level security
settings in `elasticsearch.yml`. For more information, see
@ -59,7 +60,7 @@ from being configured. Defaults to `true`.
[float]
[[token-service-settings]]
=== Token Service Settings
==== Token Service Settings
You can set the following token service settings in
`elasticsearch.yml`.
@ -78,7 +79,7 @@ The length of time that a token is valid for. By default this value is `20m` or
[float]
[[realm-settings]]
=== Realm Settings
==== Realm Settings
You configure realm settings in the `xpack.security.authc.realms`
namespace in `elasticsearch.yml`. For example:
@ -107,7 +108,7 @@ The valid settings vary depending on the realm type. For more
information, see {xpack-ref}/setting-up-authentication.html[Setting Up Authentication].
[float]
==== Settings Valid for All Realms
===== Settings Valid for All Realms
`type`::
The type of the realm: `native, `ldap`, `active_directory`, `pki`, or `file`. Required.
@ -121,7 +122,7 @@ Enable/disable the realm. Defaults to `true`.
[[ref-users-settings]]
[float]
==== File Realm Settings
===== File Realm Settings
`cache.ttl`::
The time-to-live for cached user entries--user credentials are cached for
@ -140,7 +141,7 @@ all possible values. Defaults to `ssha256`.
[[ref-ldap-settings]]
[float]
==== LDAP Realm Settings
===== LDAP Realm Settings
`url`::
An LDAP URL in the format `ldap[s]://<server>:<port>`. Required.
@ -334,7 +335,7 @@ table for all possible values). Defaults to `ssha256`.
[[ref-ad-settings]]
[float]
==== Active Directory Realm Settings
===== Active Directory Realm Settings
`url`::
A URL in the format `ldap[s]://<server>:<port>`. Defaults to `ldap://<domain_name>:389`.
@ -485,7 +486,7 @@ the in-memory cached user credentials (see {xpack-ref}/controlling-user-cache.ht
[[ref-pki-settings]]
[float]
==== PKI Realm Settings
===== PKI Realm Settings
`username_pattern`::
The regular expression pattern used to extract the username from the
@ -514,7 +515,7 @@ Defaults to `CONFIG_DIR/x-pack/role_mapping.yml`.
[float]
[[ssl-tls-settings]]
=== Default TLS/SSL Settings
==== Default TLS/SSL Settings
You can configure the following TLS/SSL settings in
`elasticsearch.yml`. For more information, see
{xpack-ref}/encrypting-communications.html[Encrypting Communications]. These settings will be used
@ -545,7 +546,7 @@ Java Cryptography Architecture documentation]. Defaults to `TLS_ECDHE_RSA_WITH_A
[float]
[[tls-ssl-key-settings]]
==== Default TLS/SSL Key and Trusted Certificate Settings
===== Default TLS/SSL Key and Trusted Certificate Settings
The following settings are used to specify a private key, certificate, and the
trusted certificates that should be used when communicating over an SSL/TLS connection.
@ -615,7 +616,7 @@ include::ssl-settings.asciidoc[]
[[ssl-tls-profile-settings]]
[float]
==== Transport Profile TLS/SSL Settings
===== Transport Profile TLS/SSL Settings
The same settings that are available for the <<transport-tls-ssl-settings, default transport>>
are also available for each transport profile. By default, the settings for a
transport profile will be the same as the default transport unless they
@ -629,7 +630,7 @@ setting, this would be `transport.profiles.$PROFILE.xpack.security.ssl.enabled`.
[float]
[[ip-filtering-settings]]
=== IP Filtering Settings
==== IP Filtering Settings
You can configure the following settings for {xpack-ref}/ip-filtering.html[IP filtering].
`xpack.security.transport.filter.allow`::

11
docs/en/settings/ssl-settings.asciidoc
View File

@ -1,5 +1,5 @@
[float]
=== {component} TLS/SSL Settings
==== {component} TLS/SSL Settings
You can configure the following TLS/SSL settings. If the settings are not configured,
the {ref}/security-settings.html#ssl-tls-settings[Default TLS/SSL Settings]
are used.
@ -39,8 +39,8 @@ Supported cipher suites can be found in Oracle's http://docs.oracle.com/javase/8
Java Cryptography Architecture documentation]. Defaults to the value of
`xpack.ssl.cipher_suites`.
[float]
==== {component} TLS/SSL Key and Trusted Certificate Settings
===== {component} TLS/SSL Key and Trusted Certificate Settings
The following settings are used to specify a private key, certificate, and the
trusted certificates that should be used when communicating over an SSL/TLS connection.
@ -54,7 +54,7 @@ authentication.
endif::server[]
If none of the settings below are specified, the {ref}/security-settings.html#ssl-tls-settings[Default TLS/SSL Settings] are used.
[float]
===== PEM Encoded Files
When using PEM encoded files, use the following settings:
@ -73,7 +73,6 @@ that will be presented when requested.
+{ssl-prefix}.ssl.certificate_authorities+::
List of paths to the PEM encoded certificate files that should be trusted.
[float]
===== Java Keystore Files
When using Java keystore files (JKS), which contain the private key, certificate