feat(backups): backup api rework #1873
+1,892
−498
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // Package v1alpha1 defines backups.cozystack.io API types. | ||
| // | ||
| // Group: backups.cozystack.io | ||
| // Version: v1alpha1 | ||
| package v1alpha1 | ||
|
|
||
| import ( | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
| ) | ||
|
|
||
| func init() { | ||
| SchemeBuilder.Register(func(s *runtime.Scheme) error { | ||
| s.AddKnownTypes(GroupVersion, | ||
| &BackupClass{}, | ||
| &BackupClassList{}, | ||
| ) | ||
| return nil | ||
| }) | ||
| } | ||
|
|
||
| // +kubebuilder:object:root=true | ||
| // +kubebuilder:resource:scope=Cluster | ||
| // +kubebuilder:subresource:status | ||
|
|
||
| // BackupClass defines a class of backup configurations that can be referenced | ||
| // by BackupJob and Plan resources. It encapsulates strategy and storage configuration | ||
| // per application type. | ||
| type BackupClass struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ObjectMeta `json:"metadata,omitempty"` | ||
|
|
||
| Spec BackupClassSpec `json:"spec,omitempty"` | ||
| Status BackupClassStatus `json:"status,omitempty"` | ||
| } | ||
|
|
||
| // +kubebuilder:object:root=true | ||
|
|
||
| // BackupClassList contains a list of BackupClasses. | ||
| type BackupClassList struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ListMeta `json:"metadata,omitempty"` | ||
| Items []BackupClass `json:"items"` | ||
| } | ||
|
|
||
| // BackupClassSpec defines the desired state of a BackupClass. | ||
| type BackupClassSpec struct { | ||
| // Strategies is a list of backup strategies, each matching a specific application type. | ||
| Strategies []BackupClassStrategy `json:"strategies"` | ||
| } | ||
|
|
||
| // BackupClassStrategy defines a backup strategy for a specific application type. | ||
| type BackupClassStrategy struct { | ||
| // StrategyRef references the driver-specific BackupStrategy (e.g., Velero). | ||
| // This references a cluster-scoped resource, so it does not include a namespace. | ||
| StrategyRef TypedClusterObjectReference `json:"strategyRef"` | ||
|
|
||
| // Application specifies which application types this strategy applies to. | ||
| Application ApplicationSelector `json:"application"` | ||
|
|
||
| // Parameters holds strategy-specific and storage-specific parameters. | ||
| // Common parameters include: | ||
| // - backupStorageLocationName: Name of Velero BackupStorageLocation | ||
| // +optional | ||
| Parameters map[string]string `json:"parameters,omitempty"` | ||
| } | ||
|
|
||
| // TypedClusterObjectReference contains enough information to let you locate a | ||
| // cluster-scoped typed resource. It does not include a namespace because | ||
| // cluster-scoped resources do not have namespaces. | ||
| type TypedClusterObjectReference struct { | ||
| // APIGroup is the group for the resource being referenced. | ||
| // If APIGroup is not specified, the specified Kind must be in the core API group. | ||
| // For any other third-party types, APIGroup is required. | ||
| // +optional | ||
| APIGroup *string `json:"apiGroup,omitempty"` | ||
|
|
||
| // Kind is the type of resource being referenced. | ||
| Kind string `json:"kind"` | ||
|
|
||
| // Name is the name of resource being referenced. | ||
| Name string `json:"name"` | ||
| } | ||
|
|
||
| // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. | ||
| func (in *TypedClusterObjectReference) DeepCopyInto(out *TypedClusterObjectReference) { | ||
| *out = *in | ||
| if in.APIGroup != nil { | ||
| in, out := &in.APIGroup, &out.APIGroup | ||
| *out = new(string) | ||
| **out = **in | ||
| } | ||
| } | ||
|
|
||
| // DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TypedClusterObjectReference. | ||
| func (in *TypedClusterObjectReference) DeepCopy() *TypedClusterObjectReference { | ||
| if in == nil { | ||
| return nil | ||
| } | ||
| out := new(TypedClusterObjectReference) | ||
| in.DeepCopyInto(out) | ||
| return out | ||
| } | ||
|
|
||
| // ApplicationSelector specifies which application types a strategy applies to. | ||
| type ApplicationSelector struct { | ||
| // APIGroup is the API group of the application. | ||
| // If not specified, defaults to "apps.cozystack.io". | ||
| // +optional | ||
| APIGroup *string `json:"apiGroup,omitempty"` | ||
|
|
||
| // Kind is the kind of the application (e.g., VirtualMachine, MySQL). | ||
| Kind string `json:"kind"` | ||
| } | ||
|
|
||
| // BackupClassStatus defines the observed state of a BackupClass. | ||
| type BackupClassStatus struct { | ||
| // Conditions represents the latest available observations of a BackupClass's state. | ||
| // +optional | ||
| Conditions []metav1.Condition `json:"conditions,omitempty"` | ||
| } |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use headings instead of bold text for section titles (MD036).
markdownlint flags these as emphasis used for headings. Consider switching to proper heading levels.
📝 Suggested fix
Also applies to: 204-204, 216-216
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
170-170: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🤖 Prompt for AI Agents