opendaylight/md-sal/sal-distributed-datastore/src/main/yang/cluster-admin.yang

   1 module cluster-admin {
   2     yang-version 1;
   3     namespace "urn:opendaylight:params:xml:ns:yang:controller:md:sal:cluster:admin";
   4     prefix "cluster-admin";
   5
   6     description
   7         "This module contains YANG RPC definitions for administering a cluster.";
   8
   9     revision "2015-10-13" {
  10         description "Initial revision.";
  11     }
  12
  13     typedef data-store-type {
  14         type enumeration {
  15           enum config {
  16             value 1;
  17           }
  18           enum operational {
  19             value 2;
  20           }
  21         }
  22     }
  23
  24     rpc add-shard-replica {
  25         input {
  26             leaf shard-name {
  27               type string;
  28               description "The name of the shard for which to create a replica.";
  29             }
  30         }
  31
  32         description "Adds a replica of a shard to this node and joins it to an existing cluster. The shard must
  33             already have a module configuration defined for it and there must already be a shard existing on
  34             another node with a leader. This RPC first contacts peer member seed nodes searching for a shard.
  35             When found, an AddServer message is sent to the shard leader and applied as described in the Raft
  36             paper.";
  37     }
  38
  39     rpc remove-shard-replica {
  40         input {
  41             leaf shard-name {
  42               type string;
  43               description "The name of the shard for which to remove the replica.";
  44             }
  45
  46             leaf member-name {
  47               type string;
  48               description "The cluster member from which the shard replica should be removed";
  49             }
  50
  51             leaf data-store-type {
  52               type data-store-type;
  53               description "The type of the data store to which the replica belongs";
  54             }
  55         }
  56
  57         description "Removes an existing replica of a shard from this node via the RemoveServer mechanism as
  58             described in the Raft paper.";
  59     }
  60
  61     rpc add-replicas-for-all-shards {
  62         description "Adds replicas on this node for all currently defined shards. This is equivalent to issuing
  63             an add-shard-replica RPC for all shards.";
  64     }
  65
  66     rpc remove-all-shard-replicas {
  67         description "Removes replicas for all shards on this node. This is equivalent to issuing
  68             a remove-shard-replica for all shards and essentially removes this node from a cluster.";
  69     }
  70
  71     rpc convert-members-to-nonvoting-for-all-shards {
  72         input {
  73             leaf-list member-names {
  74                 type string;
  75                 description "The names of the cluster members to convert.";
  76             }
  77         }
  78
  79         description "Converts the given cluster members to non-voting for all shards. The members will no
  80             longer participate in leader elections and consensus but will be replicated. This is useful for
  81             having a set of members serve as a backup cluster in case the primary voting cluster suffers
  82             catastrophic failure. This RPC can be issued to any cluster member and will be forwarded
  83             to the leader.";
  84     }
  85
  86     rpc convert-members-to-voting-for-all-shards {
  87         input {
  88             leaf-list member-names {
  89                 type string;
  90                 description "The names of the cluster members to convert.";
  91             }
  92         }
  93
  94         description "Converts the given cluster members to voting for all shards. The members will
  95             participate in leader elections and consensus.";
  96     }
  97
  98     rpc backup-datastore {
  99         input {
 100             leaf file-path {
 101               type string;
 102               description "The path and name of the file in which to store the backup.";
 103             }
 104         }
 105
 106         description "Creates a backup file of the datastore state";
 107     }
 108 }