forked from elastic/elasticsearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add SnapshotLifecycleService and related CRUD APIs
This commit adds `SnapshotLifecycleService` as a new service under the ilm plugin. This service handles snapshot lifecycle policies by scheduling based on the policies defined schedule. This also includes the get, put, and delete APIs for these policies Relates to elastic#38461
- Loading branch information
Showing
19 changed files
with
1,553 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
117 changes: 117 additions & 0 deletions
117
...lm/src/main/java/org/elasticsearch/xpack/snapshotlifecycle/SnapshotLifecycleMetadata.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.xpack.snapshotlifecycle; | ||
|
|
||
| import org.elasticsearch.Version; | ||
| import org.elasticsearch.cluster.AbstractDiffable; | ||
| import org.elasticsearch.cluster.Diff; | ||
| import org.elasticsearch.cluster.DiffableUtils; | ||
| import org.elasticsearch.cluster.NamedDiff; | ||
| import org.elasticsearch.cluster.metadata.MetaData; | ||
| import org.elasticsearch.common.Strings; | ||
| import org.elasticsearch.common.io.stream.StreamInput; | ||
| import org.elasticsearch.common.io.stream.StreamOutput; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
| import org.elasticsearch.xpack.core.XPackPlugin.XPackMetaDataCustom; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Collections; | ||
| import java.util.EnumSet; | ||
| import java.util.Map; | ||
| import java.util.TreeMap; | ||
|
|
||
| /** | ||
| * Custom cluster state metadata that stores all the snapshot lifecycle | ||
| * policies and their associated metadata | ||
| */ | ||
| public class SnapshotLifecycleMetadata implements XPackMetaDataCustom { | ||
|
|
||
| public static final String TYPE = "snapshot_lifecycle"; | ||
|
|
||
| private final Map<String, SnapshotLifecyclePolicyMetadata> snapshotConfigurations; | ||
|
|
||
| public SnapshotLifecycleMetadata(Map<String, SnapshotLifecyclePolicyMetadata> snapshotConfigurations) { | ||
| this.snapshotConfigurations = Collections.unmodifiableMap(snapshotConfigurations); | ||
| // TODO: maybe operation mode here so it can be disabled/re-enabled separately like ILM is | ||
| } | ||
|
|
||
| public SnapshotLifecycleMetadata(StreamInput in) throws IOException { | ||
| this.snapshotConfigurations = in.readMap(StreamInput::readString, SnapshotLifecyclePolicyMetadata::new); | ||
| } | ||
|
|
||
| public Map<String, SnapshotLifecyclePolicyMetadata> getSnapshotConfigurations() { | ||
| return this.snapshotConfigurations; | ||
| } | ||
|
|
||
| @Override | ||
| public EnumSet<MetaData.XContentContext> context() { | ||
| return MetaData.ALL_CONTEXTS; | ||
| } | ||
|
|
||
| @Override | ||
| public Diff<MetaData.Custom> diff(MetaData.Custom previousState) { | ||
| return new SnapshotLifecycleMetadataDiff((SnapshotLifecycleMetadata) previousState, this); | ||
| } | ||
|
|
||
| @Override | ||
| public String getWriteableName() { | ||
| return TYPE; | ||
| } | ||
|
|
||
| @Override | ||
| public Version getMinimalSupportedVersion() { | ||
| return Version.V_8_0_0; // TODO: revisit this when we figure out where this goes | ||
| } | ||
|
|
||
| @Override | ||
| public void writeTo(StreamOutput out) throws IOException { | ||
| out.writeMap(this.snapshotConfigurations, StreamOutput::writeString, (out1, value) -> value.writeTo(out1)); | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { | ||
| // TODO: clean this up? | ||
| builder.field("policies", this.snapshotConfigurations); | ||
| return builder; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return Strings.toString(this); | ||
| } | ||
|
|
||
| public static class SnapshotLifecycleMetadataDiff implements NamedDiff<MetaData.Custom> { | ||
|
|
||
| final Diff<Map<String, SnapshotLifecyclePolicyMetadata>> lifecycles; | ||
|
|
||
| SnapshotLifecycleMetadataDiff(SnapshotLifecycleMetadata before, SnapshotLifecycleMetadata after) { | ||
| this.lifecycles = DiffableUtils.diff(before.snapshotConfigurations, after.snapshotConfigurations, | ||
| DiffableUtils.getStringKeySerializer()); | ||
| } | ||
|
|
||
| @Override | ||
| public MetaData.Custom apply(MetaData.Custom part) { | ||
| TreeMap<String, SnapshotLifecyclePolicyMetadata> newLifecycles = new TreeMap<>( | ||
| lifecycles.apply(((SnapshotLifecycleMetadata) part).snapshotConfigurations)); | ||
| return new SnapshotLifecycleMetadata(newLifecycles); | ||
| } | ||
|
|
||
| @Override | ||
| public String getWriteableName() { | ||
| return TYPE; | ||
| } | ||
|
|
||
| @Override | ||
| public void writeTo(StreamOutput out) throws IOException { | ||
| lifecycles.writeTo(out); | ||
| } | ||
|
|
||
| static Diff<SnapshotLifecyclePolicy> readLifecyclePolicyDiffFrom(StreamInput in) throws IOException { | ||
| return AbstractDiffable.readDiffFrom(SnapshotLifecyclePolicy::new, in); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.