agura commented on a change in pull request #386:
URL: https://github.com/apache/ignite-3/pull/386#discussion_r752327129
##########
File path: modules/vault/README.md
##########
@@ -1,4 +1,19 @@
# Ignite vault module
This module provides Vault API implementation.
-Note: will be filled later
+Vault is the local persistent key-value storage where node maintains its'
local state. The data stored in the vault is
+semantically divided in the following categories:
+* User-level local configuration properties (such as memory limits, network
timeouts, etc). User-level configuration
+ properties can be written both at runtime (not all properties will be
applied at runtime, however, - some of them will
+ require a full node restart) and when a node is shut down (in order to be
able to change properties that prevent node
+ startup for some reason)
+* System-level private properties (such as computed local statistics,
node-local common paths, etc). System-level
+ private properties are computed locally based on the information available
at node locally (not based on metastorage
+ watched values)
+* System-level distributed metastorage projected properties (such as paths to
partition files, etc). System-level
+ projected properties are associated with one or more metastorage properties
and are computed based on the local node
+ state and the metastorage properties values. System-level projected
properties values are semantically bound to a
+ particular revision of the dependee properties and must be recalculated when
dependees are changed (see
+ [reliable watch processing](../runner/README.md#reliable-watch-processing).
Review comment:
Add additional closing brace here.
##########
File path: modules/vault/README.md
##########
@@ -1,4 +1,19 @@
# Ignite vault module
This module provides Vault API implementation.
-Note: will be filled later
+Vault is the local persistent key-value storage where node maintains its'
local state. The data stored in the vault is
+semantically divided in the following categories:
+* User-level local configuration properties (such as memory limits, network
timeouts, etc). User-level configuration
+ properties can be written both at runtime (not all properties will be
applied at runtime, however, - some of them will
+ require a full node restart) and when a node is shut down (in order to be
able to change properties that prevent node
+ startup for some reason)
+* System-level private properties (such as computed local statistics,
node-local common paths, etc). System-level
+ private properties are computed locally based on the information available
at node locally (not based on metastorage
+ watched values)
+* System-level distributed metastorage projected properties (such as paths to
partition files, etc). System-level
+ projected properties are associated with one or more metastorage properties
and are computed based on the local node
+ state and the metastorage properties values. System-level projected
properties values are semantically bound to a
+ particular revision of the dependee properties and must be recalculated when
dependees are changed (see
+ [reliable watch processing](../runner/README.md#reliable-watch-processing).
+
+There is an implementation of Vault based on RocksDB.
Review comment:
Please, add a list of existing implementations with brief description
for each of them (What is the difference? When/why it could be used?). Also
mention FQDNs for corresponding classes with links.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
