feat!: redefine hostname as a required property that maps to --host #256
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a breaking change with existing backrest behavior. On next access of the backrest UI clients will be required to set an explicit hostname for each backrest node. Host names are immutable (only changeable by manually editing the config) and are associated with all snapshots. Backrest will only manage snapshots with a hostname tag matching the current host. A migration plan for existing snapshots will be included in a followup.
garethgeorge
added a commit
that referenced
this pull request
May 5, 2024
garethgeorge
added a commit
that referenced
this pull request
May 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is backrest's first breaking change. It adds host as a required property in the config. Because host changed to an immutable property in this PR any value set in existing configs will be reset to allow users to explicitly pick a value they are happy with when they next open the backrest UI.
This warrants a breaking change because it changes the way backups are managed, Backrest will now check that snapshots under management have the expected plan ID and that they came from the same backrest installation. This paves the way for multi-host management with backrest (e.g. multiple hosts backing up to a single repository).
I expect this to be a 1 time breaking change and the transition to the
1.0.0release of backrest feels like a good time to do this.A follow up PR will implement logic to migrate existing snapshots by tagging them for management by the first backrest installation to index them and with a matching plan in its config.
The call to action is surfaced to users by