Skip to content

Rework of component requirements related to snapshots #337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
umaucher merged 13 commits into from
Sep 24, 2026
Merged

Rework of component requirements related to snapshots #337

Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
6f0a23a
Rework of component requirements related to snapshots
tizava Jul 10, 2026
1d92ade
Review findings
tizava Jul 28, 2026
c22b5bc
Merge branch 'main' into snapshot-comp-req-rework
tizava Jul 28, 2026
fe26304
Add required attributes
tizava Jul 28, 2026
cedb55d
Make the API requirements atomic
tizava Jul 28, 2026
57ead8d
Fix problem with long requirement name
tizava Jul 28, 2026
779df9d
Merge branch 'main' into snapshot-comp-req-rework
tizava Jul 31, 2026
68b6f98
Review findings. Reset "inspected` tag and add error handling for APIs
tizava Jul 31, 2026
485cd83
fixed comment
AnnaPaolaMusio Aug 6, 2026
14a6301
Merge pull request #2 from etas-contrib/snapshot-comp-req-rework-2
tizava Aug 26, 2026
45ba4eb
Merge branch 'main' into snapshot-comp-req-rework & Fix docu build is…
tizava Aug 26, 2026
4411cef
Review findings
tizava Sep 23, 2026
746021b
Merge branch 'main' into snapshot-comp-req-rework
tizava Sep 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
185 changes: 179 additions & 6 deletions score/kvs/docs/requirements/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,84 +338,257 @@ Component Requirements
application to implement versioning, including upgrade and downgrade paths,
as needed.

.. comp_req:: Maximum Number of Snapshots
:id: comp_req__kvs__snapshot_max_num_cfg
:reqtype: Functional
:security: NO
:safety: ASIL_B
:derived_from: feat_req__persistency__cfg[version==1]
:status: valid
:version: 1
:satisfied_by: comp__persistency_kvs[version==1]
:tags: valid

The component shall maintain a configurable maximum number of snapshots.
The maximum number shall be in the range ``<0..3>``.
A value of zero shall disable snapshot operations.
A non-zero value shall specify the maximum number of snapshots.
Default value shall be: ``3``.

.. comp_req:: Snapshot Create API
:id: comp_req__kvs__snapshot_create_api
:reqtype: Functional
:security: NO
:safety: ASIL_B
:status: valid
:version: 1
:derived_from: feat_req__persistency__snapshot_create[version==1]
:satisfied_by: comp__persistency_kvs[version==1]
:tags: valid

The component shall provide an API for creating snapshots.
The API shall accept an argument that selects a snapshot slot by index.
The API should return an error when provided slot index is out of range. See :need:`comp_req__kvs__snapshot_max_num`.

.. note::

A snapshot is a point-in-time, frozen view of all values in a key-value storage.

.. comp_req:: Snapshot Create
:id: comp_req__kvs__snapshot_create
:reqtype: Functional
:security: NO
:safety: ASIL_B
:status: valid
:version: 1
:derived_from: feat_req__persistency__snapshot_create[version==1]
:satisfied_by: comp__persistency_kvs[version==1]
:tags: valid

The component shall create a new snapshot in the selected snapshot slot when the slot is empty.
Comment thread
umaucher marked this conversation as resolved.

.. comp_req:: Snapshot Overwrite
:id: comp_req__kvs__snapshot_overwrite
:reqtype: Functional
:security: NO
:safety: ASIL_B
:status: valid
:version: 1
:derived_from: feat_req__persistency__snapshot_create[version==1]
:satisfied_by: comp__persistency_kvs[version==1]
:tags: valid

The component shall overwrite the selected snapshot slot when the slot is occupied.

.. comp_req:: Snapshot Restore API
:id: comp_req__kvs__snapshot_restore_api
:reqtype: Functional
:security: NO
:safety: ASIL_B
:status: valid
:version: 1
:derived_from: feat_req__persistency__snapshot_restore[version==1]
:satisfied_by: comp__persistency_kvs[version==1]
:tags: valid

The component shall provide an API for restoring snapshots.
The API shall accept an argument that selects a snapshot slot by index.
The function shall return an error when the referenced snapshot slot is free.
The API should return an error when provided slot index is out of range. See :need:`comp_req__kvs__snapshot_max_num`.

.. comp_req:: Snapshot Remove API
:id: comp_req__kvs__snapshot_remove_api
:reqtype: Functional
:security: NO
:safety: ASIL_B
:status: valid
:version: 1
:derived_from: feat_req__persistency__snapshot_remove[version==1]
:satisfied_by: comp__persistency_kvs[version==1]
:tags: valid

The component shall provide an API for removing snapshots.
The API shall accept an argument that selects a snapshot slot by index.
The function shall return an error when the referenced slot is free.
The API should return an error when provided slot index is out of range. See :need:`comp_req__kvs__snapshot_max_num`.

.. comp_req:: Explicit Snapshot Operations
:id: comp_req__kvs__explicit_snapshot_operations
:reqtype: Functional
:security: NO
:safety: ASIL_B
:status: valid
:version: 1
:derived_from: feat_req__persistency__snapshot_create[version==1], feat_req__persistency__snapshot_restore[version==1], feat_req__persistency__snapshot_remove[version==1]
:satisfied_by: comp__persistency_kvs[version==1]
:tags: valid

The component shall perform snapshot creation, restoration, and deletion only when explicitly triggered by the user through the corresponding APIs.

.. comp_req:: Snapshot Slot Indexing
:id: comp_req__kvs__snapshot_id_api
:reqtype: Functional
:security: NO
:safety: ASIL_B
:derived_from: feat_req__persistency__snapshot_create[version==1]
:status: valid
:version: 1
:satisfied_by: comp__persistency_kvs[version==1]
:tags: valid

The component shall identify snapshot slots by a zero-based index, where the first slot has index 0, the second slot has index 1, and so on.

.. comp_req:: Snapshot Data Source
:id: comp_req__kvs__snapshot_source
:reqtype: Functional
:security: NO
:safety: ASIL_B
:status: valid
:version: 1
:derived_from: feat_req__persistency__snapshot_create[version==1]
:satisfied_by: comp__persistency_kvs[version==1]
:tags: valid

The component shall use the live values set by the user, regardless of whether the values
have been flushed to disk.

.. comp_req:: Snapshot Slot Free Query API
:id: comp_req__kvs__snapshot_slot_free_api
:reqtype: Functional
:security: NO
:safety: ASIL_B
:status: valid
:version: 1
:derived_from: feat_req__persistency__snapshot_create[version==1], feat_req__persistency__snapshot_remove[version==1], feat_req__persistency__cfg[version==1]
:satisfied_by: comp__persistency_kvs[version==1]
:tags: valid

The component shall provide an API to check whether a slot identified by a snapshot index is free or occupied.
The API should return an error when provided slot index is out of range. See :need:`comp_req__kvs__snapshot_max_num`.


.. comp_req:: Snapshot Creation
:id: comp_req__kvs__snapshot_creation
:reqtype: Functional
:security: NO
:safety: ASIL_B
:derived_from: feat_req__persistency__snapshot_create[version==1]
:status: valid
:status: invalid
:version: 1
:satisfied_by: comp__persistency_kvs[version==1]
:tags: inspected

The component shall create a snapshot each time data is stored.
Comment thread
umaucher marked this conversation as resolved.

.. note::

This requirement is invalid after change of snapshot handling (see #436)

.. comp_req:: Snapshot Maximum Number
:id: comp_req__kvs__snapshot_max_num
:reqtype: Functional
:security: NO
:safety: ASIL_B
:derived_from: feat_req__persistency__cfg[version==1]
:status: valid
:status: invalid
Comment thread
umaucher marked this conversation as resolved.
:version: 1
:satisfied_by: comp__persistency_kvs[version==1]
:tags: inspected

The component shall maintain a configurable maximum number of snapshots.

.. note::

This requirement is invalid after change of snapshot handling (see #436)

.. comp_req:: Snapshot IDs
:id: comp_req__kvs__snapshot_id
:reqtype: Functional
:security: NO
:safety: ASIL_B
:derived_from: feat_req__persistency__snapshot_create[version==1]
:status: valid
:status: invalid
:version: 1
:satisfied_by: comp__persistency_kvs[version==1]
:tags: inspected

The component shall assign the ID 1 to the newest snapshot and shall increment the IDs of older snapshots accordingly.

.. note::

This requirement is invalid after change of snapshot handling (see #436)

.. comp_req:: Snapshot Rotation
:id: comp_req__kvs__snapshot_rotate
:reqtype: Functional
:security: NO
:safety: ASIL_B
:derived_from: feat_req__persistency__snapshot_remove[version==1],feat_req__persistency__snapshot_restore[version==1]
:status: valid
:status: invalid
:version: 1
:satisfied_by: comp__persistency_kvs[version==1]
:tags: inspected

The component shall rotate and delete the oldest snapshot when the maximum number is reached.

.. note::

This requirement is invalid after change of snapshot handling (see #436)

.. comp_req:: Snapshot Restore
:id: comp_req__kvs__snapshot_restore
:reqtype: Functional
:security: NO
:safety: ASIL_B
:derived_from: feat_req__persistency__snapshot_restore[version==1]
:status: valid
:status: invalid
:version: 1
:satisfied_by: comp__persistency_kvs[version==1]
:tags: inspected

The component shall allow restoration of a snapshot by its ID.

.. note::

This requirement is invalid after change of snapshot handling (see #436)

.. comp_req:: Snapshot Deletion
:id: comp_req__kvs__snapshot_delete
:reqtype: Functional
:security: NO
:safety: ASIL_B
:derived_from: feat_req__persistency__snapshot_remove[version==1]
:status: valid
:status: invalid
:version: 1
:satisfied_by: comp__persistency_kvs[version==1]
:tags: inspected

The component shall allow deletion of individual snapshots.

.. note::

This requirement is invalid after change of snapshot handling (see #436)

.. comp_req:: Engineering Mode
:id: comp_req__kvs__eng_mode
:reqtype: Functional
Expand Down
Loading