stored: add new volume status 'Unlabeled' by florian-at-bareos · Pull Request #2207 · bareos/bareos

florian-at-bareos · 2025-03-12T07:35:26Z

This status is the initial status when a new volume is created in the catalog and is changed if the storage daemon (successfully) wrote on the volume.

Fixes #1804

Currently:

the sd asks for a new volume to append to
the director creates a new record in the catalog with that new volume with "Append" status and sends the information to the sd
the sd can't label the volume, errors out
-> the volume record with "Append" status persists in the catalog even if no volume with that name was ever created by the sd

With this PR:

the sd asks for a new volume to append to
the director creates a new record in the catalog with that new volume with "Unlabeled" status and sends the information to the sd
the sd can't label the volume, errors out
-> the volume record with "Unlabeled" status persists in the catalog and is selected again if the sd asks for a volume to append to until labeling works

If the sd successfully wrote on the "Unlabeled" volume, its status is updated to "Append", "Full" or whatever the sd decides.

Note:
Manually updating an existing volume record in the catalog to the status "Unlabeled" is not dangerous, no backup data is ever overwritten!
When the sd wants to send volume updates to the director, and the status is "Unlabeled" but has written bytes, the status is set to "Append".

Update docs accordingly

Thank you for contributing to the Bareos Project!

Please check

Short description and the purpose of this PR is present above this paragraph
Your name is present in the AUTHORS file (optional)

If you have any questions or problems, please give a comment in the PR.

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

Make sure you check/merge the PR using devtools/pr-tool to have some simple automated checks run and a proper changelog record added.

General

Is the PR title usable as CHANGELOG entry?
Purpose of the PR is understood
Commit descriptions are understandable and well formatted
~~Required backport PRs have been created~~
Correct milestone is set

Source code quality

Source code changes are understandable
Variable and function names are meaningful
Code comments are correct (logically and spelling)
Required documentation changes are present and part of the PR

florian-at-bareos · 2025-03-19T14:39:13Z

Currently, when manually labeling a volume its status is set to unlabeled

arogge

You'll need to upgrade the database correctly. This means we need to introduce a new database version and create a migration script for that.
As far as I can tell an unlabeled volume was definitely never written to (as the label would have been written first), so neither the purge nor the prune operation makes sense on such a volume.
When selecting a volume, I think we should prefer appendable volumes over unlabeled ones

core/src/cats/ddl/creates/postgresql.sql

florian-at-bareos · 2025-04-09T08:50:57Z

I don't know how to write such a migration script and how much effort it is
You're right, that is a little awkward but it was necessary to integrate with the existing behaviour because otherwise "purge" and "prune" commands would just fail for a newly created volume which it doesn't currently. I'll think about how one can make this more intuitive.
that's the behaviour of the current changes

maybe we can discuss sometime how to pursue with this.

arogge · 2025-04-09T09:00:36Z

I don't know how to write such a migration script and how much effort it is

The migration scripts are in core/src/cats/ddl/updates.
We have a schema version (usually that's the Bareos target version prefixed by a 2 and suffixed with a 0, i.e. 2250 for Bareos 25), this must be set correctly in the create-script, too.

For the upgrade script you create a new file (probably based on an existing one) named postgresql.<old_db_version>_<new_db_version>.sql that contains the commands required to transition the old database schema into the new one. Everything should be wrapped into a transaction (i.e. begin and commit) and the version update should be the last things before the transaction commit.

When changing the database version, you also have to change the #define BDB_VERSION in core/src/cats/cats.h so Bareos knows what database version to expect.

arogge · 2025-04-09T09:18:33Z

You're right, that is a little awkward but it was necessary to integrate with the existing behaviour because otherwise "purge" and "prune" commands would just fail for a newly created volume which it doesn't currently. I'll think about how one can make this more intuitive.

That's actually a good point. I think it doesn't make much sense to support purge/prune on these volumes, but you're right that it should probably not fail either.
Maybe it makes sense to just ignore volumes (maybe with a message) that are in status Unlabeled for prune/purge operations?

core/src/dird/next_vol.cc

core/src/dird/ua_label.cc

core/src/dird/ua_purge.cc

core/src/stored/askdir.cc

core/src/dird/next_vol.cc

sebsura

These are some great changes!

sebsura · 2025-06-05T07:54:30Z

docs/manuals/source/DeveloperGuide/catalog.rst

 | VolStatus        | text      | | Status of media:                      |
-|                  |           | | Full, Archive, Append,                |
+|                  |           | | Unlabeled, Full, Archive, Append,     |
 |                  |           |   Recycle, Read-Only, Disabled, Error,  |
 |                  |           |   Busy                                  |


sebsura · 2025-06-05T07:55:12Z

docs/manuals/source/DeveloperGuide/catalog.rst

+| NewVolStatus | integer   | enum: Unlabeled, Full, Archive, Append,       |
+|              |           | Recycle, Purged, Read-only, Disabled, Error,  |
+|              |           | Busy, Used, Cleaning                          |


The same applies here: i get a scroll bar for the table. You can just split it up like we did above.

core/src/stored/dir_cmd.cc

sebsura · 2025-06-05T08:10:19Z

You should also squash the commits a bit. There are some check sources/undo commits in there.

arogge · 2025-07-08T15:10:13Z

@sebsura I squashed some of the commits. Do you want to take another look at this?

this status is the original status when a new volume is created in the catalog and is changed if the storage daemon (successfully) wrote on the volume.

If you manually set the volume status of a volume to "Unlabeled", the sd corrects this status after successfully writing to the volume.

DoLabel returns whether labelling suceeded or not and not whether the console connection should be killed.

such that the VolStatus is not "Unlabeled" after labeling but "Append".

arogge

This is a great improvement for that nasty annoyance when your filesystem is full (or something else went wrong).
Looks great and tested OK.

florian-at-bareos added the bug This addresses a bug label Mar 12, 2025

florian-at-bareos added this to the 25.0.0 milestone Mar 12, 2025

florian-at-bareos self-assigned this Mar 12, 2025

florian-at-bareos force-pushed the dev/fburger/master/fix-media-record branch from 2d99d80 to 2ff782f Compare March 12, 2025 14:26

florian-at-bareos added the enhancement label Mar 13, 2025

florian-at-bareos force-pushed the dev/fburger/master/fix-media-record branch from 2ff782f to 67f2ded Compare March 14, 2025 14:02

arogge self-requested a review March 17, 2025 10:26

florian-at-bareos marked this pull request as ready for review March 24, 2025 08:16

arogge requested changes Apr 1, 2025

View reviewed changes

core/src/cats/ddl/creates/postgresql.sql Show resolved Hide resolved

core/src/cats/ddl/creates/postgresql.sql Show resolved Hide resolved

arogge requested changes Apr 9, 2025

View reviewed changes

core/src/dird/next_vol.cc Outdated Show resolved Hide resolved

florian-at-bareos force-pushed the dev/fburger/master/fix-media-record branch from 73282af to 270eea4 Compare April 23, 2025 14:09

florian-at-bareos requested a review from arogge April 24, 2025 10:58

sebsura requested changes May 27, 2025

View reviewed changes

core/src/dird/ua_label.cc Outdated Show resolved Hide resolved

core/src/dird/ua_purge.cc Show resolved Hide resolved

core/src/stored/askdir.cc Show resolved Hide resolved

core/src/dird/next_vol.cc Show resolved Hide resolved

florian-at-bareos force-pushed the dev/fburger/master/fix-media-record branch from 270eea4 to ced3746 Compare June 2, 2025 09:09

florian-at-bareos requested a review from sebsura June 3, 2025 15:11

sebsura requested changes Jun 5, 2025

View reviewed changes

core/src/stored/dir_cmd.cc Show resolved Hide resolved

florian-at-bareos force-pushed the dev/fburger/master/fix-media-record branch 2 times, most recently from efa5bae to 6e6353e Compare June 11, 2025 06:44

arogge force-pushed the dev/fburger/master/fix-media-record branch 2 times, most recently from a5ab259 to 98d4e31 Compare July 8, 2025 15:09

florian-at-bareos added 3 commits July 29, 2025 15:06

stored: add new volume status 'Unlabeled'

68c88f0

this status is the original status when a new volume is created in the catalog and is changed if the storage daemon (successfully) wrote on the volume.

stored: fix manual "Unlabeled" volume status

2d94efc

If you manually set the volume status of a volume to "Unlabeled", the sd corrects this status after successfully writing to the volume.

dird: use "Append" over "Unlabeled" volumes

5da29a6

florian-at-bareos added 5 commits July 29, 2025 15:06

dird: "Unlabeled" volumes are ValidOrRecyclable

f23dd57

label: change DoLabel return-type meaning

a04f4e1

DoLabel returns whether labelling suceeded or not and not whether the console connection should be killed.

dird: update VolStatus on label

dd092b6

such that the VolStatus is not "Unlabeled" after labeling but "Append".

docs: update docs to include 'Unlabeled' VolStatus

a4b65cc

dird: move volume status change to one place

0bd41e2

arogge force-pushed the dev/fburger/master/fix-media-record branch from 98d4e31 to 0bd41e2 Compare July 29, 2025 13:06

apply bareos-check-sources

612ae3e

arogge requested a review from sebsura July 29, 2025 13:59

arogge approved these changes Jul 29, 2025

View reviewed changes

sebsura approved these changes Jul 30, 2025

View reviewed changes

Update CHANGELOG.md

db07b0b

BareosBot merged commit 521f5cc into bareos:master Jul 30, 2025

Conversation

florian-at-bareos commented Mar 12, 2025 • edited by arogge Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Thank you for contributing to the Bareos Project!

Please check

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

General

Source code quality

Uh oh!

florian-at-bareos commented Mar 19, 2025

Uh oh!

arogge left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

florian-at-bareos commented Apr 9, 2025

Uh oh!

arogge commented Apr 9, 2025

Uh oh!

arogge commented Apr 9, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sebsura left a comment

Choose a reason for hiding this comment

Uh oh!

sebsura Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

sebsura Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sebsura commented Jun 5, 2025

Uh oh!

arogge commented Jul 8, 2025

Uh oh!

arogge left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

florian-at-bareos commented Mar 12, 2025 •

edited by arogge

Loading