Skip to content

[6.8][DOCS] Updates Stack Overview links #50447

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

Merged
merged 3 commits into from
Dec 20, 2019
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 @@ -11,7 +11,7 @@ Delete auto-follow patterns.
==== Description

This API deletes a configured collection of
{stack-ov}/ccr-auto-follow.html[auto-follow patterns].
<<ccr-auto-follow,auto-follow patterns>>.

==== Request

Expand Down Expand Up @@ -50,7 +50,7 @@ DELETE /_ccr/auto_follow/<auto_follow_pattern_name>

If the {es} {security-features} are enabled, you must have `manage_ccr` cluster
privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges].
see <<security-privileges>>.

==== Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Get auto-follow patterns.

==== Description

This API gets configured {stack-ov}/ccr-auto-follow.html[auto-follow patterns].
This API gets configured <<ccr-auto-follow,auto-follow patterns>>.
This API will return the specified auto-follow pattern collection.

==== Request
Expand Down Expand Up @@ -66,7 +66,7 @@ GET /_ccr/auto_follow/<auto_follow_pattern_name>

If the {es} {security-features} are enabled, you must have `manage_ccr` cluster
privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges].
see <<security-privileges>>.

==== Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Creates an auto-follow pattern.
==== Description

This API creates a new named collection of
{stack-ov}/ccr-auto-follow.html[auto-follow patterns] against the remote cluster
<<ccr-auto-follow,auto-follow patterns>> against the remote cluster
specified in the request body. Newly created indices on the remote cluster
matching any of the specified patterns will be automatically configured as follower
indices.
Expand Down Expand Up @@ -73,8 +73,7 @@ include::../follow-request-body.asciidoc[]
If the {es} {security-features} are enabled, you must have `read` and `monitor`
index privileges for the leader index patterns. You must also have `manage_ccr`
cluster privileges on the cluster that contains the follower index. For more
information, see
{stack-ov}/security-privileges.html[Security privileges].
information, see <<security-privileges>>.

==== Example

Expand Down
3 changes: 1 addition & 2 deletions docs/reference/ccr/apis/follow/get-follow-info.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,7 @@ The `parameters` contains the following fields:
==== Authorization

If the {es} {security-features} are enabled, you must have `monitor` cluster
privileges. For more information, see
{stack-ov}/security-privileges.html[Security privileges].
privileges. For more information, see <<security-privileges>>.

==== Example

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ccr/apis/follow/get-follow-stats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ Continuing with the fields from `shards`:

If the {es} {security-features} are enabled, you must have `monitor` cluster
privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges].
see <<security-privileges>>.

==== Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ POST /<leader_index>/_ccr/forget_follower

If the {es} {security-features} are enabled, you must have `manage_leader_index`
index privileges for the leader index. For more information, see
{stack-ov}/security-privileges.html[Security privileges].
<<security-privileges>>.

==== Example

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ccr/apis/follow/post-pause-follow.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ POST /<follower_index>/_ccr/pause_follow

If the {es} {security-features} are enabled, you must have `manage_ccr` cluster
privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges].
see <<security-privileges>>.


==== Example
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ccr/apis/follow/post-resume-follow.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ If the {es} {security-features} are enabled, you must have `write` and `monitor`
index privileges for the follower index. You must have `read` and `monitor`
index privileges for the leader index. You must also have `manage_ccr` cluster
privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges].
see <<security-privileges>>.

==== Example

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ccr/apis/follow/post-unfollow.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ POST /<follower_index>/_ccr/unfollow

If the {es} {security-features} are enabled, you must have `manage_follow_index`
index privileges for the follower index. For more information, see
{stack-ov}/security-privileges.html[Security privileges].
<<security-privileges>>.

==== Example

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ccr/apis/follow/put-follow.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ and `manage_follow_index` index privileges for the follower index. You must have
`read` and `monitor` index privileges for the leader index. You must also have
`manage_ccr` cluster privileges on the cluster that contains the follower index.
For more information, see
{stack-ov}/security-privileges.html[Security privileges].
<<security-privileges>>.

==== Example

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ccr/apis/get-ccr-stats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ This object consists of the following fields:

If the {es} {security-features} are enabled, you must have `monitor` cluster
privileges on the cluster that contains the follower index. For more information,
see {stack-ov}/security-privileges.html[Security privileges].
see <<security-privileges>>.

==== Example

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ccr/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ to control which users have authority to manage {ccr}.
By default, you can perform all of the steps in this tutorial by
using the built-in `elastic` user. However, a password must be set for this user
before the user can do anything. For information about how to set that password,
see {stack-ov}/security-getting-started.html[Tutorial: Getting started with security].
see <<security-getting-started>>.

If you are performing these steps in a production environment, take extra care
because the `elastic` user has the `superuser` role and you could inadvertently
Expand Down
14 changes: 7 additions & 7 deletions docs/reference/commands/setup-passwords.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
== elasticsearch-setup-passwords

The `elasticsearch-setup-passwords` command sets the passwords for the
{stack-ov}/built-in-users.html[built-in users].
<<built-in-users,built-in users>>.

[float]
=== Synopsis
Expand All @@ -21,11 +21,11 @@ bin/elasticsearch-setup-passwords auto|interactive

This command is intended for use only during the initial configuration of the
{es} {security-features}. It uses the
{stack-ov}/built-in-users.html#bootstrap-elastic-passwords[`elastic` bootstrap password]
to run user management API requests. After you set a password for the `elastic`
user, the bootstrap password is no longer active and you cannot use this command.
Instead, you can change passwords by using the *Management > Users* UI in {kib}
or the <<security-api-change-password,Change Password API>>.
<<bootstrap-elastic-passwords,`elastic` bootstrap password>> to run user
management API requests. After you set a password for the `elastic` user, the
bootstrap password is no longer active and you cannot use this command. Instead,
you can change passwords by using the *Management > Users* UI in {kib} or the
<<security-api-change-password,change password API>>.

This command uses an HTTP connection to connect to the cluster and run the user
management requests. If your cluster uses TLS/SSL on the HTTP layer, the command
Expand All @@ -36,7 +36,7 @@ location, ensure that the *ES_PATH_CONF* environment variable returns the
correct path before you run the `elasticsearch-setup-passwords` command. You can
override settings in your `elasticsearch.yml` file by using the `-E` command
option. For more information about debugging connection failures, see
{stack-ov}/trb-security-setup.html[`elasticsearch-setup-passwords` command fails due to connection failure].
<<trb-security-setup,`elasticsearch-setup-passwords` command fails due to connection failure>>.

[float]
=== Parameters
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/glossary.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ current master node fails.

The {ccr} feature enables you to replicate indices in remote clusters to your
local cluster. For more information, see
{stack-ov}/xpack-ccr.html[{ccr-cap}].
{ref}/xpack-ccr.html[{ccr-cap}].

[[glossary-ccs]] {ccs} (CCS)::

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ilm/apis/delete-lifecycle.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
==== Authorization

You must have the `manage_ilm` cluster privilege to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
For more information, see <<security-privileges>>.

==== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ilm/apis/explain.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]

You must have the `view_index_metadata` or `manage_ilm` or both privileges on the indices
being managed to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
For more information, see <<security-privileges>>.

==== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ilm/apis/get-lifecycle.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
==== Authorization

You must have the `manage_ilm` or `read_ilm` or both cluster privileges to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
For more information, see <<security-privileges>>.

==== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ilm/apis/get-status.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
==== Authorization

You must have the `manage_ilm` or `read_ilm` or both cluster privileges to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
For more information, see <<security-privileges>>.

==== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ilm/apis/move-to-step.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
==== Authorization

You must have the `manage_ilm` privileges on the indices being managed to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
For more information, see <<security-privileges>>.

==== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ilm/apis/put-lifecycle.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You must have the `manage_ilm` cluster privilege to use this API. You must
also have the `manage` index privilege on all indices being managed by `policy`.
All operations executed by {ilm} for a policy are executed as the user that
put the latest version of a policy.
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
For more information, see <<security-privileges>>.

==== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ilm/apis/remove-policy-from-index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
==== Authorization

You must have the `manage_ilm` privileges on the indices being managed to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
For more information, see <<security-privileges>>.

==== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ilm/apis/retry-policy.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
==== Authorization

You must have the `manage_ilm` privileges on the indices being managed to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
For more information, see <<security-privileges>>.

==== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ilm/apis/start.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
==== Authorization

You must have the `manage_ilm` cluster privilege to use this API.
For more information, see {stack-ov}/security-privileges.html[Security privileges].
For more information, see <<security-privileges>>.

==== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ilm/apis/stop.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
==== Authorization

You must have the `manage_ilm` cluster privilege to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
For more information, see <<security-privileges>>.

==== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/intro.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ embroidery_ needles.
==== But wait, there’s more

Want to automate the analysis of your time-series data? You can use
{stack-ov}/ml-overview.html[machine learning] features to create accurate
{ml-docs}/ml-overview.html[machine learning] features to create accurate
baselines of normal behavior in your data and identify anomalous patterns. With
machine learning, you can detect:

Expand Down
7 changes: 4 additions & 3 deletions docs/reference/migration/migrate_6_3.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ distribution of {es}. You no longer need to install {xpack} separately.
==== Deprecation of the `x-pack` configuration directory

In 6.2 and earlier releases, the
{stack-ov}/security-files.html[security configuration files], such as the
<<security-files,security configuration files>>, such as the
`log4j2.properties`, `role_mapping.yml`, `roles.yml`, `users`, and `users_roles`
files, were located in an `x-pack` directory within the
<<config-files-location,config directory>>.
Expand All @@ -55,7 +55,7 @@ exist in an `x-pack` folder. That path is deprecated, however, and you should
move your files out of that folder. There is a known problem where the files in
the old path are disregarded in favor of the files in the new path:
{pull}/33688[#33688]. For more information, see
{stack-ov}/trb-security-path.html[Failures due to relocation of the configuration files].
<<trb-security-path>>.

Settings such as `files.role_mapping` now default to
`ES_PATH_CONF/role_mapping.yml`. If you do not want to use the default locations,
Expand Down Expand Up @@ -101,7 +101,8 @@ TTY (i.e., using interactive mode to accept the permissions), or by passing the

The legacy `XPackExtension` extension mechanism has been removed and replaced
with an SPI based extension mechanism that is installed and built as an
elasticsearch plugin. For more information about using SPI loaded security extensions in custom realms, see {stack-ov}/custom-realms.html[Integrating with other authentication systems].
elasticsearch plugin. For more information about using SPI loaded security
extensions in custom realms, see <<custom-realms>>.

[float]
[[breaking_63_settings_changes]]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ml/apis/calendarresource.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ A calendar resource has the following properties:
(array) An array of job identifiers. For example: `["total-requests"]`.

For more information, see
{stack-ov}/ml-calendars.html[Calendars and scheduled events].
{ml-docs}/ml-calendars.html[Calendars and scheduled events].
6 changes: 3 additions & 3 deletions docs/reference/ml/apis/datafeedresource.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A {dfeed} resource has the following properties:
(object) If set, the {dfeed} performs aggregation searches.
Support for aggregations is limited and should only be used with
low cardinality data. For more information, see
{stack-ov}/ml-configuring-aggregation.html[Aggregating data for faster performance].
{ml-docs}/ml-configuring-aggregation.html[Aggregating data for faster performance].

`chunking_config`::
(object) Specifies how data searches are split into time chunks.
Expand Down Expand Up @@ -53,7 +53,7 @@ A {dfeed} resource has the following properties:
The <<ml-detectorconfig,detector configuration objects>> in a job can contain
functions that use these script fields.
For more information, see
{stack-ov}/ml-configuring-transform.html[Transforming data with script fields].
{ml-docs}/ml-configuring-transform.html[Transforming data with script fields].

`scroll_size`::
(unsigned integer) The `size` parameter that is used in {es} searches.
Expand Down Expand Up @@ -100,7 +100,7 @@ an effort to determine whether any data has subsequently been added to the index
If missing data is found, it is a good indication that the `query_delay` option
is set too low and the data is being indexed after the {dfeed} has passed that
moment in time. See
{stack-ov}/ml-delayed-data-detection.html[Working with delayed data].
{ml-docs}/ml-delayed-data-detection.html[Working with delayed data].

This check runs only on real-time {dfeeds}.

Expand Down
4 changes: 1 addition & 3 deletions docs/reference/ml/apis/delete-expired-data.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@ associated with any job are also deleted.
==== Authorization

You must have `manage_ml`, or `manage` cluster privileges to use this API.
For more information, see
{stack-ov}/security-privileges.html[Security Privileges] and
{stack-ov}/built-in-roles.html[Built-in Roles].
For more information, see <<security-privileges>> and <<built-in-roles>>.


==== Examples
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ml/apis/delete-filter.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Deletes a filter.

==== Description

This API deletes a {stack-ov}/ml-rules.html[filter].
This API deletes a {ml-docs}/ml-rules.html[filter].
If a {ml} job references the filter, you cannot delete the filter. You must
update or delete the job before you can delete the filter.

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/ml/apis/delete-forecast.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ retention period with the `expires_in` parameter in the <<ml-forecast,forecast j

NOTE: When you delete a job its associated forecasts are deleted.

For more information, see {stack-ov}/ml-overview.html#ml-forecasting[Forecasting the Future].
For more information, see {ml-docs}/ml-overview.html#ml-forecasting[Forecasting the Future].


==== Path Parameters
Expand Down Expand Up @@ -55,7 +55,7 @@ For more information, see {stack-ov}/ml-overview.html#ml-forecasting[Forecasting
==== Authorization

You must have `manage_ml`, or `manage` cluster privileges to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
For more information, see <<security-privileges>>.

==== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ml/apis/delete-job.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ separated list.

If {es} {security-features} are enabled, you must have `manage_ml`, or `manage`
cluster privileges to use this API.
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
For more information, see <<security-privileges>>.


==== Examples
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ml/apis/eventresource.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ An events resource has the following properties:
string is in ISO 8601 format.

For more information, see
{stack-ov}/ml-calendars.html[Calendars and scheduled events].
{ml-docs}/ml-calendars.html[Calendars and scheduled events].
2 changes: 1 addition & 1 deletion docs/reference/ml/apis/filterresource.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ A filter resource has the following properties:
`items`::
(array of strings) An array of strings which is the filter item list.

For more information, see {stack-ov}/ml-rules.html[Machine learning custom rules].
For more information, see {ml-docs}/ml-rules.html[Machine learning custom rules].
Loading