From Fedora Project Wiki

No edit summary
(Announcing the Change proposal)
Line 1: Line 1:
{{admon/important | Comments and Explanations | The page source contains comments providing guidance to fill out each section. They are invisible when viewing this page. To read it, choose the "view source" link.<br/> '''Copy the source to a ''new page'' before making changes!  DO NOT EDIT THIS TEMPLATE FOR YOUR CHANGE PROPOSAL.'''}}
{{admon/tip | Guidance | For details on how to fill out this form, see the [https://docs.fedoraproject.org/en-US/program_management/changes_guide/ documentation].}}
<!-- The actual name of your proposed change page should look something like: Changes/Your_Change_Proposal_Name.  This keeps all change proposals in the same namespace -->
= Switching Cyrus Sasl from BerkeleyDB to GDBM =
= Switching Cyrus Sasl from BerkeleyDB to GDBM =


Line 24: Line 18:


== Current status ==
== Current status ==
[[Category:ChangeReadyForWrangler]]
[[Category:ChangeAnnounced]]
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
Line 156: Line 150:


== Contingency Plan ==
== Contingency Plan ==
Revert the shipped configuration
* Contingency mechanism: Revert the shipped configuration
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
* Contingency mechanism: (What to do?  Who will do it?) N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
* Contingency deadline: Feature freeze date  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Contingency deadline: Beta freeze
<!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
<!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
* Blocks release? Yes <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Blocks release? Yes <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->

Revision as of 20:29, 7 April 2021

Switching Cyrus Sasl from BerkeleyDB to GDBM

Summary

cyrus-sasl package was built with libdb requirement, now it is replaced by gdbm.

Owner


Current status

  • Targeted release: Fedora Linux 35
  • Last updated: 2021-04-07
  • FESCo issue: <will be assigned by the Wrangler>
  • Tracker bug: <will be assigned by the Wrangler>
  • Release notes tracker: <will be assigned by the Wrangler>

Detailed Description

This change switches the default backend Key-Value DB used by sasldb plugin from BerkeleyDB to GDBM and provides a migration tool for automatic conversion from old to new format.

Feedback

Benefit to Fedora

According to more restrictive libdb licence policy exists effort to remove libdb's dependencies. cyrus-sasl package can now be built without libdb requirement.


Scope

  • Proposal owners:
  • Other developers:

The owners of the packages depending on cyrus-sasl sasldb plugin should provide the documentation about the migration procedure.

  • Release engineering: [1]
  • Policies and guidelines: not needed for this Change
  • Trademark approval: N/A (not needed for this Change)
  • Alignment with Objectives:

Upgrade/compatibility impact

The migration script should be used to upgrade the particular databases used by specific applications via sasldb plugin


How To Test

  • Install the new version of the cyrus-sasl.
  • Use the migration tool bdb2current provided by the package to migrate your sasldb file
  • update the configuration file to point on the new sasldb file
  • restart the application if necessary
  • Check that auth is still working


User Experience

Dependencies

A lot of application use cyrus-sasl sasldb plugins. Their maintainers were notified via email and some of them have responded.


Contingency Plan

  • Contingency mechanism: Revert the shipped configuration
  • Contingency deadline: Beta freeze
  • Blocks release? Yes


Documentation

Here is the notification sent to known developers of the depending packages:

New version of the cyrus-sasl is planned to use the gdbm database for the sasldb plugins.

I've implemented the patch (https://src.fedoraproject.org/rpms/cyrus-sasl/pull-request/3#request_diff) changing the default DB and implementing the migration tool to make the switching from BerkeleyDB to GDBM seamless.

I kindly ask you to check the information in the following spreadsheet: https://docs.google.com/spreadsheets/d/1z5eTSm3rtlKtEKPCxhI_wE861Xzg8kbvINWixSwQmLg/edit?usp=sharing:

whether your package is affected by the proposed change whether the migration tool is suitable for your purposes

and let me know or mark the results in the table

Release Notes

a new version of the cyrus-sasl package is landing in rawhide.

This version changes the database used to store saslauthdb data. This is part of the move to deprecate use of Berkley DB. The new package will use GDBM instead.

We provided a tool to perform migrations for database should that be needed by a package:

The syntax of the migration tool is bdb2current <sasldb path> <new_path>

Please check whether your packages use the sasldb plugin and provide a relevant migration guideline.

Retrieved from "https://fedoraproject.org/w/index.php?title=Change/CyrusSaslBerkeleyDBtoGdbm&oldid=611305"