Skip to content

Commit 9494bcc

Browse files
dkoshkindkoshkin
committed
fix: separate handlers for control-plane and workers
1 parent 4bddc60 commit 9494bcc

File tree

11 files changed

+320
-109
lines changed

11 files changed

+320
-109
lines changed

‎common/pkg/capi/clustertopology/handlers/mutation/meta.go

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ import (
1515
"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
1616
)
1717

18+
type MutateFunc func(
19+
ctx context.Context,
20+
obj runtime.Object,
21+
vars map[string]apiextensionsv1.JSON,
22+
holderRef runtimehooksv1.HolderReference,
23+
clusterKey client.ObjectKey,
24+
) error
25+
1826
type MetaMutator interface {
1927
Mutate(
2028
ctx context.Context,

‎common/pkg/capi/clustertopology/patches/selectors/selectors.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ func InfrastructureWorkerMachineTemplates(
7272

7373
// InfrastructureControlPlaneMachines selector matches against infrastructure control-plane machines.
7474
// Passing in the API version (not the API group) is required because different providers could support different API
75-
// versions. This also allows for a oatch to select multiple infrastructure versions for the same provider.
75+
// versions. This also allows for a patch to select multiple infrastructure versions for the same provider.
7676
func InfrastructureControlPlaneMachines(
7777
capiInfrastructureAPIVersion, kind string,
7878
) clusterv1.PatchSelector {

‎pkg/handlers/docker/mutation/customimage/inject_control_plane.go

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
// Copyright 2023 D2iQ, Inc. All rights reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
package customimage
5+
6+
import (
7+
"context"
8+
_ "embed"
9+
"fmt"
10+
"strings"
11+
12+
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
13+
"k8s.io/apimachinery/pkg/runtime"
14+
runtimehooksv1 "sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1"
15+
ctrl "sigs.k8s.io/controller-runtime"
16+
"sigs.k8s.io/controller-runtime/pkg/client"
17+
18+
"github.com/d2iq-labs/capi-runtime-extensions/api/v1alpha1"
19+
"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/apis"
20+
commonhandlers "github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
21+
"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers/mutation"
22+
"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/patches"
23+
"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/patches/selectors"
24+
"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/variables"
25+
capdv1 "github.com/d2iq-labs/capi-runtime-extensions/common/pkg/external/sigs.k8s.io/cluster-api/test/infrastructure/docker/api/v1beta1"
26+
"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers"
27+
dockerclusterconfig "github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/docker/clusterconfig"
28+
"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/generic/clusterconfig"
29+
)
30+
31+
const (
32+
// WorkerHandlerNamePatch is the name of the inject handler.
33+
WorkerHandlerNamePatch = "DockerWorkerCustomImagePatch"
34+
35+
defaultKinDImageRepository = "ghcr.io/mesosphere/kind-node"
36+
)
37+
38+
type customImageControlPlanePatchHandler struct {
39+
variableName string
40+
variableFieldPath []string
41+
}
42+
43+
var (
44+
_ commonhandlers.Named = &customImageControlPlanePatchHandler{}
45+
_ mutation.GeneratePatches = &customImageControlPlanePatchHandler{}
46+
_ mutation.MetaMutator = &customImageControlPlanePatchHandler{}
47+
)
48+
49+
func NewControlPlanePatch() *customImageControlPlanePatchHandler {
50+
return newCustomImageControlPlanePatchHandler(VariableName)
51+
}
52+
53+
func NewControlPlaneMetaPatch() *customImageControlPlanePatchHandler {
54+
return newCustomImageControlPlanePatchHandler(
55+
clusterconfig.MetaVariableName,
56+
clusterconfig.MetaControlPlaneConfigName,
57+
dockerclusterconfig.DockerVariableName,
58+
VariableName,
59+
)
60+
}
61+
62+
func newCustomImageControlPlanePatchHandler(
63+
variableName string,
64+
variableFieldPath ...string,
65+
) *customImageControlPlanePatchHandler {
66+
return &customImageControlPlanePatchHandler{
67+
variableName: variableName,
68+
variableFieldPath: variableFieldPath,
69+
}
70+
}
71+
72+
func (h *customImageControlPlanePatchHandler) Name() string {
73+
return WorkerHandlerNamePatch
74+
}
75+
76+
func (h *customImageControlPlanePatchHandler) Mutate(
77+
ctx context.Context,
78+
obj runtime.Object,
79+
vars map[string]apiextensionsv1.JSON,
80+
holderRef runtimehooksv1.HolderReference,
81+
_ client.ObjectKey,
82+
) error {
83+
log := ctrl.LoggerFrom(ctx).WithValues(
84+
"holderRef", holderRef,
85+
)
86+
87+
customImageVar, found, err := variables.Get[v1alpha1.OCIImage](
88+
vars,
89+
h.variableName,
90+
h.variableFieldPath...,
91+
)
92+
if err != nil {
93+
return err
94+
}
95+
if !found {
96+
log.V(5).
97+
Info("Docker customImage variable not defined for control-plane, using default KinD node image")
98+
}
99+
100+
log = log.WithValues(
101+
"variableName",
102+
h.variableName,
103+
"variableFieldPath",
104+
h.variableFieldPath,
105+
"variableValue",
106+
customImageVar,
107+
)
108+
109+
return patches.Generate(
110+
obj,
111+
vars,
112+
&holderRef,
113+
selectors.InfrastructureControlPlaneMachines("v1beta1", "DockerMachineTemplate"),
114+
log,
115+
func(obj *capdv1.DockerMachineTemplate) error {
116+
variablePath := []string{"builtin", "controlPlane", "version"}
117+
118+
if customImageVar == "" {
119+
kubernetesVersion, found, err := variables.Get[string](
120+
vars,
121+
variablePath[0],
122+
variablePath[1:]...)
123+
if err != nil {
124+
return err
125+
}
126+
if !found {
127+
return fmt.Errorf(
128+
"missing required variable: %s",
129+
strings.Join(variablePath, "."),
130+
)
131+
}
132+
133+
customImageVar = v1alpha1.OCIImage(
134+
defaultKinDImageRepository + ":" + kubernetesVersion,
135+
)
136+
}
137+
138+
log.WithValues(
139+
"patchedObjectKind", obj.GetObjectKind().GroupVersionKind().String(),
140+
"patchedObjectName", client.ObjectKeyFromObject(obj),
141+
"customImage", customImageVar,
142+
).Info("setting customImage in control plane DockerMachineTemplate spec")
143+
144+
obj.Spec.Template.Spec.CustomImage = string(customImageVar)
145+
146+
return nil
147+
},
148+
)
149+
}
150+
151+
func (h *customImageControlPlanePatchHandler) GeneratePatches(
152+
ctx context.Context,
153+
req *runtimehooksv1.GeneratePatchesRequest,
154+
resp *runtimehooksv1.GeneratePatchesResponse,
155+
) {
156+
handlers.GeneratePatches(ctx, req, resp, apis.CAPDDecoder(), h.Mutate)
157+
}

‎pkg/handlers/docker/mutation/customimage/inject_control_plane_test.go

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Copyright 2023 D2iQ, Inc. All rights reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
package customimage
5+
6+
import (
7+
"testing"
8+
9+
"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers/mutation"
10+
"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/docker/mutation/customimage/tests"
11+
)
12+
13+
func TestControlPlaneGeneratePatches(t *testing.T) {
14+
t.Parallel()
15+
16+
tests.TestControlPlaneGeneratePatches(
17+
t,
18+
func() mutation.GeneratePatches { return NewControlPlanePatch() },
19+
VariableName,
20+
)
21+
}

‎pkg/handlers/docker/mutation/customimage/inject.go renamed to ‎pkg/handlers/docker/mutation/customimage/inject_worker.go

Lines changed: 25 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ import (
1212
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
1313
"k8s.io/apimachinery/pkg/runtime"
1414
runtimehooksv1 "sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1"
15-
"sigs.k8s.io/cluster-api/exp/runtime/topologymutation"
1615
ctrl "sigs.k8s.io/controller-runtime"
1716
"sigs.k8s.io/controller-runtime/pkg/client"
1817

@@ -24,65 +23,65 @@ import (
2423
"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/patches/selectors"
2524
"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/variables"
2625
capdv1 "github.com/d2iq-labs/capi-runtime-extensions/common/pkg/external/sigs.k8s.io/cluster-api/test/infrastructure/docker/api/v1beta1"
26+
"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers"
2727
dockerclusterconfig "github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/docker/clusterconfig"
2828
dockerworkerconfig "github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/docker/workerconfig"
2929
"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/generic/clusterconfig"
3030
"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/generic/workerconfig"
3131
)
3232

3333
const (
34-
// HandlerNamePatch is the name of the inject handler.
35-
HandlerNamePatch = "DockerCustomImagePatch"
36-
37-
defaultKinDImageRepository = "ghcr.io/mesosphere/kind-node"
34+
// ControlPlaneHandlerNamePatch is the name of the inject handler.
35+
ControlPlaneHandlerNamePatch = "DockerControlPlaneCustomImagePatch"
3836
)
3937

40-
type customImagePatchHandler struct {
38+
type customImageWorkerPatchHandler struct {
4139
variableName string
4240
variableFieldPath []string
4341
}
4442

4543
var (
46-
_ commonhandlers.Named = &customImagePatchHandler{}
47-
_ mutation.GeneratePatches = &customImagePatchHandler{}
48-
_ mutation.MetaMutator = &customImagePatchHandler{}
44+
_ commonhandlers.Named = &customImageWorkerPatchHandler{}
45+
_ mutation.GeneratePatches = &customImageWorkerPatchHandler{}
46+
_ mutation.MetaMutator = &customImageWorkerPatchHandler{}
4947
)
5048

51-
func NewPatch() *customImagePatchHandler {
52-
return newCustomImagePatchHandler(VariableName)
49+
func NewWorkerPatch() *customImageWorkerPatchHandler {
50+
return newcustomImageWorkerPatchHandler(VariableName)
5351
}
5452

55-
func NewMetaPatch() *customImagePatchHandler {
56-
return newCustomImagePatchHandler(
53+
func NewWorkerInClusterConfigMetaPatch() *customImageControlPlanePatchHandler {
54+
return newCustomImageControlPlanePatchHandler(
5755
clusterconfig.MetaVariableName,
56+
clusterconfig.MetaWorkerConfigName,
5857
dockerclusterconfig.DockerVariableName,
5958
VariableName,
6059
)
6160
}
6261

63-
func NewMetaWorkerPatch() *customImagePatchHandler {
64-
return newCustomImagePatchHandler(
62+
func NewMetaWorkerPatch() *customImageWorkerPatchHandler {
63+
return newcustomImageWorkerPatchHandler(
6564
workerconfig.MetaVariableName,
6665
dockerworkerconfig.DockerVariableName,
6766
VariableName,
6867
)
6968
}
7069

71-
func newCustomImagePatchHandler(
70+
func newcustomImageWorkerPatchHandler(
7271
variableName string,
7372
variableFieldPath ...string,
74-
) *customImagePatchHandler {
75-
return &customImagePatchHandler{
73+
) *customImageWorkerPatchHandler {
74+
return &customImageWorkerPatchHandler{
7675
variableName: variableName,
7776
variableFieldPath: variableFieldPath,
7877
}
7978
}
8079

81-
func (h *customImagePatchHandler) Name() string {
82-
return HandlerNamePatch
80+
func (h *customImageWorkerPatchHandler) Name() string {
81+
return ControlPlaneHandlerNamePatch
8382
}
8483

85-
func (h *customImagePatchHandler) Mutate(
84+
func (h *customImageWorkerPatchHandler) Mutate(
8685
ctx context.Context,
8786
obj runtime.Object,
8887
vars map[string]apiextensionsv1.JSON,
@@ -102,7 +101,8 @@ func (h *customImagePatchHandler) Mutate(
102101
return err
103102
}
104103
if !found {
105-
log.V(5).Info("Docker customImage variable not defined, using default KinD node image")
104+
log.V(5).
105+
Info("Docker customImage variable not defined for workers, using default KinD node image")
106106
}
107107

108108
log = log.WithValues(
@@ -114,7 +114,7 @@ func (h *customImagePatchHandler) Mutate(
114114
customImageVar,
115115
)
116116

117-
err = patches.Generate(
117+
return patches.Generate(
118118
obj,
119119
vars,
120120
&holderRef,
@@ -154,74 +154,12 @@ func (h *customImagePatchHandler) Mutate(
154154
return nil
155155
},
156156
)
157-
158-
if err != nil {
159-
return err
160-
}
161-
162-
if h.variableName == workerconfig.MetaVariableName {
163-
return nil
164-
}
165-
166-
return patches.Generate(
167-
obj,
168-
vars,
169-
&holderRef,
170-
selectors.InfrastructureControlPlaneMachines("v1beta1", "DockerMachineTemplate"),
171-
log,
172-
func(obj *capdv1.DockerMachineTemplate) error {
173-
variablePath := []string{"builtin", "controlPlane", "version"}
174-
175-
if customImageVar == "" {
176-
kubernetesVersion, found, err := variables.Get[string](
177-
vars,
178-
variablePath[0],
179-
variablePath[1:]...)
180-
if err != nil {
181-
return err
182-
}
183-
if !found {
184-
return fmt.Errorf(
185-
"missing required variable: %s",
186-
strings.Join(variablePath, "."),
187-
)
188-
}
189-
190-
customImageVar = v1alpha1.OCIImage(
191-
defaultKinDImageRepository + ":" + kubernetesVersion,
192-
)
193-
}
194-
195-
log.WithValues(
196-
"patchedObjectKind", obj.GetObjectKind().GroupVersionKind().String(),
197-
"patchedObjectName", client.ObjectKeyFromObject(obj),
198-
"customImage", customImageVar,
199-
).Info("setting customImage in control plane DockerMachineTemplate spec")
200-
201-
obj.Spec.Template.Spec.CustomImage = string(customImageVar)
202-
203-
return nil
204-
},
205-
)
206157
}
207158

208-
func (h *customImagePatchHandler) GeneratePatches(
159+
func (h *customImageWorkerPatchHandler) GeneratePatches(
209160
ctx context.Context,
210161
req *runtimehooksv1.GeneratePatchesRequest,
211162
resp *runtimehooksv1.GeneratePatchesResponse,
212163
) {
213-
topologymutation.WalkTemplates(
214-
ctx,
215-
apis.CAPDDecoder(),
216-
req,
217-
resp,
218-
func(
219-
ctx context.Context,
220-
obj runtime.Object,
221-
vars map[string]apiextensionsv1.JSON,
222-
holderRef runtimehooksv1.HolderReference,
223-
) error {
224-
return h.Mutate(ctx, obj, vars, holderRef, client.ObjectKey{})
225-
},
226-
)
164+
handlers.GeneratePatches(ctx, req, resp, apis.CAPDDecoder(), h.Mutate)
227165
}

0 commit comments

Comments
 (0)