honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/ccr/apis/ccr-apis.asciidoc

54 lines
1.6 KiB
Plaintext
Raw Normal View History

Introduce cross-cluster replication API docs (#34726) This commit is our first introduction to cross-cluster replication docs. In this commit, we introduce the cross-cluster replication API docs. We also add skelton docs for additional content that will be added in a series of follow-up commits.
2018-10-26 11:23:35 -04:00
[role="xpack"]
[testenv="platinum"]
[[ccr-apis]]
[DOCS] Replaces CCR terms with attributes (#39516)
2019-03-12 17:27:17 -04:00
== {ccr-cap} APIs
Introduce cross-cluster replication API docs (#34726) This commit is our first introduction to cross-cluster replication docs. In this commit, we introduce the cross-cluster replication API docs. We also add skelton docs for additional content that will be added in a series of follow-up commits.
2018-10-26 11:23:35 -04:00
You can use the following APIs to perform {ccr} operations.
Fix CCR API specification (#34963) This commit fixes two issues with the CCR API specification: - remove the CCR stats endpoint, it is not currently implemented - fix the documentation links
2018-10-29 09:37:13 -04:00
[float]
[[ccr-api-top-level]]
=== Top-Level
* <<ccr-get-stats,Get {ccr} stats>>
Introduce cross-cluster replication API docs (#34726) This commit is our first introduction to cross-cluster replication docs. In this commit, we introduce the cross-cluster replication API docs. We also add skelton docs for additional content that will be added in a series of follow-up commits.
2018-10-26 11:23:35 -04:00
[float]
[[ccr-api-follow]]
=== Follow
* <<ccr-put-follow,Create follower index>>
* <<ccr-post-pause-follow,Pause follower>>
* <<ccr-post-resume-follow,Resume follower>>
* <<ccr-post-unfollow,Convert follower index to a regular index>>
Introduce forget follower API (#39718) This commit introduces the forget follower API. This API is needed in cases that unfollowing a following index fails to remove the shard history retention leases on the leader index. This can happen explicitly through user action, or implicitly through an index managed by ILM. When this occurs, history will be retained longer than necessary. While the retention lease will eventually expire, it can be expensive to allow history to persist for that long, and also prevent ILM from performing actions like shrink on the leader index. As such, we introduce an API to allow for manual removal of the shard history retention leases in this case.
2019-03-07 10:29:10 -05:00
* <<ccr-post-forget-follower,Remove follower retention leases from the leader>>
Introduce cross-cluster replication API docs (#34726) This commit is our first introduction to cross-cluster replication docs. In this commit, we introduce the cross-cluster replication API docs. We also add skelton docs for additional content that will be added in a series of follow-up commits.
2018-10-26 11:23:35 -04:00
* <<ccr-get-follow-stats,Get stats about follower indices>>
Add ccr follow info api (#37408) * Add ccr follow info api This api returns all follower indices and per follower index the provided parameters at put follow / resume follow time and whether index following is paused or active. Closes #37127 * iter * [DOCS] Edits the get follower info API * [DOCS] Fixes link to remote cluster * [DOCS] Clarifies descriptions for configured parameters
2019-01-18 10:37:21 -05:00
* <<ccr-get-follow-info,Get info about follower indices>>
Introduce cross-cluster replication API docs (#34726) This commit is our first introduction to cross-cluster replication docs. In this commit, we introduce the cross-cluster replication API docs. We also add skelton docs for additional content that will be added in a series of follow-up commits.
2018-10-26 11:23:35 -04:00
[float]
[[ccr-api-auto-follow]]
=== Auto-follow
* <<ccr-put-auto-follow-pattern,Create auto-follow pattern>>
* <<ccr-delete-auto-follow-pattern,Delete auto-follow pattern>>
* <<ccr-get-auto-follow-pattern,Get auto-follow patterns>>
Add documentation for Pause/Resume Auto-Follower APIs (#47985) (#48034) Relates #47510 Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
2019-10-15 02:38:49 -04:00
* <<ccr-pause-auto-follow-pattern,Pause auto-follow pattern>>
* <<ccr-resume-auto-follow-pattern,Resume auto-follow pattern>>
Introduce cross-cluster replication API docs (#34726) This commit is our first introduction to cross-cluster replication docs. In this commit, we introduce the cross-cluster replication API docs. We also add skelton docs for additional content that will be added in a series of follow-up commits.
2018-10-26 11:23:35 -04:00
Fix CCR API specification (#34963) This commit fixes two issues with the CCR API specification: - remove the CCR stats endpoint, it is not currently implemented - fix the documentation links
2018-10-29 09:37:13 -04:00
// top-level
include::get-ccr-stats.asciidoc[]
Introduce cross-cluster replication API docs (#34726) This commit is our first introduction to cross-cluster replication docs. In this commit, we introduce the cross-cluster replication API docs. We also add skelton docs for additional content that will be added in a series of follow-up commits.
2018-10-26 11:23:35 -04:00
// follow
include::follow/put-follow.asciidoc[]
include::follow/post-pause-follow.asciidoc[]
include::follow/post-resume-follow.asciidoc[]
include::follow/post-unfollow.asciidoc[]
Introduce forget follower API (#39718) This commit introduces the forget follower API. This API is needed in cases that unfollowing a following index fails to remove the shard history retention leases on the leader index. This can happen explicitly through user action, or implicitly through an index managed by ILM. When this occurs, history will be retained longer than necessary. While the retention lease will eventually expire, it can be expensive to allow history to persist for that long, and also prevent ILM from performing actions like shrink on the leader index. As such, we introduce an API to allow for manual removal of the shard history retention leases in this case.
2019-03-07 10:29:10 -05:00
include::follow/post-forget-follower.asciidoc[]
Introduce cross-cluster replication API docs (#34726) This commit is our first introduction to cross-cluster replication docs. In this commit, we introduce the cross-cluster replication API docs. We also add skelton docs for additional content that will be added in a series of follow-up commits.
2018-10-26 11:23:35 -04:00
include::follow/get-follow-stats.asciidoc[]
Add ccr follow info api (#37408) * Add ccr follow info api This api returns all follower indices and per follower index the provided parameters at put follow / resume follow time and whether index following is paused or active. Closes #37127 * iter * [DOCS] Edits the get follower info API * [DOCS] Fixes link to remote cluster * [DOCS] Clarifies descriptions for configured parameters
2019-01-18 10:37:21 -05:00
include::follow/get-follow-info.asciidoc[]
Introduce cross-cluster replication API docs (#34726) This commit is our first introduction to cross-cluster replication docs. In this commit, we introduce the cross-cluster replication API docs. We also add skelton docs for additional content that will be added in a series of follow-up commits.
2018-10-26 11:23:35 -04:00
// auto-follow
include::auto-follow/put-auto-follow-pattern.asciidoc[]
include::auto-follow/delete-auto-follow-pattern.asciidoc[]
include::auto-follow/get-auto-follow-pattern.asciidoc[]
Add documentation for Pause/Resume Auto-Follower APIs (#47985) (#48034) Relates #47510 Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
2019-10-15 02:38:49 -04:00
include::auto-follow/pause-auto-follow-pattern.asciidoc[]
include::auto-follow/resume-auto-follow-pattern.asciidoc[]