Spot check not recognised by yaml schema #904

New Issue

Closed

opened 2024-08-13 04:27:03 +00:00 by deafmute1 · 6 comments

deafmute1 commented 2024-08-13 04:27:03 +00:00

Copy Link

What I'm trying to do and why

Use the spot check.

Steps to reproduce

checks:
    - name: spot
    - name: repository
      frequency: 1 week
      only_run_on:
        - Saturday
        - Sunday
    - name: data
      frequency: 2 weeks
      only_run_on:
        - Saturday
        - Sunday
    - name: extract
      frequency: 1 month
      only_run_on:
        - Saturday
        - Sunday

No matter what variations of values I try within the -name: spot block, config will not validate. Removing that block/line, the schema validates successfully.

Actual behavior

Output of borgmatic config validate:

summary:
/etc/borgmatic.d/local.yaml: Error parsing configuration file
An error occurred while parsing a configuration file at /etc/borgmatic.d/local.yaml:
At 'checks[0]': {'name': 'spot'} is not valid under any of the given schemas

Expected behavior

Spot check should be a valid name per config reference of current version.

Other notes / implementation ideas

No response

borgmatic version

1.8.13

borgmatic installation method

container: modem7/borgmatic-docker

Borg version

1.4.0

Python version

3.12.4

Database version (if applicable)

No response

Operating system and version

No response

### What I'm trying to do and why Use the spot check. ### Steps to reproduce ``` checks: - name: spot - name: repository frequency: 1 week only_run_on: - Saturday - Sunday - name: data frequency: 2 weeks only_run_on: - Saturday - Sunday - name: extract frequency: 1 month only_run_on: - Saturday - Sunday ``` No matter what variations of values I try within the `-name: spot` block, config will not validate. Removing that block/line, the schema validates successfully. ### Actual behavior Output of `borgmatic config validate`: ``` summary: /etc/borgmatic.d/local.yaml: Error parsing configuration file An error occurred while parsing a configuration file at /etc/borgmatic.d/local.yaml: At 'checks[0]': {'name': 'spot'} is not valid under any of the given schemas ``` ### Expected behavior Spot check should be a valid name per config reference of current version. ### Other notes / implementation ideas _No response_ ### borgmatic version 1.8.13 ### borgmatic installation method container: modem7/borgmatic-docker ### Borg version 1.4.0 ### Python version 3.12.4 ### Database version (if applicable) _No response_ ### Operating system and version _No response_

witten commented 2024-08-13 04:41:00 +00:00

Owner

Copy Link

Thanks for the detailed ticket! The problem is that the other spot options are required (count_tolerance_percentage, data_sample_percentage, and data_tolerance_percentage), and so the configuration validation isn't recognizing the spot check without them. That leads to the error you're seeing. See the documentation for an example and more details.

I'd love to make this situation have a better error message, but for some pretty esoteric compatibility reasons, I don't have a good way to do that right now.

Thanks for the detailed ticket! The problem is that the other `spot` options are required (`count_tolerance_percentage`, `data_sample_percentage`, and `data_tolerance_percentage`), and so the configuration validation isn't recognizing the `spot` check without them. That leads to the error you're seeing. See [the documentation](https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/#spot-check) for an example and more details. I'd love to make this situation have a better error message, but for some pretty esoteric compatibility reasons, I don't have a good way to do that right now.

witten added the

question / support

label 2024-08-13 04:41:07 +00:00

deafmute1 commented 2024-08-13 04:51:37 +00:00

Author

Copy Link

Ah, I see. I know its a very new feature, but my recommendation is to mention this in the configuration reference - its pretty much my go to for documentation for borgmatic. I also generally expect config references to mention if values are required, and assume they're optional/have a default value unless otherwise stated.

Ah, I see. I know its a very new feature, but my recommendation is to mention this in the configuration reference - its pretty much my go to for documentation for borgmatic. I also generally expect config references to mention if values are required, and assume they're optional/have a default value unless otherwise stated.

witten commented 2024-08-13 05:08:50 +00:00

Owner

Copy Link

Good idea! Where would it have been most helpful in the configuration reference? In the comment about the name option or in the comments for the individual spot-specific options?

Good idea! Where would it have been most helpful in the configuration reference? In the comment about the `name` option or in the comments for the individual `spot`-specific options?

deafmute1 commented 2024-08-13 05:12:05 +00:00

Author

Copy Link

There is validity in both to me. Looking at it currently, the description for "name" value is a bit wordy and hard to parse at a glance, so if included there I'd break the explanations of each action up with some line breaks or indentation. Otherwise, I'd include it with the values - they already mention that the values are only relevant for spot, you can simply slip and extra word or two in there.

There is validity in both to me. Looking at it currently, the description for "name" value is a bit wordy and hard to parse at a glance, so if included there I'd break the explanations of each action up with some line breaks or indentation. Otherwise, I'd include it with the values - they already mention that the values are _only_ relevant for spot, you can simply slip and extra word or two in there.

witten commented 2024-08-13 05:17:16 +00:00

Owner

Copy Link

Understood. Thank you!

Understood. Thank you!

witten referenced this issue from a commit 2024-08-13 05:51:11 +00:00

Clarify the configuration reference about the "spot" check options (#904).

witten commented 2024-08-13 05:51:59 +00:00

Owner

Copy Link

Done. These clarifications should show up on the website shortly. Thanks again!

Done. These clarifications should show up on the website shortly. Thanks again!

witten closed this issue 2024-08-13 05:51:59 +00:00

witten referenced this issue from a commit 2024-08-13 06:10:16 +00:00

Fix config validation broken by schema change (#904).

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

main

config-command-line

1.9.14

1.9.13

1.9.12

1.9.11

1.9.10

1.9.9

1.9.8

1.9.7

1.9.6

1.9.5

1.9.4

1.9.3

1.9.2

1.9.1

1.9.0

1.8.14

1.8.13

1.8.12

1.8.11

1.8.10

1.8.9

1.8.8

1.8.7

1.8.6

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.15

1.7.14

1.7.13

1.7.12

1.7.11

1.7.10

1.7.9

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.24

1.5.23

1.5.22

1.5.21

1.5.20

1.5.19

1.5.18

1.5.17

1.5.16

1.5.15

1.5.14

1.5.13

1.5.12

1.5.11

1.5.10

1.5.9

1.5.8

1.5.7

1.5.7.dev0

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.22

1.4.21

1.4.20

1.4.19

1.4.18

1.4.17

1.4.16

1.4.15

1.4.14

1.4.13

1.4.12

1.4.11

1.4.10

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.26

1.3.25

1.3.24

1.3.23

1.3.22

1.3.21

1.3.20

1.3.19

1.3.18

1.3.17

1.3.16

1.3.15

1.3.14

1.3.13

1.3.12

1.3.11

1.3.10

1.3.9

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.18

1.2.17

1.2.16

1.2.15

1.2.14

1.2.13

1.2.12

1.2.11

1.2.10

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.15

1.1.14

1.1.13

1.1.12

1.1.11

1.1.10

1.1.9

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.3

1.0.2

1.0.1

1.0.0

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

Labels

Clear labels

blocked

bug

data loss

design finalized

good first issue

new feature area

question / support

security

waiting for response

No Label

question / support

Milestone

No items

No Milestone

Assignees

Clear assignees

diivi import_bot witten

No Assignees

2 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: borgmatic-collective/borgmatic#904

No description provided.