-
Notifications
You must be signed in to change notification settings - Fork 8.1k
/
policies.ts
240 lines (209 loc) · 5.4 KB
/
policies.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
import { Index as IndexInterface } from '@kbn/index-management-plugin/common/types';
export type Phase = keyof Phases;
export type PhaseWithAllocation = 'warm' | 'cold';
export type PhaseWithTiming = keyof Omit<Phases, 'hot'>;
export type PhaseExceptDelete = keyof Omit<Phases, 'delete'>;
export interface SerializedPolicy {
name: string;
phases: Phases;
_meta?: Record<string, any>;
}
export interface Phases {
hot?: SerializedHotPhase;
warm?: SerializedWarmPhase;
cold?: SerializedColdPhase;
frozen?: SerializedFrozenPhase;
delete?: SerializedDeletePhase;
}
export interface PolicyFromES {
modifiedDate: string;
name: string;
policy: SerializedPolicy;
version: number;
indices?: string[];
dataStreams?: string[];
indexTemplates?: string[];
}
export interface SerializedPhase {
min_age?: string;
actions: {
[action: string]: any;
};
}
export interface MigrateAction {
/**
* If enabled is ever set it will probably only be set to `false` because the default value
* for this is `true`. Rather leave unspecified for true when serialising.
*/
enabled: boolean;
}
export interface SerializedActionWithAllocation {
allocate?: AllocateAction;
migrate?: MigrateAction;
}
export type SearchableSnapshotStorage = 'full_copy' | 'shared_cache';
export interface SearchableSnapshotAction {
snapshot_repository: string;
/**
* We do not configure this value in the UI as it is an advanced setting that will
* not suit the vast majority of cases.
*/
force_merge_index?: boolean;
/**
* This configuration lets the user create full or partial searchable snapshots.
* Full searchable snapshots store primary data locally and store replica data in the snapshot.
* Partial searchable snapshots store no data locally.
*/
storage?: SearchableSnapshotStorage;
}
export interface RolloverAction {
max_age?: string;
max_docs?: number;
max_primary_shard_size?: string;
/**
* @deprecated This will be removed in versions 8+ of the stack
*/
max_size?: string;
}
export interface SerializedHotPhase extends SerializedPhase {
actions: {
rollover?: RolloverAction;
forcemerge?: ForcemergeAction;
readonly?: {};
shrink?: ShrinkAction;
set_priority?: {
priority: number | null;
};
/**
* Only available on enterprise license
*/
searchable_snapshot?: SearchableSnapshotAction;
};
}
export interface SerializedWarmPhase extends SerializedPhase {
actions: {
allocate?: AllocateAction;
shrink?: ShrinkAction;
forcemerge?: ForcemergeAction;
readonly?: {};
set_priority?: {
priority: number | null;
};
migrate?: MigrateAction;
};
}
export interface SerializedColdPhase extends SerializedPhase {
actions: {
freeze?: {};
readonly?: {};
allocate?: AllocateAction;
set_priority?: {
priority: number | null;
};
migrate?: MigrateAction;
/**
* Only available on enterprise license
*/
searchable_snapshot?: SearchableSnapshotAction;
};
}
export interface SerializedFrozenPhase extends SerializedPhase {
actions: {
allocate?: AllocateAction;
set_priority?: {
priority: number | null;
};
migrate?: MigrateAction;
/**
* Only available on enterprise license
*/
searchable_snapshot?: SearchableSnapshotAction;
};
}
export interface SerializedDeletePhase extends SerializedPhase {
actions: {
wait_for_snapshot?: {
policy: string;
};
delete?: {
delete_searchable_snapshot?: boolean;
};
};
}
export interface AllocateAction {
number_of_replicas?: number;
include?: {};
exclude?: {};
require?: {
[attribute: string]: string;
};
}
export interface ShrinkAction {
number_of_shards?: number;
max_primary_shard_size?: string;
}
export interface ForcemergeAction {
max_num_segments: number;
// only accepted value for index_codec
index_codec?: 'best_compression';
}
export interface LegacyPolicy {
name: string;
phases: {
delete: DeletePhase;
};
}
export interface CommonPhaseSettings {
phaseEnabled: boolean;
}
export interface PhaseWithMinAge {
selectedMinimumAge: string;
selectedMinimumAgeUnits: string;
}
export interface PhaseWithIndexPriority {
phaseIndexPriority: string;
}
export interface PhaseWithForcemergeAction {
forceMergeEnabled: boolean;
selectedForceMergeSegments: string;
bestCompressionEnabled: boolean;
}
export interface DeletePhase extends CommonPhaseSettings, PhaseWithMinAge {
waitForSnapshotPolicy: string;
}
export interface IndexLifecyclePolicy {
index: string;
managed: boolean;
action?: string;
action_time_millis?: number;
age?: string;
failed_step?: string;
failed_step_retry_count?: number;
is_auto_retryable_error?: boolean;
lifecycle_date_millis?: number;
phase?: string;
phase_execution?: {
policy: string;
modified_date_in_millis: number;
version: number;
phase_definition: SerializedPhase;
};
phase_time_millis?: number;
policy?: string;
step?: string;
step_info?: {
reason?: string;
type?: string;
message?: string;
};
step_time_millis?: number;
}
export interface Index extends IndexInterface {
ilm: IndexLifecyclePolicy;
}