Add snapshot restore validator #1191
Open
Conversation
This file contains hidden or 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
jferrazbr
force-pushed
the
add-snap-restore-validator
branch
from
ba25be2 to
88b2c50
Compare
jiaqiluo
approved these changes
Nov 25, 2025
jakefhyde
requested changes
Nov 26, 2025
|
|
||
| // parseSnapshotClusterSpec decodes snapshot.SnapshotFile.Metadata into a v1.ClusterSpec. | ||
| // The metadata is stored as a nested, gzipped, base64-encoded structure. | ||
| func parseSnapshotClusterSpec(snap *rkev1.ETCDSnapshot) (*v1.ClusterSpec, error) { |
Contributor
There was a problem hiding this comment.
We copy this from Rancher correct? I wonder if we could move this to github.com/rancher/rancher/pkg/apis/provisioning.cattle.io/v1 somewhere.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Issue: rancher/rancher#52574
Problem
When restoring from an ETCD snapshot, the webhook did not validate the snapshot metadata before accepting
spec.rkeConfig.etcdSnapshotRestore.It was possible to request
"kubernetesVersion"or"all"forrestoreRKEConfigeven when the referenced snapshot had missing or invalid metadata.This led to restore requests that passed admission but failed later in the restore flow with parse errors.
Solution
This PR adds a validator for
spec.rkeConfig.etcdSnapshotRestoreonprovisioning.cattle.io/v1, Clusterand wires the RKE client into the webhookClientsstruct.The validator:
etcdSnapshotRestorechanges from empty to a new non empty value, so it does not block unrelated cluster updates.etcdSnapshotRestore.nameexists in the same namespace.etcdSnapshotRestore.restoreRKEConfigis one of"none","kubernetesVersion", or"all"."kubernetesVersion", requires akubernetesVersion, and for"all", requires bothkubernetesVersionandrkeConfig.In addition:
pkg/server/handlers.gowas moved to a management cluster only list so that validation only runs where snapshot resources exist (local/management cluster). This avoids issues on downstream clusters that do not have the snapshot resources.Docs are updated to describe the new validation behavior, and unit tests cover the main success and failure paths.
This partially addresses the linked issue by validating snapshot metadata before restore. The annotation based mode filtering will be handled in a follow up change.
CheckList