org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013

Interface ClusterAdminService

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.RpcService

public interface ClusterAdminService
extends org.opendaylight.yangtools.yang.binding.RpcService

Interface for implementing the following YANG RPCs defined in module cluster-admin

 rpc make-leader-local {
   input {
     leaf shard-name {
       type string;
     }
     leaf data-store-type {
       type data-store-type;
     }
   }
   output;
 }
 rpc remove-shard-replica {
   input {
     leaf shard-name {
       type string;
     }
     leaf member-name {
       type string;
     }
     leaf data-store-type {
       type data-store-type;
     }
   }
   output;
 }
 rpc change-member-voting-states-for-shard {
   input {
     leaf shard-name {
       type string;
     }
     leaf data-store-type {
       type data-store-type;
     }
     uses member-voting-states-input;
   }
   output;
 }
 rpc get-shard-role {
   input {
     leaf shard-name {
       type string;
     }
     leaf data-store-type {
       type data-store-type;
     }
   }
   output {
     leaf role {
       type string;
     }
   }
 }
 rpc add-prefix-shard-replica {
   input {
     leaf shard-prefix {
       type instance-identifier;
     }
     leaf data-store-type {
       type data-store-type;
     }
   }
   output;
 }
 rpc change-member-voting-states-for-all-shards {
   input {
     uses member-voting-states-input;
   }
   output {
     uses shard-result-output;
   }
 }
 rpc flip-member-voting-states-for-all-shards {
   output {
     uses shard-result-output;
   }
   input;
 }
 rpc add-replicas-for-all-shards {
   output {
     uses shard-result-output;
   }
   input;
 }
 rpc get-prefix-shard-role {
   input {
     leaf shard-prefix {
       type instance-identifier;
     }
     leaf data-store-type {
       type data-store-type;
     }
   }
   output {
     leaf role {
       type string;
     }
   }
 }
 rpc remove-all-shard-replicas {
   input {
     leaf member-name {
       type string;
     }
   }
   output {
     uses shard-result-output;
   }
 }
 rpc backup-datastore {
   input {
     leaf file-path {
       type string;
     }
   }
   output;
 }
 rpc remove-prefix-shard-replica {
   input {
     leaf shard-prefix {
       type instance-identifier;
     }
     leaf member-name {
       type string;
     }
     leaf data-store-type {
       type data-store-type;
     }
   }
   output;
 }
 rpc add-shard-replica {
   input {
     leaf shard-name {
       type string;
     }
     leaf data-store-type {
       type data-store-type;
     }
   }
   output;
 }
 

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<AddPrefixShardReplicaOutput>>	addPrefixShardReplica(AddPrefixShardReplicaInput input) Adds a replica of a shard to this node and joins it to an existing cluster.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<AddReplicasForAllShardsOutput>>	addReplicasForAllShards(AddReplicasForAllShardsInput input) Adds replicas on this node for all currently defined shards.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<AddShardReplicaOutput>>	addShardReplica(AddShardReplicaInput input) Adds a replica of a shard to this node and joins it to an existing cluster.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<BackupDatastoreOutput>>	backupDatastore(BackupDatastoreInput input) Creates a backup file of the datastore state
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<ChangeMemberVotingStatesForAllShardsOutput>>	changeMemberVotingStatesForAllShards(ChangeMemberVotingStatesForAllShardsInput input) Changes the voting states, either voting or non-voting, of cluster members for all shards.Non-voting members will no longer participate in leader elections and consensus but will bereplicated.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<ChangeMemberVotingStatesForShardOutput>>	changeMemberVotingStatesForShard(ChangeMemberVotingStatesForShardInput input) Changes the voting states, either voting or non-voting, of cluster members for a shard.Non-voting members will no longer participate in leader elections and consensus but will bereplicated.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<FlipMemberVotingStatesForAllShardsOutput>>	flipMemberVotingStatesForAllShards(FlipMemberVotingStatesForAllShardsInput input) Flips the voting states of all cluster members for all shards, such that if a memberwas voting it becomes non-voting and vice versa.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetPrefixShardRoleOutput>>	getPrefixShardRole(GetPrefixShardRoleInput input) Returns the current role for the requested module shard.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetShardRoleOutput>>	getShardRole(GetShardRoleInput input) Returns the current role for the requested module shard.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<MakeLeaderLocalOutput>>	makeLeaderLocal(MakeLeaderLocalInput input) Attempts to move the shard leader of the given module based shard to the local node.The rpc returns a response after handling of the underlying MakeLeaderLocal message completes.This operation fails if there is no current shard leader due to lack of network connectivity ora cluster majority.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<RemoveAllShardReplicasOutput>>	removeAllShardReplicas(RemoveAllShardReplicasInput input) Removes replicas for all shards on this node.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<RemovePrefixShardReplicaOutput>>	removePrefixShardReplica(RemovePrefixShardReplicaInput input) Removes an existing replica of a prefix shard from this node via the RemoveServer mechanism asdescribed in the Raft paper.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<RemoveShardReplicaOutput>>	removeShardReplica(RemoveShardReplicaInput input) Removes an existing replica of a shard from this node via the RemoveServer mechanism asdescribed in the Raft paper.

Method Detail

makeLeaderLocal

com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<MakeLeaderLocalOutput>> makeLeaderLocal(MakeLeaderLocalInput input)

Attempts to move the shard leader of the given module based shard to the local node.The rpc returns a response after handling of the underlying MakeLeaderLocal message completes.This operation fails if there is no current shard leader due to lack of network connectivity ora cluster majority. In addition, if the local node is not up to date with the current leader,an attempt is made to first sync the local node with the leader. If this cannot be achievedwithin two election timeout periods the operation fails.

removeShardReplica

com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<RemoveShardReplicaOutput>> removeShardReplica(RemoveShardReplicaInput input)

Removes an existing replica of a shard from this node via the RemoveServer mechanism asdescribed in the Raft paper.

changeMemberVotingStatesForShard

com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<ChangeMemberVotingStatesForShardOutput>> changeMemberVotingStatesForShard(ChangeMemberVotingStatesForShardInput input)

Changes the voting states, either voting or non-voting, of cluster members for a shard.Non-voting members will no longer participate in leader elections and consensus but will bereplicated. This is useful for having a set of members serve as a backup cluster in case theprimary voting cluster suffers catastrophic failure. This RPC can be issued to any cluster memberand will be forwarded to the leader.

getShardRole

com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetShardRoleOutput>> getShardRole(GetShardRoleInput input)

Returns the current role for the requested module shard.

addPrefixShardReplica

com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<AddPrefixShardReplicaOutput>> addPrefixShardReplica(AddPrefixShardReplicaInput input)

Adds a replica of a shard to this node and joins it to an existing cluster. There must already bea shard existing on another node with a leader. This RPC first contacts peer member seed nodessearching for a shard. When found, an AddServer message is sent to the shard leader and applied asdescribed in the Raft paper.

changeMemberVotingStatesForAllShards

com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<ChangeMemberVotingStatesForAllShardsOutput>> changeMemberVotingStatesForAllShards(ChangeMemberVotingStatesForAllShardsInput input)

Changes the voting states, either voting or non-voting, of cluster members for all shards.Non-voting members will no longer participate in leader elections and consensus but will bereplicated. This is useful for having a set of members serve as a backup cluster in case theprimary voting cluster suffers catastrophic failure. This RPC can be issued to any cluster memberand will be forwarded to the leader.

flipMemberVotingStatesForAllShards

com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<FlipMemberVotingStatesForAllShardsOutput>> flipMemberVotingStatesForAllShards(FlipMemberVotingStatesForAllShardsInput input)

Flips the voting states of all cluster members for all shards, such that if a memberwas voting it becomes non-voting and vice versa.

addReplicasForAllShards

com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<AddReplicasForAllShardsOutput>> addReplicasForAllShards(AddReplicasForAllShardsInput input)

Adds replicas on this node for all currently defined shards. This is equivalent to issuingan add-shard-replica RPC for all shards.

getPrefixShardRole

com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<GetPrefixShardRoleOutput>> getPrefixShardRole(GetPrefixShardRoleInput input)

Returns the current role for the requested module shard.

removeAllShardReplicas

com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<RemoveAllShardReplicasOutput>> removeAllShardReplicas(RemoveAllShardReplicasInput input)

Removes replicas for all shards on this node. This is equivalent to issuinga remove-shard-replica for all shards and essentially removes this node from a cluster.

backupDatastore

com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<BackupDatastoreOutput>> backupDatastore(BackupDatastoreInput input)

Creates a backup file of the datastore state

removePrefixShardReplica

com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<RemovePrefixShardReplicaOutput>> removePrefixShardReplica(RemovePrefixShardReplicaInput input)

Removes an existing replica of a prefix shard from this node via the RemoveServer mechanism asdescribed in the Raft paper.

addShardReplica

com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<AddShardReplicaOutput>> addShardReplica(AddShardReplicaInput input)

Adds a replica of a shard to this node and joins it to an existing cluster. The shard mustalready have a module configuration defined for it and there must already be a shard existing onanother node with a leader. This RPC first contacts peer member seed nodes searching for a shard.When found, an AddServer message is sent to the shard leader and applied as described in the Raftpaper.