1 // vi: set smarttab et sw=4 tabstop=4:
2 module distributed-datastore-provider {
5 namespace "urn:opendaylight:params:xml:ns:yang:controller:config:distributed-datastore-provider";
6 prefix "distributed-datastore-provider";
9 "This module contains the base YANG definitions for
10 the distributed datastore provider implementation";
12 revision "2014-06-12" {
17 typedef non-zero-uint32-type {
23 typedef operation-timeout-type {
29 typedef heartbeat-interval-type {
41 grouping data-store-properties {
42 leaf max-shard-data-change-executor-queue-size {
44 type non-zero-uint32-type;
45 description "The maximum queue size for each shard's data store data change notification executor.";
48 leaf max-shard-data-change-executor-pool-size {
50 type non-zero-uint32-type;
51 description "The maximum thread pool size for each shard's data store data change notification executor.";
54 leaf max-shard-data-change-listener-queue-size {
56 type non-zero-uint32-type;
57 description "The maximum queue size for each shard's data store data change listener.";
60 leaf max-shard-data-store-executor-queue-size {
62 type non-zero-uint32-type;
63 description "The maximum queue size for each shard's data store executor.";
66 leaf shard-transaction-idle-timeout-in-minutes {
68 type non-zero-uint32-type;
69 description "The maximum amount of time a shard transaction can be idle without receiving any messages before it self-destructs.";
72 leaf shard-snapshot-batch-count {
74 type non-zero-uint32-type;
75 description "The minimum number of entries to be present in the in-memory journal log before a snapshot is to be taken.";
78 leaf shard-snapshot-data-threshold-percentage {
81 description "The percentage of Runtime.maxMemory() used by the in-memory journal log before a snapshot is to be taken";
85 leaf shard-heartbeat-interval-in-millis {
87 type heartbeat-interval-type;
88 description "The interval at which a shard will send a heart beat message to its remote shard.";
91 leaf shard-election-timeout-factor {
93 type non-zero-uint32-type;
94 description "The multiplication factor to be used to determine shard election timeout. The shard election timeout
95 is determined by multiplying shard-heartbeat-interval-in-millis with the shard-election-timeout-factor";
98 leaf operation-timeout-in-seconds {
100 type operation-timeout-type;
101 description "The maximum amount of time for akka operations (remote or local) to complete before failing.";
104 leaf shard-journal-recovery-log-batch-size {
106 type non-zero-uint32-type;
107 description "The maximum number of journal log entries to batch on recovery for a shard before committing to the data store.";
110 leaf shard-transaction-commit-timeout-in-seconds {
112 type non-zero-uint32-type;
113 description "The maximum amount of time a shard transaction three-phase commit can be idle without receiving the next messages before it aborts the transaction";
116 leaf shard-transaction-commit-queue-capacity {
118 type non-zero-uint32-type;
119 description "The maximum allowed capacity for each shard's transaction commit queue.";
122 leaf shard-commit-queue-expiry-timeout-in-seconds {
123 default 120; // 2 minutes
124 type non-zero-uint32-type;
125 description "The maximum amount of time a transaction can remain in a shard's commit queue waiting
126 to begin the CanCommit phase as coordinated by the broker front-end. Normally this should be
127 quick but latencies can occur in between transaction ready and CanCommit or a remote broker
128 could lose connection and CanCommit might never occur. Expiring transactions from the queue
129 allows subsequent pending transaction to be processed.";
132 leaf shard-initialization-timeout-in-seconds {
133 default 300; // 5 minutes
134 type non-zero-uint32-type;
135 description "The maximum amount of time to wait for a shard to initialize from persistence
136 on startup before failing an operation (eg transaction create and change
137 listener registration).";
140 leaf shard-leader-election-timeout-in-seconds {
142 type non-zero-uint32-type;
143 description "The maximum amount of time to wait for a shard to elect a leader before failing
144 an operation (eg transaction create).";
147 leaf shard-batched-modification-count {
149 type non-zero-uint32-type;
150 description "The number of transaction modification operations (put, merge, delete) to
151 batch before sending to the shard transaction actor. Batching improves
152 performance as less modifications messages are sent to the actor and thus
153 lessens the chance that the transaction actor's mailbox queue could get full.";
156 leaf enable-metric-capture {
159 description "Enable or disable metric capture.";
162 leaf bounded-mailbox-capacity {
164 type non-zero-uint32-type;
165 description "Max queue size that an actor's mailbox can reach";
171 description "Enable or disable data persistence";
174 leaf shard-isolated-leader-check-interval-in-millis {
176 type heartbeat-interval-type;
177 description "The interval at which the leader of the shard will check if its majority
178 followers are active and term itself as isolated";
181 leaf transaction-creation-initial-rate-limit {
183 type non-zero-uint32-type;
184 description "The initial number of transactions per second that are allowed before the data store
185 should begin applying back pressure. This number is only used as an initial guidance,
186 subsequently the datastore measures the latency for a commit and auto-adjusts the rate limit";
189 leaf transaction-debug-context-enabled {
192 description "Enable or disable transaction context debug. This will log the call site trace for
193 transactions that fail";
196 leaf custom-raft-policy-implementation {
199 description "A fully qualified java class name. The class should implement
200 org.opendaylight.controller.cluster.raft.policy.RaftPolicy. This java class should be
201 accessible to the distributed data store OSGi module so that it can be dynamically loaded via
202 reflection. For now let's assume that these classes to customize raft behaviors should be
203 present in the distributed data store module itself. If this property is set to a class which
204 cannot be found then the default raft behavior will be applied";
207 leaf shard-snapshot-chunk-size {
210 type non-zero-uint32-type;
211 description "When sending a snapshot to a follower, this is the maximum size in bytes for
215 leaf maximum-message-slice-size {
217 type non-zero-uint32-type;
218 description "When fragmenting messages thru the akka remoting framework, this is the
219 maximum size in bytes for a message slice.";
222 leaf use-tell-based-protocol {
225 description "Use a newer protocol between the frontend and backend. This feature is considered
226 exprerimental at this point.";
229 leaf file-backed-streaming-threshold-in-megabytes {
231 type non-zero-uint32-type;
232 description "When streaming large amounts of data, eg when sending a snapshot to a follower, this
233 is the threshold in terms of number of megabytes before it should switch from storing in memory to
234 buffering to a file.";
237 leaf sync-index-threshold {
239 type non-zero-uint32-type;
240 description "Permitted synchronization lag, expressed in terms of RAFT entry count. It a follower's
241 commitIndex trails the leader's journal by more than this amount of entries the follower
242 is considered to be out-of-sync.";
245 leaf backend-aliveness-timer-interval-in-seconds {
247 type non-zero-uint32-type;
248 description "The timer interval whereby, on expiration after response inactivity from the back-end,
249 the connection to the back-end is torn down and reconnection is attempted.";
252 leaf frontend-request-timeout-in-seconds {
253 default 120; // 2 minutes
254 type non-zero-uint32-type;
255 description "The timeout interval whereby client frontend transaction requests are failed.";
258 leaf frontend-no-progress-timeout-in-seconds {
259 default 900; // 15 minutes
260 type non-zero-uint32-type;
261 description "The timeout interval whereby the client front-end hasn't made progress with the
262 back-end on any request and terminates.";
265 leaf initial-payload-serialized-buffer-capacity {
267 type non-zero-uint32-type;
268 description "The initial buffer capacity, in bytes, to use when serializing message payloads.";
272 container data-store-properties-container {
273 uses data-store-properties;