com.coreos.jetcd

Interface Maintenance

All Superinterfaces:

AutoCloseable, CloseableClient

public interface Maintenance
extends CloseableClient

Interface of maintenance talking to etcd.

An etcd cluster needs periodic maintenance to remain reliable. Depending on an etcd application's needs, this maintenance can usually be automated and performed without downtime or significantly degraded performance.

All etcd maintenance manages storage resources consumed by the etcd keyspace. Failure to adequately control the keyspace size is guarded by storage space quotas; if an etcd member runs low on space, a quota will trigger cluster-wide alarms which will put the system into a limited-operation maintenance mode. To avoid running out of space for writes to the keyspace, the etcd keyspace history must be compacted. Storage space itself may be reclaimed by defragmenting etcd members. Finally, periodic snapshot backups of etcd member state makes it possible to recover any unintended logical data loss or corruption caused by operational error.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Maintenance.Snapshot

Method Summary

Modifier and Type	Method and Description
CompletableFuture<AlarmResponse>	alarmDisarm(AlarmMember member) disarms a given alarm.
CompletableFuture<DefragmentResponse>	defragmentMember(String endpoint) defragment one member of the cluster by its endpoint.
CompletableFuture<HashKVResponse>	hashKV(String endpoint, long rev) returns a hash of the KV state at the time of the RPC.
CompletableFuture<AlarmResponse>	listAlarms() get all active keyspace alarm.
CompletableFuture<MoveLeaderResponse>	moveLeader(long transfereeID) moveLeader requests current leader to transfer its leadership to the transferee.
Maintenance.Snapshot	snapshot() retrieves backend snapshot.
CompletableFuture<StatusResponse>	statusMember(String endpoint) get the status of a member by its endpoint.

Methods inherited from interface com.coreos.jetcd.internal.impl.CloseableClient

close

Method Detail

listAlarms

CompletableFuture<AlarmResponse> listAlarms()

get all active keyspace alarm.

alarmDisarm

CompletableFuture<AlarmResponse> alarmDisarm(AlarmMember member)

disarms a given alarm.

Parameters:

member - the alarm

Returns:

the response result

defragmentMember

CompletableFuture<DefragmentResponse> defragmentMember(String endpoint)

defragment one member of the cluster by its endpoint.

After compacting the keyspace, the backend database may exhibit internal fragmentation. Any internal fragmentation is space that is free to use by the backend but still consumes storage space. The process of defragmentation releases this storage space back to the file system. Defragmentation is issued on a per-member so that cluster-wide latency spikes may be avoided.

Defragment is an expensive operation. User should avoid defragmenting multiple members at the same time. To defragment multiple members in the cluster, user need to call defragment multiple times with different endpoints.

statusMember

CompletableFuture<StatusResponse> statusMember(String endpoint)

get the status of a member by its endpoint.

hashKV

CompletableFuture<HashKVResponse> hashKV(String endpoint,
                                         long rev)

returns a hash of the KV state at the time of the RPC. If revision is zero, the hash is computed on all keys. If the revision is non-zero, the hash is computed on all keys at or below the given revision.

snapshot

Maintenance.Snapshot snapshot()

retrieves backend snapshot.

-- ex: save backend snapshot to ./snapshot.db --

 
 // create snapshot.db file current folder.
 String dir = Paths.get("").toAbsolutePath().toString();
 File snapfile = new File(dir, "snapshot.db");

 // leverage try-with-resources
 try (Snapshot snapshot = maintenance.snapshot();
 FileOutputStream fop = newFileOutputStream(snapfile)) {
 snapshot.write(fop);
 } catch (Exception e) {
 snapfile.delete();
 }
 
 

Returns:

a Snapshot for retrieving backend snapshot.

moveLeader

CompletableFuture<MoveLeaderResponse> moveLeader(long transfereeID)

moveLeader requests current leader to transfer its leadership to the transferee. Request must be made to the leader.