Skip to content

Commit fafc51a

Browse files
committed
Add examples/fleet-namespace
Signed-off-by: Dr. Stefan Schimanski <[email protected]>
1 parent 5dc10a2 commit fafc51a

File tree

6 files changed

+793
-0
lines changed

6 files changed

+793
-0
lines changed

examples/fleet-namespace/cache.go

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
package main
2+
3+
import (
4+
"context"
5+
"errors"
6+
"fmt"
7+
"time"
8+
9+
apierrors "k8s.io/apimachinery/pkg/api/errors"
10+
"k8s.io/apimachinery/pkg/api/meta"
11+
"k8s.io/apimachinery/pkg/runtime"
12+
"k8s.io/apimachinery/pkg/runtime/schema"
13+
toolscache "k8s.io/client-go/tools/cache"
14+
"sigs.k8s.io/controller-runtime/pkg/cache"
15+
"sigs.k8s.io/controller-runtime/pkg/client"
16+
)
17+
18+
const (
19+
ClusterNameIndex = "cluster/name"
20+
ClusterIndex = "cluster"
21+
)
22+
23+
var _ cache.Cache = &NamespacedCache{}
24+
25+
type NamespacedCache struct {
26+
clusterName string
27+
cache.Cache
28+
}
29+
30+
func (c *NamespacedCache) Get(ctx context.Context, key client.ObjectKey, obj client.Object, opts ...client.GetOption) error {
31+
if key.Namespace != "default" {
32+
return apierrors.NewNotFound(schema.GroupResource{}, key.Name)
33+
}
34+
key.Namespace = c.clusterName
35+
if err := c.Cache.Get(ctx, key, obj, opts...); err != nil {
36+
return err
37+
}
38+
obj.SetNamespace("default")
39+
return nil
40+
}
41+
42+
func (c *NamespacedCache) List(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error {
43+
var listOpts client.ListOptions
44+
for _, o := range opts {
45+
o.ApplyToList(&listOpts)
46+
}
47+
48+
switch {
49+
case listOpts.FieldSelector != nil:
50+
reqs := listOpts.FieldSelector.Requirements()
51+
flds := make(map[string]string, len(reqs))
52+
for i := range reqs {
53+
flds[fmt.Sprintf("cluster/%s", reqs[i].Field)] = fmt.Sprintf("%s/%s", c.clusterName, reqs[i].Value)
54+
}
55+
opts = append(opts, client.MatchingFields(flds))
56+
case listOpts.Namespace != "":
57+
opts = append(opts, client.MatchingFields(map[string]string{ClusterIndex: c.clusterName}))
58+
if c.clusterName == "*" {
59+
listOpts.Namespace = ""
60+
} else if listOpts.Namespace == "default" {
61+
listOpts.Namespace = c.clusterName
62+
}
63+
default:
64+
opts = append(opts, client.MatchingFields(map[string]string{ClusterIndex: c.clusterName}))
65+
}
66+
67+
if err := c.Cache.List(ctx, list, opts...); err != nil {
68+
return err
69+
}
70+
71+
return meta.EachListItem(list, func(obj runtime.Object) error {
72+
obj.(client.Object).SetNamespace("default")
73+
return nil
74+
})
75+
}
76+
77+
func (c *NamespacedCache) GetInformer(ctx context.Context, obj client.Object, opts ...cache.InformerGetOption) (cache.Informer, error) {
78+
inf, err := c.Cache.GetInformer(ctx, obj, opts...)
79+
if err != nil {
80+
return nil, err
81+
}
82+
return &ScopedInformer{clusterName: c.clusterName, Informer: inf}, nil
83+
}
84+
85+
func (c *NamespacedCache) GetInformerForKind(ctx context.Context, gvk schema.GroupVersionKind, opts ...cache.InformerGetOption) (cache.Informer, error) {
86+
inf, err := c.Cache.GetInformerForKind(ctx, gvk, opts...)
87+
if err != nil {
88+
return nil, err
89+
}
90+
return &ScopedInformer{clusterName: c.clusterName, Informer: inf}, nil
91+
}
92+
93+
func (c *NamespacedCache) RemoveInformer(ctx context.Context, obj client.Object) error {
94+
return errors.New("informer cannot be removed from scoped cache")
95+
}
96+
97+
type ScopedInformer struct {
98+
clusterName string
99+
cache.Informer
100+
}
101+
102+
func (i *ScopedInformer) AddEventHandler(handler toolscache.ResourceEventHandler) (toolscache.ResourceEventHandlerRegistration, error) {
103+
return i.Informer.AddEventHandler(toolscache.ResourceEventHandlerDetailedFuncs{
104+
AddFunc: func(obj interface{}, isInInitialList bool) {
105+
cobj := obj.(client.Object)
106+
if cobj.GetNamespace() == i.clusterName {
107+
cobj := cobj.DeepCopyObject().(client.Object)
108+
cobj.SetNamespace("default")
109+
handler.OnAdd(cobj, isInInitialList)
110+
}
111+
},
112+
UpdateFunc: func(oldObj, newObj interface{}) {
113+
cobj := newObj.(client.Object)
114+
if cobj.GetNamespace() == i.clusterName {
115+
cobj := cobj.DeepCopyObject().(client.Object)
116+
cobj.SetNamespace("default")
117+
handler.OnUpdate(oldObj, cobj)
118+
}
119+
},
120+
DeleteFunc: func(obj interface{}) {
121+
if tombStone, ok := obj.(toolscache.DeletedFinalStateUnknown); ok {
122+
obj = tombStone.Obj
123+
}
124+
cobj := obj.(client.Object)
125+
if cobj.GetNamespace() == i.clusterName {
126+
cobj := cobj.DeepCopyObject().(client.Object)
127+
cobj.SetNamespace("default")
128+
handler.OnDelete(cobj)
129+
}
130+
},
131+
})
132+
}
133+
134+
func (i *ScopedInformer) AddEventHandlerWithResyncPeriod(handler toolscache.ResourceEventHandler, resyncPeriod time.Duration) (toolscache.ResourceEventHandlerRegistration, error) {
135+
return i.Informer.AddEventHandlerWithResyncPeriod(toolscache.ResourceEventHandlerDetailedFuncs{
136+
AddFunc: func(obj interface{}, isInInitialList bool) {
137+
cobj := obj.(client.Object)
138+
if cobj.GetNamespace() == i.clusterName {
139+
cobj := cobj.DeepCopyObject().(client.Object)
140+
cobj.SetNamespace("default")
141+
handler.OnAdd(cobj, isInInitialList)
142+
}
143+
},
144+
UpdateFunc: func(oldObj, newObj interface{}) {
145+
cobj := newObj.(client.Object)
146+
if cobj.GetNamespace() == i.clusterName {
147+
cobj := cobj.DeepCopyObject().(client.Object)
148+
cobj.SetNamespace("default")
149+
handler.OnUpdate(oldObj, cobj)
150+
}
151+
},
152+
DeleteFunc: func(obj interface{}) {
153+
if tombStone, ok := obj.(toolscache.DeletedFinalStateUnknown); ok {
154+
obj = tombStone.Obj
155+
}
156+
cobj := obj.(client.Object)
157+
if cobj.GetNamespace() == i.clusterName {
158+
cobj := cobj.DeepCopyObject().(client.Object)
159+
cobj.SetNamespace("default")
160+
handler.OnDelete(cobj)
161+
}
162+
},
163+
}, resyncPeriod)
164+
}
165+
166+
func (i *ScopedInformer) AddIndexers(indexers toolscache.Indexers) error {
167+
return errors.New("indexes cannot be added to scoped informers")
168+
}
169+
170+
type NamespaceScopeableCache struct {
171+
cache.Cache
172+
}
173+
174+
func (f *NamespaceScopeableCache) IndexField(ctx context.Context, obj client.Object, field string, extractValue client.IndexerFunc) error {
175+
return f.IndexField(ctx, obj, "cluster/"+field, func(obj client.Object) []string {
176+
keys := extractValue(obj)
177+
withCluster := make([]string, len(keys)*2)
178+
for i, key := range keys {
179+
withCluster[i] = fmt.Sprintf("%s/%s", obj.GetNamespace(), key)
180+
withCluster[i+len(keys)] = fmt.Sprintf("*/%s", key)
181+
}
182+
return withCluster
183+
})
184+
}
185+
186+
func (f *NamespaceScopeableCache) Start(ctx context.Context) error {
187+
return nil // no-op as this is shared
188+
}

examples/fleet-namespace/client.go

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
package main
2+
3+
import (
4+
"context"
5+
6+
apierrors "k8s.io/apimachinery/pkg/api/errors"
7+
"k8s.io/apimachinery/pkg/api/meta"
8+
"k8s.io/apimachinery/pkg/runtime"
9+
"k8s.io/apimachinery/pkg/runtime/schema"
10+
"sigs.k8s.io/controller-runtime/pkg/client"
11+
)
12+
13+
var _ client.Client = &NamespacedClient{}
14+
15+
type NamespacedClient struct {
16+
clusterName string
17+
client.Client
18+
}
19+
20+
func (n *NamespacedClient) Get(ctx context.Context, key client.ObjectKey, obj client.Object, opts ...client.GetOption) error {
21+
if key.Namespace != "default" {
22+
return apierrors.NewNotFound(schema.GroupResource{}, key.Name)
23+
}
24+
key.Namespace = n.clusterName
25+
if err := n.Client.Get(ctx, key, obj, opts...); err != nil {
26+
return err
27+
}
28+
obj.SetNamespace("default")
29+
return nil
30+
}
31+
32+
func (n *NamespacedClient) List(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error {
33+
var copts client.ListOptions
34+
for _, o := range opts {
35+
o.ApplyToList(&copts)
36+
}
37+
if copts.Namespace != "default" {
38+
return apierrors.NewNotFound(schema.GroupResource{}, copts.Namespace)
39+
}
40+
if err := n.Client.List(ctx, list, append(opts, client.InNamespace(n.clusterName))...); err != nil {
41+
return err
42+
}
43+
return meta.EachListItem(list, func(obj runtime.Object) error {
44+
obj.(client.Object).SetNamespace("default")
45+
return nil
46+
})
47+
}
48+
49+
func (n *NamespacedClient) Create(ctx context.Context, obj client.Object, opts ...client.CreateOption) error {
50+
panic("implement me")
51+
}
52+
53+
func (n *NamespacedClient) Delete(ctx context.Context, obj client.Object, opts ...client.DeleteOption) error {
54+
panic("implement me")
55+
}
56+
57+
func (n *NamespacedClient) Update(ctx context.Context, obj client.Object, opts ...client.UpdateOption) error {
58+
panic("implement me")
59+
}
60+
61+
func (n *NamespacedClient) Patch(ctx context.Context, obj client.Object, patch client.Patch, opts ...client.PatchOption) error {
62+
panic("implement me")
63+
}
64+
65+
func (n *NamespacedClient) DeleteAllOf(ctx context.Context, obj client.Object, opts ...client.DeleteAllOfOption) error {
66+
panic("implement me")
67+
}
68+
69+
func (n *NamespacedClient) Status() client.SubResourceWriter {
70+
panic("implement me")
71+
}
72+
73+
func (n *NamespacedClient) SubResource(subResource string) client.SubResourceClient {
74+
panic("implement me")
75+
}

examples/fleet-namespace/cluster.go

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
package main
2+
3+
import (
4+
"context"
5+
6+
"k8s.io/client-go/tools/record"
7+
"sigs.k8s.io/controller-runtime/pkg/cache"
8+
"sigs.k8s.io/controller-runtime/pkg/client"
9+
"sigs.k8s.io/controller-runtime/pkg/cluster"
10+
)
11+
12+
type NamespacedCluster struct {
13+
clusterName string
14+
cluster.Cluster
15+
}
16+
17+
func (c *NamespacedCluster) Name() string {
18+
return c.clusterName
19+
}
20+
21+
func (c *NamespacedCluster) GetCache() cache.Cache {
22+
return &NamespacedCache{clusterName: c.clusterName, Cache: c.Cluster.GetCache()}
23+
}
24+
25+
func (c *NamespacedCluster) GetClient() client.Client {
26+
return &NamespacedClient{clusterName: c.clusterName, Client: c.Cluster.GetClient()}
27+
}
28+
29+
func (c *NamespacedCluster) GetEventRecorderFor(name string) record.EventRecorder {
30+
panic("implement me")
31+
}
32+
33+
func (c *NamespacedCluster) GetAPIReader() client.Reader {
34+
return c.GetClient()
35+
}
36+
37+
func (c *NamespacedCluster) Start(ctx context.Context) error {
38+
return nil // no-op as this is shared
39+
}

examples/fleet-namespace/go.mod

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
module sigs.k8s.io/controller-runtime/examples/fleet
2+
3+
go 1.19
4+
5+
replace sigs.k8s.io/controller-runtime => ../..
6+
7+
require (
8+
golang.org/x/sync v0.6.0
9+
k8s.io/api v0.28.3
10+
k8s.io/apimachinery v0.28.3
11+
k8s.io/client-go v0.28.3
12+
k8s.io/klog/v2 v2.110.1
13+
sigs.k8s.io/controller-runtime v0.0.0-00010101000000-000000000000
14+
)
15+
16+
require (
17+
github.com/beorn7/perks v1.0.1 // indirect
18+
github.com/cespare/xxhash/v2 v2.2.0 // indirect
19+
github.com/davecgh/go-spew v1.1.1 // indirect
20+
github.com/emicklei/go-restful/v3 v3.11.0 // indirect
21+
github.com/evanphx/json-patch/v5 v5.7.0 // indirect
22+
github.com/fsnotify/fsnotify v1.7.0 // indirect
23+
github.com/go-logr/logr v1.3.0 // indirect
24+
github.com/go-openapi/jsonpointer v0.19.6 // indirect
25+
github.com/go-openapi/jsonreference v0.20.2 // indirect
26+
github.com/go-openapi/swag v0.22.3 // indirect
27+
github.com/gogo/protobuf v1.3.2 // indirect
28+
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
29+
github.com/golang/protobuf v1.5.3 // indirect
30+
github.com/google/gnostic-models v0.6.8 // indirect
31+
github.com/google/go-cmp v0.6.0 // indirect
32+
github.com/google/gofuzz v1.2.0 // indirect
33+
github.com/google/uuid v1.3.0 // indirect
34+
github.com/imdario/mergo v0.3.6 // indirect
35+
github.com/josharian/intern v1.0.0 // indirect
36+
github.com/json-iterator/go v1.1.12 // indirect
37+
github.com/mailru/easyjson v0.7.7 // indirect
38+
github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
39+
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
40+
github.com/modern-go/reflect2 v1.0.2 // indirect
41+
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
42+
github.com/pkg/errors v0.9.1 // indirect
43+
github.com/prometheus/client_golang v1.17.0 // indirect
44+
github.com/prometheus/client_model v0.5.0 // indirect
45+
github.com/prometheus/common v0.44.0 // indirect
46+
github.com/prometheus/procfs v0.11.1 // indirect
47+
github.com/spf13/pflag v1.0.5 // indirect
48+
golang.org/x/exp v0.0.0-20220722155223-a9213eeb770e // indirect
49+
golang.org/x/net v0.17.0 // indirect
50+
golang.org/x/oauth2 v0.8.0 // indirect
51+
golang.org/x/sys v0.14.0 // indirect
52+
golang.org/x/term v0.13.0 // indirect
53+
golang.org/x/text v0.13.0 // indirect
54+
golang.org/x/time v0.3.0 // indirect
55+
gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
56+
google.golang.org/appengine v1.6.7 // indirect
57+
google.golang.org/protobuf v1.31.0 // indirect
58+
gopkg.in/inf.v0 v0.9.1 // indirect
59+
gopkg.in/yaml.v2 v2.4.0 // indirect
60+
gopkg.in/yaml.v3 v3.0.1 // indirect
61+
k8s.io/apiextensions-apiserver v0.28.3 // indirect
62+
k8s.io/component-base v0.28.3 // indirect
63+
k8s.io/kube-openapi v0.0.0-20230717233707-2695361300d9 // indirect
64+
k8s.io/utils v0.0.0-20230406110748-d93618cff8a2 // indirect
65+
sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
66+
sigs.k8s.io/structured-merge-diff/v4 v4.2.3 // indirect
67+
sigs.k8s.io/yaml v1.4.0 // indirect
68+
)

0 commit comments

Comments
 (0)