Skip to content

✨ Implement Boxcutter #1946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 26 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
7f27f0a
Update boxcutter library to branch with latest k8s and controller-run…
Jul 15, 2025
bf6d40e
Update go.mod
Jul 23, 2025
34b0271
Add ClusterExtensionRevisionAPI
Jul 23, 2025
0d62842
Add BoxcutterRuntime featuregate
Jul 23, 2025
b5bc064
Add Boxcutter applier
Jul 23, 2025
31decf5
Add ClusterExtensionRevision controller
Jul 23, 2025
28d572b
Add Boxcutter runtime to main
Jul 23, 2025
bf2d076
Remove ClusterExtensionRevision from crd-docs
Jul 23, 2025
0a8b1e7
Update hack/tools/update-crds.sh for ClusterExtensionRevision API
Jul 23, 2025
5b17943
Generate manifests
Jul 23, 2025
5298c4b
Remove access manager and dynamic cache
Jul 28, 2025
4ba9b2b
Update boxcutter to v0.3.0, add TrackingCache to Runnables
thetechnick Jul 31, 2025
2cf1884
boxcutter webhook support
joelanford Jul 31, 2025
c831c76
add BoxcutterRuntime feature gate to experimental release
joelanford Jul 31, 2025
7581b67
add boxcutter cluster-admin cluster role binding in boxcutter's featu…
joelanford Jul 31, 2025
dc14495
Boxcutter Preflight
tmshort Jul 31, 2025
57382f1
Boxcutter Preflight mock cleanup
tmshort Aug 1, 2025
368f8f6
Use new TrackingCache Watch/Free.
thetechnick Aug 11, 2025
625b368
add BoxcutterInstalledBundleGetter, plumb bundle metadata into revisi…
joelanford Jul 31, 2025
671c76d
InstalledBundleGetter -> RevisionStatesGetter
joelanford Aug 1, 2025
cad475e
refactor Applier interface and improve status reporting
joelanford Aug 1, 2025
25e74e9
fixup tests for applier and installedbundlegetter changes
joelanford Aug 5, 2025
d87bab2
resolve linter issues
joelanford Aug 7, 2025
13e6283
set status for other failure modes during ClusterExtensionRevision re…
joelanford Aug 8, 2025
75e3040
TODO: fail upgrade-e2e if revision storage is unmigrated
joelanford Aug 11, 2025
ae9d77c
fixing broken tests after rebase
joelanford Aug 19, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 123 additions & 0 deletions api/v1/clusterextensionrevision_types.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
/*
Copyright 2024.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package v1

import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/types"
)

const ClusterExtensionRevisionKind = "ClusterExtensionRevision"

// ClusterExtensionRevisionSpec defines the desired state of ClusterExtensionRevision.
type ClusterExtensionRevisionSpec struct {
// Specifies the lifecycle state of the ClusterExtensionRevision.
// +kubebuilder:default="Active"
// +kubebuilder:validation:Enum=Active;Paused;Archived
// +kubebuilder:validation:XValidation:rule="oldSelf == 'Active' || oldSelf == 'Paused' || oldSelf == 'Archived' && oldSelf == self", message="can not un-archive"
LifecycleState ClusterExtensionRevisionLifecycleState `json:"lifecycleState,omitempty"`
// +kubebuilder:validation:Required
// +kubebuilder:validation:XValidation:rule="self == oldSelf", message="revision is immutable"
Revision int64 `json:"revision"`
// +kubebuilder:validation:Required
// +kubebuilder:validation:XValidation:rule="self == oldSelf || oldSelf.size() == 0", message="phases is immutable"
Phases []ClusterExtensionRevisionPhase `json:"phases"`
// +kubebuilder:validation:XValidation:rule="self == oldSelf", message="previous is immutable"
Previous []ClusterExtensionRevisionPrevious `json:"previous,omitempty"`
}

// ClusterExtensionRevisionLifecycleState specifies the lifecycle state of the ClusterExtensionRevision.
type ClusterExtensionRevisionLifecycleState string

const (
// ClusterExtensionRevisionLifecycleStateActive / "Active" is the default lifecycle state.
ClusterExtensionRevisionLifecycleStateActive ClusterExtensionRevisionLifecycleState = "Active"
// ClusterExtensionRevisionLifecycleStatePaused / "Paused" disables reconciliation of the ClusterExtensionRevision.
// Only Status updates will still propagated, but object changes will not be reconciled.
ClusterExtensionRevisionLifecycleStatePaused ClusterExtensionRevisionLifecycleState = "Paused"
// ClusterExtensionRevisionLifecycleStateArchived / "Archived" disables reconciliation while also "scaling to zero",
// which deletes all objects that are not excluded via the pausedFor property and
// removes itself from the owner list of all other objects previously under management.
ClusterExtensionRevisionLifecycleStateArchived ClusterExtensionRevisionLifecycleState = "Archived"
)

type ClusterExtensionRevisionPhase struct {
Name string `json:"name"`
Objects []ClusterExtensionRevisionObject `json:"objects"`
Slices []string `json:"slices,omitempty"`
}

type ClusterExtensionRevisionObject struct {
// +kubebuilder:validation:EmbeddedResource
// +kubebuilder:pruning:PreserveUnknownFields
Object unstructured.Unstructured `json:"object"`
}

type ClusterExtensionRevisionPrevious struct {
// +kubebuilder:validation:Required
Name string `json:"name"`
// +kubebuilder:validation:Required
UID types.UID `json:"uid"`
}

// ClusterExtensionRevisionStatus defines the observed state of a ClusterExtensionRevision.
type ClusterExtensionRevisionStatus struct {
// +patchMergeKey=type
// +patchStrategy=merge
// +listType=map
// +listMapKey=type
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
}

// +kubebuilder:object:root=true
// +kubebuilder:resource:scope=Cluster
// +kubebuilder:subresource:status

// ClusterExtensionRevision is the Schema for the clusterextensionrevisions API
type ClusterExtensionRevision struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

// spec is an optional field that defines the desired state of the ClusterExtension.
// +optional
Spec ClusterExtensionRevisionSpec `json:"spec,omitempty"`

// status is an optional field that defines the observed state of the ClusterExtension.
// +optional
Status ClusterExtensionRevisionStatus `json:"status,omitempty"`
}

// +kubebuilder:object:root=true

// ClusterExtensionRevisionList contains a list of ClusterExtensionRevision
type ClusterExtensionRevisionList struct {
metav1.TypeMeta `json:",inline"`

// +optional
metav1.ListMeta `json:"metadata,omitempty"`

// items is a required list of ClusterExtensionRevision objects.
//
// +kubebuilder:validation:Required
Items []ClusterExtensionRevision `json:"items"`
}

func init() {
SchemeBuilder.Register(&ClusterExtensionRevision{}, &ClusterExtensionRevisionList{})
}
16 changes: 11 additions & 5 deletions api/v1/common_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,18 @@ const (
TypeInstalled = "Installed"
TypeProgressing = "Progressing"

// Installed reasons
ReasonAbsent = "Absent"

// Progressing reasons
ReasonSucceeded = "Succeeded"
ReasonRetrying = "Retrying"
ReasonBlocked = "Blocked"
ReasonRolloutInProgress = "RolloutInProgress"
ReasonRetrying = "Retrying"
ReasonBlocked = "Blocked"

// Terminal reasons
// Deprecation reasons
ReasonDeprecated = "Deprecated"
ReasonFailed = "Failed"

// Common reasons
ReasonSucceeded = "Succeeded"
ReasonFailed = "Failed"
)
166 changes: 166 additions & 0 deletions api/v1/zz_generated.deepcopy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading