Create CRDs with schema

Fixes an issue where CRDs were being created without schema, allowing
resources with invalid content to be created, later stalling the
controller ListWatch event channel when the invalid resources could not
be deserialized.

This also requires moving Addon GVK tracking from a status field to
an annotation, as the GroupVersionKind type has special handling
internal to Kubernetes that prevents it from being serialized to the CRD
when schema validation is enabled.

Signed-off-by: Brad Davidson <brad.davidson@rancher.com>
(cherry picked from commit ad41fb8c96)
pull/7535/head
Brad Davidson 2023-04-18 20:52:24 +00:00 committed by Brad Davidson
parent 6e92eb9ac0
commit 746ada89d2
11 changed files with 140 additions and 387 deletions

2
go.mod
View File

@ -103,7 +103,7 @@ require (
github.com/rancher/lasso v0.0.0-20221227210133-6ea88ca2fbcc github.com/rancher/lasso v0.0.0-20221227210133-6ea88ca2fbcc
github.com/rancher/remotedialer v0.3.0 github.com/rancher/remotedialer v0.3.0
github.com/rancher/wharfie v0.5.3 github.com/rancher/wharfie v0.5.3
github.com/rancher/wrangler v1.1.1 github.com/rancher/wrangler v1.1.1-0.20230419173538-80fdf092be3b
github.com/robfig/cron/v3 v3.0.1 github.com/robfig/cron/v3 v3.0.1
github.com/rootless-containers/rootlesskit v1.0.1 github.com/rootless-containers/rootlesskit v1.0.1
github.com/sirupsen/logrus v1.9.0 github.com/sirupsen/logrus v1.9.0

4
go.sum
View File

@ -932,8 +932,8 @@ github.com/rancher/remotedialer v0.3.0 h1:y1EO8JCsgZo0RcqTUp6U8FXcBAv27R+TLnWRcp
github.com/rancher/remotedialer v0.3.0/go.mod h1:BwwztuvViX2JrLLUwDlsYt5DiyUwHLlzynRwkZLAY0Q= github.com/rancher/remotedialer v0.3.0/go.mod h1:BwwztuvViX2JrLLUwDlsYt5DiyUwHLlzynRwkZLAY0Q=
github.com/rancher/wharfie v0.5.3 h1:6hiO26H7YTgChbLAE6JppxFRjaH3tbKfMItv/LqV0Q0= github.com/rancher/wharfie v0.5.3 h1:6hiO26H7YTgChbLAE6JppxFRjaH3tbKfMItv/LqV0Q0=
github.com/rancher/wharfie v0.5.3/go.mod h1:Ebpai7digxegLroBseeC54XRBt5we3DgFS6kAE2ho+o= github.com/rancher/wharfie v0.5.3/go.mod h1:Ebpai7digxegLroBseeC54XRBt5we3DgFS6kAE2ho+o=
github.com/rancher/wrangler v1.1.1 h1:wmqUwqc2M7ADfXnBCJTFkTB5ZREWpD78rnZMzmxwMvM= github.com/rancher/wrangler v1.1.1-0.20230419173538-80fdf092be3b h1:rs3WYld8iaRcSzCmM/CrCIVz9uVgfd96o7FsufIdoVI=
github.com/rancher/wrangler v1.1.1/go.mod h1:ioVbKupzcBOdzsl55MvEDN0R1wdGggj8iNCYGFI5JvM= github.com/rancher/wrangler v1.1.1-0.20230419173538-80fdf092be3b/go.mod h1:D6Tu6oVX8aGtCHsMCtYaysgVK3ad920MTSeAu7rzb5U=
github.com/remyoudompheng/bigfft v0.0.0-20170806203942-52369c62f446/go.mod h1:uYEyJGbgTkfkS4+E/PavXkNJcbFIpEtjt2B0KDQ5+9M= github.com/remyoudompheng/bigfft v0.0.0-20170806203942-52369c62f446/go.mod h1:uYEyJGbgTkfkS4+E/PavXkNJcbFIpEtjt2B0KDQ5+9M=
github.com/robfig/cron/v3 v3.0.1 h1:WdRxkvbJztn8LMz/QEvLN5sBU+xKpSqwwUO1Pjr4qDs= github.com/robfig/cron/v3 v3.0.1 h1:WdRxkvbJztn8LMz/QEvLN5sBU+xKpSqwwUO1Pjr4qDs=
github.com/robfig/cron/v3 v3.0.1/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro= github.com/robfig/cron/v3 v3.0.1/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro=

View File

@ -2,7 +2,6 @@ package v1
import ( import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
) )
// +genclient // +genclient
@ -12,15 +11,10 @@ type Addon struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"` metav1.ObjectMeta `json:"metadata,omitempty"`
Spec AddonSpec `json:"spec,omitempty"` Spec AddonSpec `json:"spec,omitempty"`
Status AddonStatus `json:"status,omitempty"`
} }
type AddonSpec struct { type AddonSpec struct {
Source string `json:"source,omitempty"` Source string `json:"source,omitempty"`
Checksum string `json:"checksum,omitempty"` Checksum string `json:"checksum,omitempty"`
} }
type AddonStatus struct {
GVKs []schema.GroupVersionKind `json:"gvks,omitempty"`
}

View File

@ -23,7 +23,6 @@ package v1
import ( import (
runtime "k8s.io/apimachinery/pkg/runtime" runtime "k8s.io/apimachinery/pkg/runtime"
schema "k8s.io/apimachinery/pkg/runtime/schema"
) )
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
@ -32,7 +31,6 @@ func (in *Addon) DeepCopyInto(out *Addon) {
out.TypeMeta = in.TypeMeta out.TypeMeta = in.TypeMeta
in.ObjectMeta.DeepCopyInto(&out.ObjectMeta) in.ObjectMeta.DeepCopyInto(&out.ObjectMeta)
out.Spec = in.Spec out.Spec = in.Spec
in.Status.DeepCopyInto(&out.Status)
return return
} }
@ -102,24 +100,3 @@ func (in *AddonSpec) DeepCopy() *AddonSpec {
in.DeepCopyInto(out) in.DeepCopyInto(out)
return out return out
} }
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *AddonStatus) DeepCopyInto(out *AddonStatus) {
*out = *in
if in.GVKs != nil {
in, out := &in.GVKs, &out.GVKs
*out = make([]schema.GroupVersionKind, len(*in))
copy(*out, *in)
}
return
}
// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AddonStatus.
func (in *AddonStatus) DeepCopy() *AddonStatus {
if in == nil {
return nil
}
out := new(AddonStatus)
in.DeepCopyInto(out)
return out
}

15
pkg/crd/crds.go Normal file
View File

@ -0,0 +1,15 @@
package crd
import (
v1 "github.com/k3s-io/k3s/pkg/apis/k3s.cattle.io/v1"
"github.com/rancher/wrangler/pkg/crd"
)
func List() []crd.CRD {
addon := crd.NamespacedType("Addon.k3s.cattle.io/v1").
WithSchemaFromStruct(v1.Addon{}).
WithColumn("Source", ".spec.source").
WithColumn("Checksum", ".spec.checksum")
return []crd.CRD{addon}
}

View File

@ -6,6 +6,7 @@ import (
"context" "context"
"crypto/sha256" "crypto/sha256"
"encoding/hex" "encoding/hex"
"fmt"
"io" "io"
"os" "os"
"path/filepath" "path/filepath"
@ -20,6 +21,7 @@ import (
pkgutil "github.com/k3s-io/k3s/pkg/util" pkgutil "github.com/k3s-io/k3s/pkg/util"
errors2 "github.com/pkg/errors" errors2 "github.com/pkg/errors"
"github.com/rancher/wrangler/pkg/apply" "github.com/rancher/wrangler/pkg/apply"
"github.com/rancher/wrangler/pkg/kv"
"github.com/rancher/wrangler/pkg/merr" "github.com/rancher/wrangler/pkg/merr"
"github.com/rancher/wrangler/pkg/objectset" "github.com/rancher/wrangler/pkg/objectset"
"github.com/sirupsen/logrus" "github.com/sirupsen/logrus"
@ -38,7 +40,9 @@ import (
const ( const (
ControllerName = "deploy" ControllerName = "deploy"
GVKAnnotation = "addon.k3s.cattle.io/gvks"
startKey = "_start_" startKey = "_start_"
gvkSep = ";"
) )
// WatchFiles sets up an OnChange callback to start a periodic goroutine to watch files for changes once the controller has started up. // WatchFiles sets up an OnChange callback to start a periodic goroutine to watch files for changes once the controller has started up.
@ -206,11 +210,17 @@ func (w *watcher) deploy(path string, compareChecksum bool) error {
} }
// Merge GVK list early for validation // Merge GVK list early for validation
addon.Status.GVKs = append(addon.Status.GVKs, objects.GVKs()...) addonGVKs := objects.GVKs()
for _, gvkString := range strings.Split(addon.Annotations[GVKAnnotation], gvkSep) {
if gvk, err := getGVK(gvkString); err == nil {
addonGVKs = append(addonGVKs, *gvk)
}
}
// Ensure that we don't try to prune using GVKs that the server doesn't have. // Ensure that we don't try to prune using GVKs that the server doesn't have.
// This can happen when CRDs are removed or when core types are removed - PodSecurityPolicy, for example. // This can happen when CRDs are removed or when core types are removed - PodSecurityPolicy, for example.
if err := w.validateGVKs(&addon); err != nil { addonGVKs, err = w.validateGVKs(addonGVKs)
if err != nil {
w.recorder.Eventf(&addon, corev1.EventTypeWarning, "ValidateManifestFailed", "Validate GVKs for manifest at %q failed: %v", path, err) w.recorder.Eventf(&addon, corev1.EventTypeWarning, "ValidateManifestFailed", "Validate GVKs for manifest at %q failed: %v", path, err)
return err return err
} }
@ -222,15 +232,18 @@ func (w *watcher) deploy(path string, compareChecksum bool) error {
// doesn't know to search that GVK for owner references, it won't find and delete them. // doesn't know to search that GVK for owner references, it won't find and delete them.
w.recorder.Eventf(&addon, corev1.EventTypeNormal, "ApplyingManifest", "Applying manifest at %q", path) w.recorder.Eventf(&addon, corev1.EventTypeNormal, "ApplyingManifest", "Applying manifest at %q", path)
if err := w.apply.WithOwner(&addon).WithGVK(addon.Status.GVKs...).Apply(objects); err != nil { if err := w.apply.WithOwner(&addon).WithGVK(addonGVKs...).Apply(objects); err != nil {
w.recorder.Eventf(&addon, corev1.EventTypeWarning, "ApplyManifestFailed", "Applying manifest at %q failed: %v", path, err) w.recorder.Eventf(&addon, corev1.EventTypeWarning, "ApplyManifestFailed", "Applying manifest at %q failed: %v", path, err)
return err return err
} }
// Emit event, Update Addon checksum and GVKs only if apply was successful // Emit event, Update Addon checksum and GVKs only if apply was successful
w.recorder.Eventf(&addon, corev1.EventTypeNormal, "AppliedManifest", "Applied manifest at %q", path) w.recorder.Eventf(&addon, corev1.EventTypeNormal, "AppliedManifest", "Applied manifest at %q", path)
if addon.Annotations == nil {
addon.Annotations = map[string]string{}
}
addon.Spec.Checksum = checksum addon.Spec.Checksum = checksum
addon.Status.GVKs = objects.GVKs() addon.Annotations[GVKAnnotation] = getGVKString(objects.GVKs())
_, err = w.addons.Update(&addon) _, err = w.addons.Update(&addon)
return err return err
} }
@ -244,6 +257,13 @@ func (w *watcher) delete(path string) error {
return err return err
} }
addonGVKs := []schema.GroupVersionKind{}
for _, gvkString := range strings.Split(addon.Annotations[GVKAnnotation], gvkSep) {
if gvk, err := getGVK(gvkString); err == nil {
addonGVKs = append(addonGVKs, *gvk)
}
}
content, err := os.ReadFile(path) content, err := os.ReadFile(path)
if err != nil { if err != nil {
w.recorder.Eventf(&addon, corev1.EventTypeWarning, "ReadManifestFailed", "Read manifest at %q failed: %v", path, err) w.recorder.Eventf(&addon, corev1.EventTypeWarning, "ReadManifestFailed", "Read manifest at %q failed: %v", path, err)
@ -253,13 +273,14 @@ func (w *watcher) delete(path string) error {
} else { } else {
// Search for objects using both GVKs currently listed in the file, as well as GVKs previously applied. // Search for objects using both GVKs currently listed in the file, as well as GVKs previously applied.
// This ensures that any conflicts between competing deploy controllers are handled properly. // This ensures that any conflicts between competing deploy controllers are handled properly.
addon.Status.GVKs = append(addon.Status.GVKs, o.GVKs()...) addonGVKs = append(addonGVKs, o.GVKs()...)
} }
} }
// Ensure that we don't try to delete using GVKs that the server doesn't have. // Ensure that we don't try to delete using GVKs that the server doesn't have.
// This can happen when CRDs are removed or when core types are removed - PodSecurityPolicy, for example. // This can happen when CRDs are removed or when core types are removed - PodSecurityPolicy, for example.
if err := w.validateGVKs(&addon); err != nil { addonGVKs, err = w.validateGVKs(addonGVKs)
if err != nil {
return err return err
} }
@ -271,7 +292,7 @@ func (w *watcher) delete(path string) error {
} }
// apply an empty set with owner & gvk data to delete // apply an empty set with owner & gvk data to delete
if err := w.apply.WithOwner(&addon).WithGVK(addon.Status.GVKs...).ApplyObjects(); err != nil { if err := w.apply.WithOwner(&addon).WithGVK(addonGVKs...).ApplyObjects(); err != nil {
return err return err
} }
@ -290,22 +311,19 @@ func (w *watcher) getOrCreateAddon(name string) (apisv1.Addon, error) {
return *addon, nil return *addon, nil
} }
// validateGVKs removes from the Addon status any GVKs that the server does not support // validateGVKs removes from the list any GVKs that the server does not support
func (w *watcher) validateGVKs(addon *apisv1.Addon) error { func (w *watcher) validateGVKs(addonGVKs []schema.GroupVersionKind) ([]schema.GroupVersionKind, error) {
gvks := []schema.GroupVersionKind{} gvks := []schema.GroupVersionKind{}
for _, gvk := range addon.Status.GVKs { for _, gvk := range addonGVKs {
found, err := w.serverHasGVK(gvk) found, err := w.serverHasGVK(gvk)
if err != nil { if err != nil {
return err return gvks, err
} }
if found { if found {
gvks = append(gvks, gvk) gvks = append(gvks, gvk)
} else {
logrus.Warnf("Pruned unknown GVK from %s %s/%s: %s", addon.TypeMeta.GroupVersionKind(), addon.Namespace, addon.Name, gvk)
} }
} }
addon.Status.GVKs = gvks return gvks, nil
return nil
} }
// serverHasGVK uses a positive cache of GVKs that the cluster is known to have supported at some // serverHasGVK uses a positive cache of GVKs that the cluster is known to have supported at some
@ -462,3 +480,22 @@ func shouldDisableFile(base, fileName string, disables map[string]bool) bool {
baseName := strings.TrimSuffix(baseFile, suffix) baseName := strings.TrimSuffix(baseFile, suffix)
return disables[baseName] return disables[baseName]
} }
func getGVK(s string) (*schema.GroupVersionKind, error) {
parts := strings.Split(s, ", Kind=")
if len(parts) != 2 {
return nil, fmt.Errorf("invalid GVK format: %s", s)
}
gvk := &schema.GroupVersionKind{}
gvk.Group, gvk.Version = kv.Split(parts[0], "/")
gvk.Kind = parts[1]
return gvk, nil
}
func getGVKString(gvks []schema.GroupVersionKind) string {
strs := make([]string, len(gvks))
for i, gvk := range gvks {
strs[i] = gvk.String()
}
return strings.Join(strs, gvkSep)
}

View File

@ -40,7 +40,6 @@ type AddonsGetter interface {
type AddonInterface interface { type AddonInterface interface {
Create(ctx context.Context, addon *v1.Addon, opts metav1.CreateOptions) (*v1.Addon, error) Create(ctx context.Context, addon *v1.Addon, opts metav1.CreateOptions) (*v1.Addon, error)
Update(ctx context.Context, addon *v1.Addon, opts metav1.UpdateOptions) (*v1.Addon, error) Update(ctx context.Context, addon *v1.Addon, opts metav1.UpdateOptions) (*v1.Addon, error)
UpdateStatus(ctx context.Context, addon *v1.Addon, opts metav1.UpdateOptions) (*v1.Addon, error)
Delete(ctx context.Context, name string, opts metav1.DeleteOptions) error Delete(ctx context.Context, name string, opts metav1.DeleteOptions) error
DeleteCollection(ctx context.Context, opts metav1.DeleteOptions, listOpts metav1.ListOptions) error DeleteCollection(ctx context.Context, opts metav1.DeleteOptions, listOpts metav1.ListOptions) error
Get(ctx context.Context, name string, opts metav1.GetOptions) (*v1.Addon, error) Get(ctx context.Context, name string, opts metav1.GetOptions) (*v1.Addon, error)
@ -136,22 +135,6 @@ func (c *addons) Update(ctx context.Context, addon *v1.Addon, opts metav1.Update
return return
} }
// UpdateStatus was generated because the type contains a Status member.
// Add a +genclient:noStatus comment above the type to avoid generating UpdateStatus().
func (c *addons) UpdateStatus(ctx context.Context, addon *v1.Addon, opts metav1.UpdateOptions) (result *v1.Addon, err error) {
result = &v1.Addon{}
err = c.client.Put().
Namespace(c.ns).
Resource("addons").
Name(addon.Name).
SubResource("status").
VersionedParams(&opts, scheme.ParameterCodec).
Body(addon).
Do(ctx).
Into(result)
return
}
// Delete takes name of the addon and deletes it. Returns an error if one occurs. // Delete takes name of the addon and deletes it. Returns an error if one occurs.
func (c *addons) Delete(ctx context.Context, name string, opts metav1.DeleteOptions) error { func (c *addons) Delete(ctx context.Context, name string, opts metav1.DeleteOptions) error {
return c.client.Delete(). return c.client.Delete().

View File

@ -102,18 +102,6 @@ func (c *FakeAddons) Update(ctx context.Context, addon *k3scattleiov1.Addon, opt
return obj.(*k3scattleiov1.Addon), err return obj.(*k3scattleiov1.Addon), err
} }
// UpdateStatus was generated because the type contains a Status member.
// Add a +genclient:noStatus comment above the type to avoid generating UpdateStatus().
func (c *FakeAddons) UpdateStatus(ctx context.Context, addon *k3scattleiov1.Addon, opts v1.UpdateOptions) (*k3scattleiov1.Addon, error) {
obj, err := c.Fake.
Invokes(testing.NewUpdateSubresourceAction(addonsResource, "status", c.ns, addon), &k3scattleiov1.Addon{})
if obj == nil {
return nil, err
}
return obj.(*k3scattleiov1.Addon), err
}
// Delete takes name of the addon and deletes it. Returns an error if one occurs. // Delete takes name of the addon and deletes it. Returns an error if one occurs.
func (c *FakeAddons) Delete(ctx context.Context, name string, opts v1.DeleteOptions) error { func (c *FakeAddons) Delete(ctx context.Context, name string, opts v1.DeleteOptions) error {
_, err := c.Fake. _, err := c.Fake.

View File

@ -23,354 +23,110 @@ import (
"time" "time"
v1 "github.com/k3s-io/k3s/pkg/apis/k3s.cattle.io/v1" v1 "github.com/k3s-io/k3s/pkg/apis/k3s.cattle.io/v1"
"github.com/rancher/lasso/pkg/client"
"github.com/rancher/lasso/pkg/controller"
"github.com/rancher/wrangler/pkg/apply"
"github.com/rancher/wrangler/pkg/condition"
"github.com/rancher/wrangler/pkg/generic" "github.com/rancher/wrangler/pkg/generic"
"github.com/rancher/wrangler/pkg/kv"
"k8s.io/apimachinery/pkg/api/equality"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels" "k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/types" "k8s.io/apimachinery/pkg/types"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/watch" "k8s.io/apimachinery/pkg/watch"
"k8s.io/client-go/tools/cache"
) )
type AddonHandler func(string, *v1.Addon) (*v1.Addon, error) // AddonController interface for managing Addon resources.
type AddonController interface { type AddonController interface {
generic.ControllerMeta generic.ControllerMeta
AddonClient AddonClient
// OnChange runs the given handler when the controller detects a resource was changed.
OnChange(ctx context.Context, name string, sync AddonHandler) OnChange(ctx context.Context, name string, sync AddonHandler)
// OnRemove runs the given handler when the controller detects a resource was changed.
OnRemove(ctx context.Context, name string, sync AddonHandler) OnRemove(ctx context.Context, name string, sync AddonHandler)
// Enqueue adds the resource with the given name to the worker queue of the controller.
Enqueue(namespace, name string) Enqueue(namespace, name string)
// EnqueueAfter runs Enqueue after the provided duration.
EnqueueAfter(namespace, name string, duration time.Duration) EnqueueAfter(namespace, name string, duration time.Duration)
// Cache returns a cache for the resource type T.
Cache() AddonCache Cache() AddonCache
} }
// AddonClient interface for managing Addon resources in Kubernetes.
type AddonClient interface { type AddonClient interface {
// Create creates a new object and return the newly created Object or an error.
Create(*v1.Addon) (*v1.Addon, error) Create(*v1.Addon) (*v1.Addon, error)
// Update updates the object and return the newly updated Object or an error.
Update(*v1.Addon) (*v1.Addon, error) Update(*v1.Addon) (*v1.Addon, error)
UpdateStatus(*v1.Addon) (*v1.Addon, error)
// Delete deletes the Object in the given name.
Delete(namespace, name string, options *metav1.DeleteOptions) error Delete(namespace, name string, options *metav1.DeleteOptions) error
// Get will attempt to retrieve the resource with the specified name.
Get(namespace, name string, options metav1.GetOptions) (*v1.Addon, error) Get(namespace, name string, options metav1.GetOptions) (*v1.Addon, error)
// List will attempt to find multiple resources.
List(namespace string, opts metav1.ListOptions) (*v1.AddonList, error) List(namespace string, opts metav1.ListOptions) (*v1.AddonList, error)
// Watch will start watching resources.
Watch(namespace string, opts metav1.ListOptions) (watch.Interface, error) Watch(namespace string, opts metav1.ListOptions) (watch.Interface, error)
// Patch will patch the resource with the matching name.
Patch(namespace, name string, pt types.PatchType, data []byte, subresources ...string) (result *v1.Addon, err error) Patch(namespace, name string, pt types.PatchType, data []byte, subresources ...string) (result *v1.Addon, err error)
} }
// AddonCache interface for retrieving Addon resources in memory.
type AddonCache interface { type AddonCache interface {
// Get returns the resources with the specified name from the cache.
Get(namespace, name string) (*v1.Addon, error) Get(namespace, name string) (*v1.Addon, error)
// List will attempt to find resources from the Cache.
List(namespace string, selector labels.Selector) ([]*v1.Addon, error) List(namespace string, selector labels.Selector) ([]*v1.Addon, error)
// AddIndexer adds a new Indexer to the cache with the provided name.
// If you call this after you already have data in the store, the results are undefined.
AddIndexer(indexName string, indexer AddonIndexer) AddIndexer(indexName string, indexer AddonIndexer)
// GetByIndex returns the stored objects whose set of indexed values
// for the named index includes the given indexed value.
GetByIndex(indexName, key string) ([]*v1.Addon, error) GetByIndex(indexName, key string) ([]*v1.Addon, error)
} }
// AddonHandler is function for performing any potential modifications to a Addon resource.
type AddonHandler func(string, *v1.Addon) (*v1.Addon, error)
// AddonIndexer computes a set of indexed values for the provided object.
type AddonIndexer func(obj *v1.Addon) ([]string, error) type AddonIndexer func(obj *v1.Addon) ([]string, error)
type addonController struct { // AddonGenericController wraps wrangler/pkg/generic.Controller so that the function definitions adhere to AddonController interface.
controller controller.SharedController type AddonGenericController struct {
client *client.Client generic.ControllerInterface[*v1.Addon, *v1.AddonList]
gvk schema.GroupVersionKind
groupResource schema.GroupResource
} }
func NewAddonController(gvk schema.GroupVersionKind, resource string, namespaced bool, controller controller.SharedControllerFactory) AddonController { // OnChange runs the given resource handler when the controller detects a resource was changed.
c := controller.ForResourceKind(gvk.GroupVersion().WithResource(resource), gvk.Kind, namespaced) func (c *AddonGenericController) OnChange(ctx context.Context, name string, sync AddonHandler) {
return &addonController{ c.ControllerInterface.OnChange(ctx, name, generic.ObjectHandler[*v1.Addon](sync))
controller: c, }
client: c.Client(),
gvk: gvk, // OnRemove runs the given object handler when the controller detects a resource was changed.
groupResource: schema.GroupResource{ func (c *AddonGenericController) OnRemove(ctx context.Context, name string, sync AddonHandler) {
Group: gvk.Group, c.ControllerInterface.OnRemove(ctx, name, generic.ObjectHandler[*v1.Addon](sync))
Resource: resource, }
},
// Cache returns a cache of resources in memory.
func (c *AddonGenericController) Cache() AddonCache {
return &AddonGenericCache{
c.ControllerInterface.Cache(),
} }
} }
func FromAddonHandlerToHandler(sync AddonHandler) generic.Handler { // AddonGenericCache wraps wrangler/pkg/generic.Cache so the function definitions adhere to AddonCache interface.
return func(key string, obj runtime.Object) (ret runtime.Object, err error) { type AddonGenericCache struct {
var v *v1.Addon generic.CacheInterface[*v1.Addon]
if obj == nil {
v, err = sync(key, nil)
} else {
v, err = sync(key, obj.(*v1.Addon))
}
if v == nil {
return nil, err
}
return v, err
}
} }
func (c *addonController) Updater() generic.Updater { // AddIndexer adds a new Indexer to the cache with the provided name.
return func(obj runtime.Object) (runtime.Object, error) { // If you call this after you already have data in the store, the results are undefined.
newObj, err := c.Update(obj.(*v1.Addon)) func (c AddonGenericCache) AddIndexer(indexName string, indexer AddonIndexer) {
if newObj == nil { c.CacheInterface.AddIndexer(indexName, generic.Indexer[*v1.Addon](indexer))
return nil, err
}
return newObj, err
}
}
func UpdateAddonDeepCopyOnChange(client AddonClient, obj *v1.Addon, handler func(obj *v1.Addon) (*v1.Addon, error)) (*v1.Addon, error) {
if obj == nil {
return obj, nil
}
copyObj := obj.DeepCopy()
newObj, err := handler(copyObj)
if newObj != nil {
copyObj = newObj
}
if obj.ResourceVersion == copyObj.ResourceVersion && !equality.Semantic.DeepEqual(obj, copyObj) {
return client.Update(copyObj)
}
return copyObj, err
}
func (c *addonController) AddGenericHandler(ctx context.Context, name string, handler generic.Handler) {
c.controller.RegisterHandler(ctx, name, controller.SharedControllerHandlerFunc(handler))
}
func (c *addonController) AddGenericRemoveHandler(ctx context.Context, name string, handler generic.Handler) {
c.AddGenericHandler(ctx, name, generic.NewRemoveHandler(name, c.Updater(), handler))
}
func (c *addonController) OnChange(ctx context.Context, name string, sync AddonHandler) {
c.AddGenericHandler(ctx, name, FromAddonHandlerToHandler(sync))
}
func (c *addonController) OnRemove(ctx context.Context, name string, sync AddonHandler) {
c.AddGenericHandler(ctx, name, generic.NewRemoveHandler(name, c.Updater(), FromAddonHandlerToHandler(sync)))
}
func (c *addonController) Enqueue(namespace, name string) {
c.controller.Enqueue(namespace, name)
}
func (c *addonController) EnqueueAfter(namespace, name string, duration time.Duration) {
c.controller.EnqueueAfter(namespace, name, duration)
}
func (c *addonController) Informer() cache.SharedIndexInformer {
return c.controller.Informer()
}
func (c *addonController) GroupVersionKind() schema.GroupVersionKind {
return c.gvk
}
func (c *addonController) Cache() AddonCache {
return &addonCache{
indexer: c.Informer().GetIndexer(),
resource: c.groupResource,
}
}
func (c *addonController) Create(obj *v1.Addon) (*v1.Addon, error) {
result := &v1.Addon{}
return result, c.client.Create(context.TODO(), obj.Namespace, obj, result, metav1.CreateOptions{})
}
func (c *addonController) Update(obj *v1.Addon) (*v1.Addon, error) {
result := &v1.Addon{}
return result, c.client.Update(context.TODO(), obj.Namespace, obj, result, metav1.UpdateOptions{})
}
func (c *addonController) UpdateStatus(obj *v1.Addon) (*v1.Addon, error) {
result := &v1.Addon{}
return result, c.client.UpdateStatus(context.TODO(), obj.Namespace, obj, result, metav1.UpdateOptions{})
}
func (c *addonController) Delete(namespace, name string, options *metav1.DeleteOptions) error {
if options == nil {
options = &metav1.DeleteOptions{}
}
return c.client.Delete(context.TODO(), namespace, name, *options)
}
func (c *addonController) Get(namespace, name string, options metav1.GetOptions) (*v1.Addon, error) {
result := &v1.Addon{}
return result, c.client.Get(context.TODO(), namespace, name, result, options)
}
func (c *addonController) List(namespace string, opts metav1.ListOptions) (*v1.AddonList, error) {
result := &v1.AddonList{}
return result, c.client.List(context.TODO(), namespace, result, opts)
}
func (c *addonController) Watch(namespace string, opts metav1.ListOptions) (watch.Interface, error) {
return c.client.Watch(context.TODO(), namespace, opts)
}
func (c *addonController) Patch(namespace, name string, pt types.PatchType, data []byte, subresources ...string) (*v1.Addon, error) {
result := &v1.Addon{}
return result, c.client.Patch(context.TODO(), namespace, name, pt, data, result, metav1.PatchOptions{}, subresources...)
}
type addonCache struct {
indexer cache.Indexer
resource schema.GroupResource
}
func (c *addonCache) Get(namespace, name string) (*v1.Addon, error) {
obj, exists, err := c.indexer.GetByKey(namespace + "/" + name)
if err != nil {
return nil, err
}
if !exists {
return nil, errors.NewNotFound(c.resource, name)
}
return obj.(*v1.Addon), nil
}
func (c *addonCache) List(namespace string, selector labels.Selector) (ret []*v1.Addon, err error) {
err = cache.ListAllByNamespace(c.indexer, namespace, selector, func(m interface{}) {
ret = append(ret, m.(*v1.Addon))
})
return ret, err
}
func (c *addonCache) AddIndexer(indexName string, indexer AddonIndexer) {
utilruntime.Must(c.indexer.AddIndexers(map[string]cache.IndexFunc{
indexName: func(obj interface{}) (strings []string, e error) {
return indexer(obj.(*v1.Addon))
},
}))
}
func (c *addonCache) GetByIndex(indexName, key string) (result []*v1.Addon, err error) {
objs, err := c.indexer.ByIndex(indexName, key)
if err != nil {
return nil, err
}
result = make([]*v1.Addon, 0, len(objs))
for _, obj := range objs {
result = append(result, obj.(*v1.Addon))
}
return result, nil
}
type AddonStatusHandler func(obj *v1.Addon, status v1.AddonStatus) (v1.AddonStatus, error)
type AddonGeneratingHandler func(obj *v1.Addon, status v1.AddonStatus) ([]runtime.Object, v1.AddonStatus, error)
func RegisterAddonStatusHandler(ctx context.Context, controller AddonController, condition condition.Cond, name string, handler AddonStatusHandler) {
statusHandler := &addonStatusHandler{
client: controller,
condition: condition,
handler: handler,
}
controller.AddGenericHandler(ctx, name, FromAddonHandlerToHandler(statusHandler.sync))
}
func RegisterAddonGeneratingHandler(ctx context.Context, controller AddonController, apply apply.Apply,
condition condition.Cond, name string, handler AddonGeneratingHandler, opts *generic.GeneratingHandlerOptions) {
statusHandler := &addonGeneratingHandler{
AddonGeneratingHandler: handler,
apply: apply,
name: name,
gvk: controller.GroupVersionKind(),
}
if opts != nil {
statusHandler.opts = *opts
}
controller.OnChange(ctx, name, statusHandler.Remove)
RegisterAddonStatusHandler(ctx, controller, condition, name, statusHandler.Handle)
}
type addonStatusHandler struct {
client AddonClient
condition condition.Cond
handler AddonStatusHandler
}
func (a *addonStatusHandler) sync(key string, obj *v1.Addon) (*v1.Addon, error) {
if obj == nil {
return obj, nil
}
origStatus := obj.Status.DeepCopy()
obj = obj.DeepCopy()
newStatus, err := a.handler(obj, obj.Status)
if err != nil {
// Revert to old status on error
newStatus = *origStatus.DeepCopy()
}
if a.condition != "" {
if errors.IsConflict(err) {
a.condition.SetError(&newStatus, "", nil)
} else {
a.condition.SetError(&newStatus, "", err)
}
}
if !equality.Semantic.DeepEqual(origStatus, &newStatus) {
if a.condition != "" {
// Since status has changed, update the lastUpdatedTime
a.condition.LastUpdated(&newStatus, time.Now().UTC().Format(time.RFC3339))
}
var newErr error
obj.Status = newStatus
newObj, newErr := a.client.UpdateStatus(obj)
if err == nil {
err = newErr
}
if newErr == nil {
obj = newObj
}
}
return obj, err
}
type addonGeneratingHandler struct {
AddonGeneratingHandler
apply apply.Apply
opts generic.GeneratingHandlerOptions
gvk schema.GroupVersionKind
name string
}
func (a *addonGeneratingHandler) Remove(key string, obj *v1.Addon) (*v1.Addon, error) {
if obj != nil {
return obj, nil
}
obj = &v1.Addon{}
obj.Namespace, obj.Name = kv.RSplit(key, "/")
obj.SetGroupVersionKind(a.gvk)
return nil, generic.ConfigureApplyForObject(a.apply, obj, &a.opts).
WithOwner(obj).
WithSetID(a.name).
ApplyObjects()
}
func (a *addonGeneratingHandler) Handle(obj *v1.Addon, status v1.AddonStatus) (v1.AddonStatus, error) {
if !obj.DeletionTimestamp.IsZero() {
return status, nil
}
objs, newStatus, err := a.AddonGeneratingHandler(obj, status)
if err != nil {
return newStatus, err
}
return newStatus, generic.ConfigureApplyForObject(a.apply, obj, &a.opts).
WithOwner(obj).
WithSetID(a.name).
ApplyObjects(objs...)
} }

View File

@ -21,6 +21,7 @@ package v1
import ( import (
v1 "github.com/k3s-io/k3s/pkg/apis/k3s.cattle.io/v1" v1 "github.com/k3s-io/k3s/pkg/apis/k3s.cattle.io/v1"
"github.com/rancher/lasso/pkg/controller" "github.com/rancher/lasso/pkg/controller"
"github.com/rancher/wrangler/pkg/generic"
"github.com/rancher/wrangler/pkg/schemes" "github.com/rancher/wrangler/pkg/schemes"
"k8s.io/apimachinery/pkg/runtime/schema" "k8s.io/apimachinery/pkg/runtime/schema"
) )
@ -43,6 +44,8 @@ type version struct {
controllerFactory controller.SharedControllerFactory controllerFactory controller.SharedControllerFactory
} }
func (c *version) Addon() AddonController { func (v *version) Addon() AddonController {
return NewAddonController(schema.GroupVersionKind{Group: "k3s.cattle.io", Version: "v1", Kind: "Addon"}, "addons", true, c.controllerFactory) return &AddonGenericController{
generic.NewController[*v1.Addon, *v1.AddonList](schema.GroupVersionKind{Group: "k3s.cattle.io", Version: "v1", Kind: "Addon"}, "addons", true, v.controllerFactory),
}
} }

View File

@ -6,7 +6,9 @@ import (
"os" "os"
"runtime" "runtime"
helmcrd "github.com/k3s-io/helm-controller/pkg/crd"
"github.com/k3s-io/helm-controller/pkg/generated/controllers/helm.cattle.io" "github.com/k3s-io/helm-controller/pkg/generated/controllers/helm.cattle.io"
addoncrd "github.com/k3s-io/k3s/pkg/crd"
"github.com/k3s-io/k3s/pkg/deploy" "github.com/k3s-io/k3s/pkg/deploy"
"github.com/k3s-io/k3s/pkg/generated/controllers/k3s.cattle.io" "github.com/k3s-io/k3s/pkg/generated/controllers/k3s.cattle.io"
"github.com/k3s-io/k3s/pkg/version" "github.com/k3s-io/k3s/pkg/version"
@ -82,10 +84,8 @@ func crds(ctx context.Context, config *rest.Config) error {
return err return err
} }
factory.BatchCreateCRDs(ctx, crd.NamespacedTypes( types := append(helmcrd.List(), addoncrd.List()...)
"Addon.k3s.cattle.io/v1", factory.BatchCreateCRDs(ctx, types...)
"HelmChart.helm.cattle.io/v1",
"HelmChartConfig.helm.cattle.io/v1")...)
return factory.BatchWait() return factory.BatchWait()
} }