Skip to content

Commit a5216f3

Browse files
committed
Add SRU exception for Valkey
1 parent 08c8532 commit a5216f3

File tree

2 files changed

+143
-0
lines changed

2 files changed

+143
-0
lines changed
Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
.. _reference-exception-ValkeyUpdates:
2+
3+
.. _valkey_updates:
4+
5+
Valkey Updates
6+
===============
7+
8+
This document describes the policy for doing micro-release updates of
9+
the Valkey package in Ubuntu stable releases.
10+
11+
.. _about_valkey:
12+
13+
About Valkey
14+
------------
15+
16+
`Valkey <https://valkey.io/>`__ is an open source VPN high-performance
17+
key/value datastore that supports a variety of workloads such as caching,
18+
message queues, and can act as a primary database.
19+
20+
21+
Valkey Upstream release policy
22+
-------------------------------
23+
24+
The Valkey community maintains multiple versions in parallel. According
25+
to their `supported versions
26+
documentation <https://valkey.io/topics/releases/>`__:
27+
28+
- The latest stable release is always fully supported and maintained.
29+
- All latest minor version of each major version will have extended
30+
security support for 5 years.
31+
- Every minor release will be fully supported with bug fixes for 3 years.
32+
33+
When it comes to updates in Ubuntu, the latest micro release for each
34+
corresponding minor release should be considered for SRU. When security updates
35+
are included in a new micro release, the update should also be added to the
36+
security pocket through a no-change rebuild after releasing to the updates
37+
pocket.
38+
39+
.. _ubuntu_and_valkey_releases_affected_by_this_mre:
40+
41+
Ubuntu and Valkey releases affected by this MRE
42+
------------------------------------------------
43+
44+
Currently, these are the Ubuntu releases and the corresponding Valkey
45+
package versions affected by this policy:
46+
47+
- Resolute (26.04): Valkey 9.0.x (projected)
48+
- Questing (25.10): Valkey 8.1.x
49+
- Plucky (25.04): Valkey 8.0.x
50+
- Noble (24.04): Valkey 7.2.x
51+
52+
QA
53+
--
54+
55+
Upstream tests
56+
^^^^^^^^^^^^^^
57+
58+
Valkey contains a set of build and regression tests which are executed
59+
for each commit and release via `GitHub
60+
Actions <https://github.com/valkey-io/valkey/actions>`__. Upstream tests
61+
are provided in the `tests/
62+
directory <https://github.com/valkey-io/valkey/tree/unstable/tests>`__.
63+
64+
Autopkgtest
65+
^^^^^^^^^^^
66+
67+
The package contains five DEP-8 tests in every supported Ubuntu release, along
68+
with one extra in noble and plucky:
69+
70+
- valkey-cli - Smoke test to confirm valkey-cli can show info and version.
71+
- benchmark - Run the benchmark command and display its info.
72+
- valkey-check-aof - Smoke test to confirm the check-aof command runs.
73+
- valkey-check-rdb - Run a synchronous save then confirm the check-rdb command
74+
runs successfully.
75+
- cjson - Confirm the cjson module can be loaded and used.
76+
- migrate-from-redis - (Noble and Plucky only) Confirm that using the
77+
valkey-redis-compat package to migrate data from a Redis server succeeds by
78+
default.
79+
80+
These tests are extensive enough to catch major errors when it comes to
81+
the integration of Valkey with Ubuntu, specifically when starting valkey-server
82+
and running standard cli commands, along with issues in setup and compatibility
83+
with Redis if relevant.
84+
85+
Valkey Update Process
86+
----------------------
87+
88+
As with regular MREs, the aim here is to offer bugfixes and security
89+
fixes to all supported releases.
90+
91+
To do this we will:
92+
93+
#. File a bug to cover the upgrade.
94+
95+
- Add tasks to all Ubuntu releases which will be updated.
96+
- Add a link to the upstream changelog and list major changes.
97+
98+
#. Make sure the development release contains the fixes that will be added. In general this should be the case as long as it is up to date with its associated micro release version.
99+
#. Setup merges with each new version.
100+
#. Run autopkgtest on all supported architectures.
101+
#. Upload the microrelease to the SRU queue and wait until it is approved.
102+
#. Watch the migration page until it lands in the -updates pocket. Fix any regression that might appear during the process.
103+
104+
105+
Valkey SRU template
106+
--------------------
107+
108+
.. code-block:: text
109+
110+
This bug tracks an update for the Valkey package, moving to versions:
111+
112+
* [Release codename] ([Release version]): Valkey [Valkey version - highest possible number on the last digit]
113+
* [...]
114+
115+
These updates include bug fixes following the SRU special case documentation at https://documentation.ubuntu.com/sru/en/latest/reference/exception-Valkey-Updates
116+
117+
[Upstream changes]
118+
119+
TODO: List updates, CVE fixes, and relevant bug fixes
120+
TODO: Add a link to the upstream changelog
121+
122+
[Test Plan]
123+
124+
TODO: Check DEP-8 and reverse-depends DEP-8 tests pass
125+
TODO: if there are any non passing tests - explain why that is ok in this case
126+
TODO: add results of an autopkgtest run against all the new versions
127+
128+
[Regression Potential]
129+
130+
Upstream has an extensive build and integration test suite. So regressions would likely arise from a change in interaction with Ubuntu-specific integrations.
131+
132+
TODO: consider any other regression potential specific to the version being
133+
updated and list if any.

docs/SRU/reference/package-specific.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ the Technical Board.
7575
exception-google-guest-agent-Updates
7676
exception-google-osconfig-agent-Updates
7777
exception-rax-nova-agent-Updates
78+
exception-Valkey-Updates
7879
exception-walinuxagent-Updates
7980
exception-wslu-Updates
8081

@@ -536,6 +537,15 @@ The 'mariadb' and 'galera' source packages, including source package variants
536537
with version suffixes, may be uploaded according to the proceedure documented in
537538
:ref:`MariaDB-Galera-Updates <reference-exception-MariaDB-Galera-Updates>`.
538539

540+
Valkey
541+
~~~~~~
542+
543+
The valkey source package may be uploaded according to the procedure
544+
documented in :ref:`Valkey-Updates <reference-exception-ValkeyUpdates>`.
545+
This stable release exception `has been
546+
approved <TBD>`__ by [TBD] for the
547+
SRU team as of [TBD].
548+
539549
GRUB
540550
~~~~
541551

0 commit comments

Comments
 (0)