[DOCS] Add index alias definition to glossary (#46339)

This commit is contained in:
James Rodewig 2019-09-06 11:35:27 -04:00
parent c46c57d439
commit b05c0f333d
6 changed files with 19 additions and 12 deletions

View File

@ -96,6 +96,20 @@ An index is a logical namespace which maps to one or more
<<glossary-primary-shard,primary shards>> and can have zero or more <<glossary-primary-shard,primary shards>> and can have zero or more
<<glossary-replica-shard,replica shards>>. <<glossary-replica-shard,replica shards>>.
[[glossary-index-alias]] index alias ::
+
--
// tag::index-alias-def[]
An index alias is a secondary name
used to refer to one or more existing indices.
Most {es} APIs accept an index alias
in place of an index name.
// end::index-alias-def[]
See <<indices-add-alias>>.
--
[[glossary-leader-index]] leader index :: [[glossary-leader-index]] leader index ::
Leader indices are the source indices for <<glossary-ccr,{ccr}>>. They exist Leader indices are the source indices for <<glossary-ccr,{ccr}>>. They exist

View File

@ -6,7 +6,7 @@
Creates or updates an index alias. Creates or updates an index alias.
include::alias-exists.asciidoc[tag=index-alias-def] include::{docdir}/glossary.asciidoc[tag=index-alias-def]
[source,console] [source,console]
---- ----

View File

@ -6,14 +6,7 @@
Checks if an index alias exists. Checks if an index alias exists.
//tag::index-alias-def[] include::{docdir}/glossary.asciidoc[tag=index-alias-def]
An index alias is a secondary name
used to refer to one or more existing indices.
//end::index-alias-def[]
The returned HTTP status code indicates whether the index alias exists or not.
A `404` means it does not exist,
and `200` means it does.
[source,console] [source,console]
---- ----

View File

@ -6,7 +6,7 @@
Adds or removes index aliases. Adds or removes index aliases.
include::alias-exists.asciidoc[tag=index-alias-def] include::{docdir}/glossary.asciidoc[tag=index-alias-def]
[source,console] [source,console]
---- ----

View File

@ -6,7 +6,7 @@
Deletes an existing index alias. Deletes an existing index alias.
include::alias-exists.asciidoc[tag=index-alias-def] include::{docdir}/glossary.asciidoc[tag=index-alias-def]
[source,console] [source,console]
---- ----

View File

@ -6,7 +6,7 @@
Returns information about one or more index aliases. Returns information about one or more index aliases.
include::alias-exists.asciidoc[tag=index-alias-def] include::{docdir}/glossary.asciidoc[tag=index-alias-def]
[source,console] [source,console]
---- ----