Skip to content

Commit b85b534

Browse files
committed
[DOCS] Edit the snapshot lifecycle management summaries
1 parent cdae60f commit b85b534

File tree

9 files changed

+42
-1
lines changed

9 files changed

+42
-1
lines changed

specification/slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,13 @@ import { RequestBase } from '@_types/Base'
2121
import { Name } from '@_types/common'
2222

2323
/**
24+
* Delete a policy.
25+
* Delete a snapshot lifecycle policy definition.
26+
* This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.
2427
* @rest_spec_name slm.delete_lifecycle
2528
* @availability stack since=7.4.0 stability=stable
2629
* @availability serverless stability=stable visibility=private
30+
* @cluster_privileges manage_slm
2731
*/
2832
export interface Request extends RequestBase {
2933
path_parts: {

specification/slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,13 @@ import { RequestBase } from '@_types/Base'
2121
import { Name } from '@_types/common'
2222

2323
/**
24+
* Run a policy.
25+
* Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.
26+
* The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.
2427
* @rest_spec_name slm.execute_lifecycle
2528
* @availability stack since=7.4.0 stability=stable
2629
* @availability serverless stability=stable visibility=private
30+
* @cluster_privileges manage_slm
2731
*/
2832
export interface Request extends RequestBase {
2933
path_parts: {

specification/slm/execute_retention/ExecuteRetentionRequest.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,12 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23+
* Run retention policy.
24+
* Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.
25+
* The retention policy is normally applied according to its schedule.
2326
* @rest_spec_name slm.execute_retention
2427
* @availability stack since=7.5.0 stability=stable
2528
* @availability serverless stability=stable visibility=private
29+
* @cluster_privileges manage_slm
2630
*/
2731
export interface Request extends RequestBase {}

specification/slm/get_lifecycle/GetSnapshotLifecycleRequest.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,18 @@ import { RequestBase } from '@_types/Base'
2121
import { Names } from '@_types/common'
2222

2323
/**
24+
* Get snapshot lifecycle policy information.
25+
* Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.
2426
* @rest_spec_name slm.get_lifecycle
2527
* @availability stack since=7.4.0 stability=stable
2628
* @availability serverless stability=stable visibility=private
29+
* @cluster_privileges manage_slm
2730
*/
2831
export interface Request extends RequestBase {
2932
path_parts: {
33+
/*
34+
A comma-separate list of snapshot lifecycle policy identifiers.
35+
*/
3036
policy_id?: Names
3137
}
3238
}

specification/slm/get_stats/GetSnapshotLifecycleStatsRequest.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,11 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23+
* Get snapshot lifecycle statistics.
24+
* Get global and policy-level statistics about actions taken by snapshot lifecycle management.
2325
* @rest_spec_name slm.get_stats
2426
* @availability stack since=7.5.0 stability=stable
2527
* @availability serverless stability=stable visibility=private
28+
* @cluster_privileges manage_slm
2629
*/
2730
export interface Request extends RequestBase {}

specification/slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,10 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23+
* Get the snapshot lifecycle management status.
2324
* @rest_spec_name slm.get_status
2425
* @availability stack since=7.6.0 stability=stable
2526
* @availability serverless stability=stable visibility=private
27+
* @cluster_privileges read_slm
2628
*/
2729
export interface Request extends RequestBase {}

specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,20 @@ import { Name } from '@_types/common'
2424
import { Duration } from '@_types/Time'
2525

2626
/**
27+
* Create or update a policy.
28+
* Create or update a snapshot lifecycle policy.
29+
* If the policy already exists, this request increments the policy version.
30+
* Only the latest version of a policy is stored.
2731
* @rest_spec_name slm.put_lifecycle
2832
* @availability stack since=7.4.0 stability=stable
2933
* @availability serverless stability=stable visibility=private
34+
* @cluster_privileges manage_slm
35+
* @index_privileges manage
3036
*/
3137
export interface Request extends RequestBase {
3238
path_parts: {
3339
/**
34-
* ID for the snapshot lifecycle policy you want to create or update.
40+
* The identifier for the snapshot lifecycle policy you want to create or update.
3541
*/
3642
policy_id: Name
3743
}

specification/slm/start/StartSnapshotLifecycleManagementRequest.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,12 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23+
* Start snapshot lifecycle management.
24+
* Snapshot lifecycle management (SLM) starts automatically when a cluster is formed.
25+
* Manually starting SLM is necessary only if it has been stopped using the stop SLM API.
2326
* @rest_spec_name slm.start
2427
* @availability stack since=7.6.0 stability=stable
2528
* @availability serverless stability=stable visibility=private
29+
* @cluster_privileges manage_slm
2630
*/
2731
export interface Request extends RequestBase {}

specification/slm/stop/StopSnapshotLifecycleManagementRequest.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23+
* Stop snapshot lifecycle management.
24+
* Stop all snapshot lifecycle management (SLM) operations and the SLM plugin.
25+
* This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices.
26+
* Stopping SLM does not stop any snapshots that are in progress.
27+
* You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.
28+
*
29+
* The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped.
30+
* Use the get snapshot lifecycle management status API to see if SLM is running.
2331
* @rest_spec_name slm.stop
2432
* @availability stack since=7.6.0 stability=stable
2533
* @availability serverless stability=stable visibility=private

0 commit comments

Comments
 (0)