Skip to content

Commit 4dc266d

Browse files
sbachmann-qorixvinodreddy-g
authored andcommitted
persistency_kvs: integrated FT review from 2025-05-15
Signed-off-by: Sven Bachmann <[email protected]>
1 parent 835ec7e commit 4dc266d

File tree

2 files changed

+17
-28
lines changed

2 files changed

+17
-28
lines changed

docs/features/persistency/kvs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To activate this feature, use the following feature flag:
3838
Abstract
3939
========
4040

41-
This feature request describes the key-value storage that is needed by
41+
This feature request describes the key-value storage (KVS) that is needed by
4242
applications to store either temporary or permanent data in an easy way that
4343
conforms to most programming languages that provide a hash, hashmap, dictionary
4444
or similar data structure. Access to the KVS is possible from any support

docs/features/persistency/kvs/requirements/index.rst

Lines changed: 16 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,17 @@ Requirements
2323
:satisfies: stkh_req__dev_experience__prog_languages
2424
:status: valid
2525

26-
The key-value storage system shall provide concurrent access through both C++ and Rust interfaces.
26+
The KVS system shall provide access through both C++ and Rust interfaces.
2727

2828
.. feat_req:: Maximum Size
2929
:id: feat_req__kvs__maximum_size
3030
:reqtype: Functional
3131
:security: NO
3232
:safety: ASIL_B
3333
:satisfies: stkh_req__functiona_req__support_of_store
34-
:status: valid
35-
36-
The key-value storage system shall support specification of its maximum capacity at compile time.
37-
38-
.. feat_req:: Thread Safety
39-
:id: feat_req__kvs__thread_safety
40-
:reqtype: Functional
41-
:security: NO
42-
:safety: ASIL_B
43-
:satisfies: stkh_req__functiona_req__support_of_store
44-
:status: valid
34+
:status: invalid
4535

46-
The key-value storage system shall provide thread-safe access on a per-key basis.
36+
The KVS system shall support specification of its maximum capacity at compile time.
4737

4838
.. feat_req:: Multiple KVS per Software Architecture Element
4939
:id: feat_req__kvs__multiple_kvs
@@ -53,7 +43,7 @@ Requirements
5343
:satisfies: stkh_req__functiona_req__support_of_store
5444
:status: valid
5545

56-
The key-value storage system shall allow instantiating multiple independent stores per software architecture element.
46+
The KVS system shall allow instantiating multiple independent stores per software architecture element.
5747

5848
.. feat_req:: Supported Datatypes (Keys)
5949
:id: feat_req__kvs__supported_datatypes_keys
@@ -63,7 +53,7 @@ Requirements
6353
:satisfies: stkh_req__functiona_req__support_of_store
6454
:status: valid
6555

66-
The key-value storage system shall support UTF-8 encoded strings as valid key types.
56+
The KVS system shall support UTF-8 encoded strings as valid key types.
6757

6858
.. feat_req:: Supported Datatypes (Values)
6959
:id: feat_req__kvs__supported_datatypes_values
@@ -73,7 +63,7 @@ Requirements
7363
:satisfies: stkh_req__functiona_req__support_of_store
7464
:status: valid
7565

76-
The key-value storage system shall support storing both primitive and non-primitive datatypes as values.
66+
The KVS system shall support storing both primitive and non-primitive datatypes as values.
7767
The supported datatypes shall match those used by the IPC feature.
7868

7969
.. feat_req:: Default Values
@@ -84,8 +74,7 @@ Requirements
8474
:satisfies: stkh_req__functiona_req__support_of_store
8575
:status: valid
8676

87-
The key-value storage system shall support predefined default values for keys, specified via a configuration file.
88-
Note: Not every key is required to have a default value.
77+
The KVS system shall support predefined default values for keys.
8978

9079
.. feat_req:: Default Value Retrieval
9180
:id: feat_req__kvs__default_value_retrieval
@@ -95,7 +84,7 @@ Requirements
9584
:satisfies: stkh_req__functiona_req__support_of_store
9685
:status: valid
9786

98-
The key-value storage system shall support retrieving the default value associated with a key.
87+
The KVS system shall support retrieving the default value associated with a key.
9988

10089
.. feat_req:: Default Value Reset
10190
:id: feat_req__kvs__default_value_reset
@@ -105,7 +94,7 @@ Requirements
10594
:satisfies: stkh_req__functiona_req__support_of_store
10695
:status: valid
10796

108-
The key-value storage system shall support resetting a single key or all keys to their respective default values.
97+
The KVS system shall support resetting a single key or all keys to their respective default values.
10998

11099
.. feat_req:: Persistency
111100
:id: feat_req__kvs__persistency
@@ -115,7 +104,7 @@ Requirements
115104
:satisfies: stkh_req__functiona_req__support_of_store
116105
:status: valid
117106

118-
The key-value storage system shall persist stored data and provide an API to explicitly trigger persistence.
107+
The KVS system shall persist stored data and provide an API to explicitly trigger persistence.
119108

120109
.. feat_req:: Integrity Check
121110
:id: feat_req__kvs__integrity_check
@@ -125,7 +114,7 @@ Requirements
125114
:satisfies: stkh_req__functiona_req__support_of_store
126115
:status: valid
127116

128-
The key-value storage system shall detect and report data corruption.
117+
The KVS system shall detect and report data corruption.
129118
Note: Implementation depends on AoUs.
130119

131120
.. feat_req:: Versioning
@@ -136,7 +125,7 @@ Requirements
136125
:satisfies: stkh_req__functiona_req__support_of_store
137126
:status: valid
138127

139-
The key-value storage system shall support versioning for different layout configurations.
128+
The KVS system shall support versioning for different layout configurations.
140129

141130
.. feat_req:: Update Mechanism
142131
:id: feat_req__kvs__update_mechanism
@@ -146,7 +135,7 @@ Requirements
146135
:satisfies: stkh_req__functiona_req__support_of_store
147136
:status: valid
148137

149-
The key-value storage system shall implement mechanisms to upgrade from one version to another, including multi-version jumps.
138+
The KVS system shall implement mechanisms to upgrade from one version to another, including multi-version jumps.
150139

151140
.. feat_req:: Snapshots
152141
:id: feat_req__kvs__snapshots
@@ -156,7 +145,7 @@ Requirements
156145
:satisfies: stkh_req__functiona_req__support_of_store
157146
:status: valid
158147

159-
The key-value storage system shall support explicit creation of snapshots identified by unique IDs and allow rollback to previous snapshots.
148+
The KVS system shall support explicit creation of snapshots identified by unique IDs and allow rollback to previous snapshots.
160149
Snapshots shall also be deletable.
161150

162151
.. feat_req:: Tooling
@@ -167,7 +156,7 @@ Requirements
167156
:satisfies: stkh_req__functiona_req__support_of_store
168157
:status: valid
169158

170-
The key-value storage system shall provide tooling support for viewing and modifying key-value pairs during development and debugging.
159+
The KVS system shall provide tooling support for viewing and modifying key-value pairs during development and debugging.
171160

172161
.. feat_req:: Stable APIs
173162
:id: feat_req__kvs__stable_api
@@ -272,7 +261,7 @@ Requirements
272261

273262
The KVS shall ensure that key operations are typically completed within 5 milliseconds.
274263

275-
.. feat_req:: Intra-process communication
264+
.. feat_req:: Intra-Process Data Access
276265
:id: feat_req__kvs__intra_process_comm
277266
:reqtype: Functional
278267
:security: NO

0 commit comments

Comments
 (0)