瀏覽代碼

[DOCS] Update alias xrefs (#73380)

Updates several internal 'alias' xrefs to point to the aliases guide rather than
API docs.
James Rodewig 4 年之前
父節點
當前提交
39a0314d30

+ 3 - 4
docs/reference/data-streams/data-streams.asciidoc

@@ -120,10 +120,9 @@ documents directly to a data stream. Instead, use the
 If needed, you can <<update-delete-docs-in-a-backing-index,update or delete
 documents>> by submitting requests directly to the document's backing index.
 
-TIP: If you frequently update or delete existing documents, use an
-<<indices-add-alias,index alias>> and <<index-templates,index template>>
-instead of a data stream. You can still use
-<<index-lifecycle-management,{ilm-init}>> to manage indices for the alias.
+TIP: If you frequently update or delete existing time series data, use an index
+alias with a write index instead of a data stream. See
+<<manage-time-series-data-without-data-streams>>.
 
 include::set-up-a-data-stream.asciidoc[]
 include::use-a-data-stream.asciidoc[]

+ 4 - 4
docs/reference/data-streams/set-up-a-data-stream.asciidoc

@@ -256,10 +256,10 @@ For an example, see <<data-stream-privileges>>.
 === Convert an index alias to a data stream
 
 // tag::time-series-alias-tip[]
-Prior to {es} 7.9, you would typically use an <<indices-aliases,index alias>>
-with a write index to manage time series data. Data streams replace this
-functionality, require less maintenance, and automatically integrate with
-<<data-tiers,data tiers>>.
+Prior to {es} 7.9, you'd typically use an
+<<manage-time-series-data-without-data-streams,index alias with a write index>>
+to manage time series data. Data streams replace this functionality, require
+less maintenance, and automatically integrate with <<data-tiers,data tiers>>.
 // end::time-series-alias-tip[]
 
 To convert an index alias with a write index to a data stream with the same

+ 1 - 2
docs/reference/docs/bulk.asciidoc

@@ -238,8 +238,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pipeline]
 include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh]
 
 `require_alias`::
-(Optional, Boolean)
-If `true`, the request's actions must target an <<indices-aliases,index alias>>.
+(Optional, Boolean) If `true`, the request's actions must target an index alias.
 Defaults to `false`.
 
 include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing]

+ 8 - 11
docs/reference/eql/eql-search-api.asciidoc

@@ -57,12 +57,9 @@ See <<eql-syntax-limitations,EQL limitations>>.
 ==== {api-path-parms-title}
 
 `<target>`::
-(Required, string)
-Comma-separated list of data streams, indices, or <<indices-aliases,index
-aliases>> used to limit the request. Accepts wildcard (`*`) expressions.
-+
-To search all data streams and indices in a cluster, use
-`_all` or `*`.
+(Required, string) Comma-separated list of data streams, indices, or aliases
+used to limit the request. Supports wildcards (`*`). To search all data streams
+and indices, use `*` or `_all`.
 
 [[eql-search-api-query-params]]
 ==== {api-query-parms-title}
@@ -73,11 +70,11 @@ To search all data streams and indices in a cluster, use
 NOTE: This parameter's behavior differs from the `allow_no_indices` parameter
 used in other <<multi-index,multi-target APIs>>.
 +
-If `false`, the request returns an error if any wildcard expression,
-<<indices-aliases,index alias>>, or `_all` value targets only missing or closed
-indices. This behavior applies even if the request targets other open indices.
-For example, a request targeting `foo*,bar*` returns an error if an index
-starts with `foo` but no index starts with `bar`.
+If `false`, the request returns an error if any wildcard pattern, alias, or
+`_all` value targets only missing or closed indices. This behavior applies even
+if the request targets other open indices. For example, a request targeting
+`foo*,bar*` returns an error if an index starts with `foo` but no index starts
+with `bar`.
 +
 If `true`, only requests that exclusively target missing or closed indices
 return an error. For example, a request targeting `foo*,bar*` does not return an

+ 5 - 5
docs/reference/ilm/actions/ilm-rollover.asciidoc

@@ -12,12 +12,12 @@ policy execution waits until the leader index rolls over (or is
 then converts the follower index into a regular index with the
 <<ilm-unfollow, Unfollow action>>.
 
-A rollover target can be a <<data-streams, data stream>> or an <<indices-aliases, index alias>>.
-When targeting a data stream, the new index becomes the data stream's
-<<data-stream-write-index,write index>> and its generation is incremented.
+A rollover target can be a <<data-streams, data stream>> or an <<alias,index
+alias>>. When targeting a data stream, the new index becomes the data stream's
+write index and its generation is incremented.
 
-To roll over an <<indices-aliases, index alias>>, the alias and its write index
-must meet the following conditions:
+To roll over an index alias, the alias and its write index must meet the
+following conditions:
 
 * The index name must match the pattern '^.*-\\d+$', for example (`my-index-000001`).
 * The `index.lifecycle.rollover_alias` must be configured as the alias to roll over.

+ 1 - 1
docs/reference/ilm/ilm-skip-rollover.asciidoc

@@ -25,7 +25,7 @@ previously-indexed data in accordance with your configured policy, you can:
 . Create a template for the new index pattern that uses the same policy. 
 . Bootstrap the initial index.
 . Change the write index for the alias to the bootstrapped index 
-using the <<indices-aliases, index aliases>> API.
+using the <<indices-aliases,aliases API>>.
 . Set `index.lifecycle.indexing_complete` to `true` on the old index to indicate 
 that it does not need to be rolled over.
 

+ 3 - 2
docs/reference/ilm/index-rollover.asciidoc

@@ -27,8 +27,9 @@ Each data stream requires an <<index-templates,index template>> that contains:
 
 Data streams are designed for append-only data, where the data stream name
 can be used as the operations (read, write, rollover, shrink etc.) target.
-If your use case requires data to be updated in place, you can instead manage your time series data using <<indices-aliases, indices aliases>>. However, there are a few more configuration steps and
-concepts:
+If your use case requires data to be updated in place, you can instead manage
+your time series data using <<alias,index aliases>>. However, there are a few
+more configuration steps and concepts:
 
 * An _index template_ that specifies the settings for each new index in the series.
 You optimize this configuration for ingestion, typically using as many shards as you have hot nodes.

+ 1 - 1
docs/reference/indices/create-index.asciidoc

@@ -182,7 +182,7 @@ PUT /test
 [[create-index-aliases]]
 ===== Aliases
 
-The create index API allows also to provide a set of <<indices-aliases,aliases>>:
+The create index API allows also to provide a set of <<alias,aliases>>:
 
 [source,console]
 --------------------------------------------------

+ 1 - 1
docs/reference/indices/delete-index-template.asciidoc

@@ -49,7 +49,7 @@ privilege>> to use this API.
 
 Use the delete index template API to delete one or more index templates.
 Index templates define <<index-modules-settings,settings>>, <<mapping,mappings>>,
-and <<indices-aliases,aliases>> that can be applied automatically to new indices.
+and <<alias,aliases>> that can be applied automatically to new indices.
 
 
 [[delete-template-api-path-params]]

+ 1 - 1
docs/reference/indices/delete-index.asciidoc

@@ -34,7 +34,7 @@ or `manage` <<privileges-list-indices,index privilege>> for the target index.
 delete.
 
 In this parameter, wildcard expressions match only open, concrete indices. You
-cannot delete an index using an <<indices-aliases,alias>>.
+cannot delete an index using an <<alias,alias>>.
 
 By default, you must explicitly name the indices you are deleting.
 To specify indices to delete with `_all`, `*`, or other wildcard

+ 1 - 1
docs/reference/indices/index-template-exists-v1.asciidoc

@@ -38,7 +38,7 @@ Use the index template exists API
 to determine whether one or more index templates exist.
 
 Index templates define <<index-modules-settings,settings>>, <<mapping,mappings>>, 
-and <<indices-aliases,aliases>> that can be applied automatically to new indices. 
+and <<alias,aliases>> that can be applied automatically to new indices. 
 
 [[template-exists-api-path-params]]
 ==== {api-path-parms-title}

+ 1 - 1
docs/reference/indices/migrate-to-data-stream.asciidoc

@@ -5,7 +5,7 @@
 <titleabbrev>Migrate to data stream</titleabbrev>
 ++++
 
-Converts an <<indices-aliases,index alias>> to a <<data-streams,data stream>>.
+Converts an <<alias,index alias>> to a <<data-streams,data stream>>.
 
 ////
 [source,console]

+ 5 - 5
docs/reference/indices/put-component-template.asciidoc

@@ -4,10 +4,10 @@
 <titleabbrev>Create or update component template</titleabbrev>
 ++++
 
-Creates or updates a component template.
-Component templates are building blocks for constructing <<index-templates,index templates>>
-that specify index <<mapping,mappings>>, <<index-modules-settings,settings>>,
-and <<indices-aliases,aliases>>.
+Creates or updates a component template. Component templates are building blocks
+for constructing <<index-templates,index templates>> that specify index
+<<mapping,mappings>>, <<index-modules-settings,settings>>, and
+<<alias,aliases>>.
 
 [source,console]
 --------------------------------------------------
@@ -160,7 +160,7 @@ This map is not automatically generated by {es}.
 
 ===== Component template with index aliases
 
-You can include <<indices-aliases,index aliases>> in a component template.
+You can include <<alias,index aliases>> in a component template.
 
 [source,console]
 --------------------------------------------------

+ 1 - 1
docs/reference/indices/put-index-template-v1.asciidoc

@@ -140,7 +140,7 @@ This number is not automatically generated by {es}.
 
 ===== Index template with index aliases
 
-You can include <<indices-aliases,index aliases>> in an index template.
+You can include <<alias,index aliases>> in an index template.
 
 [source,console]
 --------------------------------------------------

+ 4 - 4
docs/reference/indices/put-index-template.asciidoc

@@ -4,9 +4,9 @@
 <titleabbrev>Create or update index template</titleabbrev>
 ++++
 
-Creates or updates an index template.
-Index templates define <<index-modules-settings,settings>>, <<mapping,mappings>>, 
-and <<indices-aliases,aliases>> that can be applied automatically to new indices. 
+Creates or updates an index template. Index templates define
+<<index-modules-settings,settings>>, <<mapping,mappings>>, and <<alias,aliases>>
+that can be applied automatically to new indices. 
 
 [source,console]
 --------------------------------------------------
@@ -156,7 +156,7 @@ This number is not automatically generated by {es}.
 
 ===== Index template with index aliases
 
-You can include <<indices-aliases,index aliases>> in an index template.
+You can include <<alias,index aliases>> in an index template.
 
 [source,console]
 --------------------------------------------------

+ 1 - 2
docs/reference/indices/rollover-index.asciidoc

@@ -4,8 +4,7 @@
 <titleabbrev>Rollover</titleabbrev>
 ++++
 
-Creates a new index for a <<data-streams,data stream>> or
-<<indices-add-alias,index alias>>.
+Creates a new index for a <<data-streams,data stream>> or <<alias,index alias>>.
 
 [source,console]
 ----

+ 10 - 12
docs/reference/rest-api/common-parms.asciidoc

@@ -25,19 +25,18 @@ end::index-alias[]
 
 tag::aliases[]
 `aliases`::
-(Optional, <<indices-aliases,alias object>>) <<indices-aliases,Index aliases>>
-which include the index. Index alias names support <<date-math-index-names,date
-math>>.
+(Optional, <<alias,alias object>>) Index aliases which include the index. Index
+alias names support <<date-math-index-names,date math>>.
 end::aliases[]
 
 tag::allow-no-indices[]
 `allow_no_indices`::
 (Optional, Boolean)
 If `false`, the request returns an error if any wildcard expression,
-<<indices-aliases,index alias>>, or `_all` value targets only missing or closed
-indices. This behavior applies even if the request targets other open indices.
-For example, a request targeting `foo*,bar*` returns an error if an index
-starts with `foo` but no index starts with `bar`.
+<<alias,index alias>>, or `_all` value targets only missing or closed indices.
+This behavior applies even if the request targets other open indices. For
+example, a request targeting `foo*,bar*` returns an error if an index starts
+with `foo` but no index starts with `bar`.
 end::allow-no-indices[]
 
 tag::allow-no-match-transforms1[]
@@ -608,15 +607,14 @@ end::memory[]
 tag::bulk-require-alias[]
 `require_alias`::
 (Optional, Boolean)
-If `true`, the action must target an <<indices-aliases,index alias>>. Defaults
-to `false`.
+If `true`, the action must target an <<alias,index alias>>. Defaults to
+`false`.
 end::bulk-require-alias[]
 
 tag::require-alias[]
 `require_alias`::
-(Optional, Boolean)
-If `true`, the destination must be an <<indices-aliases,index alias>>. Defaults to
-`false`.
+(Optional, Boolean) If `true`, the destination must be an <<alias,index alias>>.
+Defaults to `false`.
 end::require-alias[]
 
 tag::bulk-dynamic-templates[]

+ 2 - 2
docs/reference/search/multi-search.asciidoc

@@ -183,8 +183,8 @@ line.
 If `true`, the request does *not* return an error if a wildcard expression or
 `_all` value retrieves only missing or closed indices.
 +
-This parameter also applies to <<indices-aliases,index aliases>> that point to a
-missing or closed index.
+This parameter also applies to <<alias,index aliases>> that point to a missing
+or closed index.
 
 include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 1 - 1
docs/reference/upgrade/reindex_upgrade.asciidoc

@@ -52,7 +52,7 @@ modifications to the document data and metadata during reindexing.
 . Reset the `refresh_interval` and `number_of_replicas` to the values
   used in the old index.
 . Wait for the index status to change to `green`.
-. In a single <<indices-aliases,update aliases>> request:
+. In a single <<indices-aliases,aliases API>> request:
 .. Delete the old index.
 .. Add an alias with the old index name to the new index.
 .. Add any aliases that existed on the old index to the new index.

+ 1 - 1
x-pack/docs/en/security/authorization/alias-privileges.asciidoc

@@ -3,7 +3,7 @@
 === Granting privileges for data streams and index aliases
 
 {es} {security-features} allow you to secure operations executed against
-<<data-streams,data streams>> and <<indices-aliases,index aliases>>.
+<<data-streams,data streams>> and <<alias,aliases>>.
 
 [[data-stream-privileges]]
 ==== Data stream privileges

+ 2 - 2
x-pack/docs/en/watcher/example-watches/example-watch-meetupdata.asciidoc

@@ -145,8 +145,8 @@ To set up the watch:
   },
 -------------------------------------------------
 // NOTCONSOLE
-<1> `logstash` is the default <<indices-add-alias,index alias>> for the {ls}
-indices containing the meetup data. By default, the {ls}
+<1> `logstash` is the default <<alias,index alias>> for the {ls} indices
+containing the meetup data. By default, the {ls}
 <<index-lifecycle-management,{ilm} ({ilm-init})>> policy rolls this alias to a
 new index when the index size reaches 50GB or becomes 30 days old. For more
 information, see