-
Notifications
You must be signed in to change notification settings - Fork 8.2k
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
[DOCS] Improves Management section in docs #56669
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,30 @@ | ||
[role="xpack"] | ||
[[index-lifecycle-policies]] | ||
== Index lifecycle policies | ||
== Index Lifecycle Policies | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why is it Index Lifecycle Policies in the title if it is index lifecycle policies on line 12? |
||
|
||
If you're working with time series data, you don't want to continually dump | ||
everything into a single index. Instead, you might periodically roll over the | ||
data to a new index to keep it from growing so big it's slow and expensive. | ||
As the index ages and you query it less frequently, you’ll likely move it to | ||
If you're working with time series data, you don't want to continually dump | ||
everything into a single index. Instead, you might periodically roll over the | ||
data to a new index to keep it from growing so big it's slow and expensive. | ||
As the index ages and you query it less frequently, you’ll likely move it to | ||
less expensive hardware and reduce the number of shards and replicas. | ||
|
||
To automatically move an index through its lifecycle, you can create a policy | ||
to define actions to perform on the index as it ages. Index lifecycle policies | ||
are especially useful when working with {beats-ref}/beats-reference.html[Beats] | ||
data shippers, which continually | ||
send operational data, such as metrics and logs, to Elasticsearch. You can | ||
automate a rollover to a new index when the existing index reaches a specified | ||
size or age. This ensures that all indices have a similar size instead of having | ||
daily indices where size can vary based on the number of Beats and the number | ||
To automatically move an index through its lifecycle, you can create a policy | ||
to define actions to perform on the index as it ages. Index lifecycle policies | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. actions or tasks? |
||
are especially useful when working with {beats-ref}/beats-reference.html[Beats] | ||
data shippers, which continually | ||
send operational data, such as metrics and logs, to Elasticsearch. You can | ||
automate a rollover to a new index when the existing index reaches a specified | ||
size or age. This ensures that all indices have a similar size instead of having | ||
daily indices where size can vary based on the number of Beats and the number | ||
of events sent. | ||
|
||
{kib}’s *Index Lifecycle Policies* walks you through the process for creating | ||
and configuring a policy. Before using this feature, you should be familiar | ||
{kib}’s *Index Lifecycle Policies* walks you through the process for creating | ||
and configuring a policy. Before using this feature, you should be familiar | ||
with index lifecycle management: | ||
|
||
* For an introduction, see | ||
{ref}/getting-started-index-lifecycle-management.html[Getting started with index | ||
lifecycle management]. | ||
* To dig into the concepts and technical details, see | ||
* For an introduction, refer to | ||
{ref}/getting-started-index-lifecycle-management.html[Getting started with index | ||
lifecycle management]. | ||
* To dig into the concepts and technical details, see | ||
{ref}/index-lifecycle-management.html[Managing the index lifecycle]. | ||
* To check out the APIs, see {ref}/index-lifecycle-management-api.html[Index lifecycle management API]. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,8 @@ | ||
[[working-remote-clusters]] | ||
== Working with remote clusters | ||
== Remote Clusters | ||
|
||
{kib} *Management* provides user interfaces for working with data from remote | ||
clusters and managing the {ccr} process. You can replicate indices from a | ||
{kib} *Management* provides user interfaces for working with data from remote | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How about: Work with data from remote clusters and manage the {ccr} process. |
||
clusters and managing the {ccr} process. You can replicate indices from a | ||
leader remote cluster to a follower index in a local cluster. The local follower indices | ||
can be used to provide remote backups for disaster recovery or for geo-proximite copies of data. | ||
|
||
|
@@ -14,51 +14,51 @@ Before using these features, you should be familiar with the following concepts: | |
|
||
[float] | ||
[[managing-remote-clusters]] | ||
== Managing remote clusters | ||
== Managing remote clusters | ||
|
||
*Remote clusters* helps you manage remote clusters for use with | ||
{ccs} and {ccr}. You can add and remove remote clusters and check their connectivity. | ||
*Remote clusters* helps you manage remote clusters for use with | ||
{ccs} and {ccr}. You can add and remove remote clusters and check their connectivity. | ||
|
||
Before you use this feature, you should be familiar with the concept of | ||
{ref}/modules-remote-clusters.html[remote clusters]. | ||
|
||
Before you use this feature, you should be familiar with the concept of | ||
{ref}/modules-remote-clusters.html[remote clusters]. | ||
|
||
Go to *Management > Elasticsearch > Remote clusters* to create or manage your remotes. | ||
|
||
To set up a new remote, click *Add a remote cluster*. Give the cluster a unique name | ||
and define the seed nodes for cluster discovery. You can edit or remove your remote clusters | ||
To set up a new remote, click *Add a remote cluster*. Give the cluster a unique name | ||
and define the seed nodes for cluster discovery. You can edit or remove your remote clusters | ||
from the *Remote clusters* list view. | ||
|
||
[role="screenshot"] | ||
image::images/add_remote_cluster.png[][UI for adding a remote cluster] | ||
|
||
Once a remote cluster is registered, you can use the tools under *{ccr-cap}* | ||
to add and manage follower indices on the local cluster, and replicate data from | ||
Once a remote cluster is registered, you can use the tools under *{ccr-cap}* | ||
to add and manage follower indices on the local cluster, and replicate data from | ||
indices on the remote cluster based on an auto-follow index pattern. | ||
|
||
[float] | ||
[[managing-cross-cluster-replication]] | ||
== [xpack]#Managing {ccr}# | ||
|
||
*{ccr-cap}* helps you create and manage the {ccr} process. | ||
If you want to replicate data from existing indices, or set up | ||
local followers on a case-by-case basis, go to *Follower indices*. | ||
If you want to automatically detect and follow new indices when they are created | ||
on a remote cluster, you can do so from *Auto-follow patterns*. | ||
*{ccr-cap}* helps you create and manage the {ccr} process. | ||
If you want to replicate data from existing indices, or set up | ||
local followers on a case-by-case basis, go to *Follower indices*. | ||
If you want to automatically detect and follow new indices when they are created | ||
on a remote cluster, you can do so from *Auto-follow patterns*. | ||
|
||
Creating an auto-follow pattern is useful when you have time-series data, like a logs index, on the | ||
remote cluster that is created or rolled over on a daily basis. Once you have configured an | ||
auto-follow pattern, any time a new index with a name that matches the pattern is | ||
Creating an auto-follow pattern is useful when you have time-series data, like a logs index, on the | ||
remote cluster that is created or rolled over on a daily basis. Once you have configured an | ||
auto-follow pattern, any time a new index with a name that matches the pattern is | ||
created in the remote cluster, a follower index is automatically configured in the local cluster. | ||
|
||
From the same view, you can also see a list of your saved auto-follow patterns for | ||
From the same view, you can also see a list of your saved auto-follow patterns for | ||
a given remote cluster, and monitor whether the replication is active. | ||
|
||
Before you use these features, you should be familiar with the following concepts: | ||
|
||
* {ref}/ccr-requirements.html[Requirements for leader indices] | ||
* {ref}/ccr-requirements.html[Requirements for leader indices] | ||
* {ref}/ccr-auto-follow.html[Automatically following indices] | ||
|
||
To get started, go to *Management > Elasticsearch > {ccr-cap}*. | ||
To get started, go to *Management > Elasticsearch > {ccr-cap}*. | ||
|
||
[role="screenshot"] | ||
image::images/auto_follow_pattern.png[][UI for adding an auto-follow pattern] | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Advanced Settings or Advanced settings?