Skip to content

Commit

Permalink
[DOCS] Replace X-Pack terms with attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed May 17, 2018
1 parent 75665a2 commit 663295d
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 19 deletions.
22 changes: 11 additions & 11 deletions docs/reference/setup/install/windows.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,13 @@ part of the installation, with the option to configure a HTTPS proxy through whi
[[msi-installer-selected-plugins]]
image::images/msi_installer/msi_installer_selected_plugins.png[]

Upon choosing to install X-Pack plugin, an additional step allows a choice of the type of X-Pack
license to install, in addition to X-Pack Security configuration and built-in user configuration:
Upon choosing to install {xpack} plugin, an additional step allows a choice of the type of {xpack}
license to install, in addition to {security} configuration and built-in user configuration:

[[msi-installer-xpack]]
image::images/msi_installer/msi_installer_xpack.png[]

NOTE: X-Pack includes a choice of a Trial or Basic license for 30 days. After that, you can obtain one of the
NOTE: {xpack} includes a choice of a Trial or Basic license for 30 days. After that, you can obtain one of the
https://www.elastic.co/subscriptions[available subscriptions] or {ref}/security-settings.html[disable Security].
The Basic license is free and includes the https://www.elastic.co/products/x-pack/monitoring[Monitoring] extension.

Expand Down Expand Up @@ -286,43 +286,43 @@ as _properties_ within Windows Installer documentation) that can be passed to ms

`XPACKLICENSE`::

When installing X-Pack plugin, the type of license to install,
When installing {xpack} plugin, the type of license to install,
either `Basic` or `Trial`. Defaults to `Basic`

`XPACKSECURITYENABLED`::

When installing X-Pack plugin with a `Trial` license, whether X-Pack Security should be enabled.
When installing {xpack} plugin with a `Trial` license, whether {security} should be enabled.
Defaults to `true`

`BOOTSTRAPPASSWORD`::

When installing X-Pack plugin with a `Trial` license and X-Pack Security enabled, the password to
When installing {xpack} plugin with a `Trial` license and {security} enabled, the password to
used to bootstrap the cluster and persisted as the `bootstrap.password` setting in the keystore.
Defaults to a randomized value.

`SKIPSETTINGPASSWORDS`::

When installing X-Pack plugin with a `Trial` license and X-Pack Security enabled, whether the
When installing {xpack} plugin with a `Trial` license and {security} enabled, whether the
installation should skip setting up the built-in users `elastic`, `kibana` and `logstash_system`.
Defaults to `false`

`ELASTICUSERPASSWORD`::

When installing X-Pack plugin with a `Trial` license and X-Pack Security enabled, the password
When installing {xpack} plugin with a `Trial` license and {security} enabled, the password
to use for the built-in user `elastic`. Defaults to `""`

`KIBANAUSERPASSWORD`::

When installing X-Pack plugin with a `Trial` license and X-Pack Security enabled, the password
When installing {xpack} plugin with a `Trial` license and {security} enabled, the password
to use for the built-in user `kibana`. Defaults to `""`

`LOGSTASHSYSTEMUSERPASSWORD`::

When installing X-Pack plugin with a `Trial` license and X-Pack Security enabled, the password
When installing {xpack} plugin with a `Trial` license and {security} enabled, the password
to use for the built-in user `logstash_system`. Defaults to `""`

To pass a value, simply append the property name and value using the format `<PROPERTYNAME>="<VALUE>"` to
the installation command. For example, to use a different installation directory to the default one and to install https://www.elastic.co/products/x-pack[X-Pack]:
the installation command. For example, to use a different installation directory to the default one and to install https://www.elastic.co/products/x-pack[{xpack}]:

["source","sh",subs="attributes,callouts"]
--------------------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ the `logstash.yml` configuration file:
xpack.monitoring.elasticsearch.password: logstashpassword
----------------------------------------------------------

If you have upgraded from an older version of elasticsearch/x-pack,
If you have upgraded from an older version of Elasticsearch,
the `logstash_system` user may have defaulted to _disabled_ for security reasons.
Once the password has been changed, you can enable the user via the following API call:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public AuthenticationFailureHandler getAuthenticationFailureHandler() {
----------------------------------------------------
+
The `getAuthenticationFailureHandler` method is used to optionally provide a
custom `AuthenticationFailureHandler`, which will control how X-Pack responds
custom `AuthenticationFailureHandler`, which will control how {security} responds
in certain authentication failure events.
+
[source,java]
Expand Down
6 changes: 3 additions & 3 deletions x-pack/docs/en/security/gs-index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Security protects Elasticsearch clusters by:
To prevent unauthorized access to your Elasticsearch cluster, you must have a
way to _authenticate_ users. This simply means that you need a way to validate
that a user is who they claim to be. For example, you have to make sure only
the person named _Kelsey Andorra_ can sign in as the user `kandorra`. X-Pack
Security provides a standalone authentication mechanism that enables you to
the person named _Kelsey Andorra_ can sign in as the user `kandorra`. {security}
provides a standalone authentication mechanism that enables you to
quickly password-protect your cluster. If you're already using {xpack-ref}/ldap-realm.html[LDAP],
{xpack-ref}/active-directory-realm.html[ Active Directory], or {xpack-ref}/pki-realm.html[ PKI] to manage
users in your organization, {security} is able to integrate with those
Expand Down Expand Up @@ -83,7 +83,7 @@ issues.

* {xpack-ref}/ccs-clients-integrations.html[Integrations]
shows you how to interact with an Elasticsearch cluster protected by
X-Pack Security.
{security}.

* {xpack-ref}/security-reference.html[Reference]
provides detailed information about the access privileges you can grant to
Expand Down
6 changes: 3 additions & 3 deletions x-pack/docs/en/security/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ Security protects Elasticsearch clusters by:
To prevent unauthorized access to your Elasticsearch cluster, you must have a
way to _authenticate_ users. This simply means that you need a way to validate
that a user is who they claim to be. For example, you have to make sure only
the person named _Kelsey Andorra_ can sign in as the user `kandorra`. X-Pack
Security provides a standalone authentication mechanism that enables you to
the person named _Kelsey Andorra_ can sign in as the user `kandorra`. {security}
provides a standalone authentication mechanism that enables you to
quickly password-protect your cluster. If you're already using <<ldap-realm, LDAP>>,
<<active-directory-realm, Active Directory>>, or <<pki-realm, PKI>> to manage
users in your organization, {security} is able to integrate with those
Expand Down Expand Up @@ -81,7 +81,7 @@ issues.

* <<ccs-clients-integrations>>
shows you how to interact with an Elasticsearch cluster protected by
X-Pack Security.
{security}.

* <<security-reference, Reference>>
provides detailed information about the access privileges you can grant to
Expand Down

0 comments on commit 663295d

Please sign in to comment.