Skip to content

Commit c5f74bd

Browse files
committed
fix: use registry instead of repository
1 parent 5ef97c7 commit c5f74bd

File tree

9 files changed

+54
-54
lines changed

9 files changed

+54
-54
lines changed

api/v1alpha1/clusterconfig_types.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ type ClusterConfigSpec struct {
2626
// Important: Run "make" to regenerate code after modifying this file
2727

2828
// +optional
29-
KubernetesImageRepository *KubernetesImageRepository `json:"kubernetesImageRepository,omitempty"`
29+
KubernetesImageRegistry *KubernetesImageRegistry `json:"kubernetesImageRegistry,omitempty"`
3030

3131
// +optional
3232
Proxy *HTTPProxy `json:"proxy,omitempty"`
@@ -41,7 +41,7 @@ func (ClusterConfigSpec) VariableSchema() clusterv1.VariableSchema {
4141
Description: "Cluster configuration",
4242
Type: "object",
4343
Properties: map[string]clusterv1.JSONSchemaProps{
44-
"kubernetesImageRepository": KubernetesImageRepository(
44+
"kubernetesImageRegistry": KubernetesImageRegistry(
4545
"",
4646
).VariableSchema().
4747
OpenAPIV3Schema,
@@ -52,19 +52,19 @@ func (ClusterConfigSpec) VariableSchema() clusterv1.VariableSchema {
5252
}
5353
}
5454

55-
// KubernetesImageRepository required for overriding Kubernetes image repository.
56-
type KubernetesImageRepository string
55+
// KubernetesImageRegistry required for overriding Kubernetes image registry.
56+
type KubernetesImageRegistry string
5757

58-
func (KubernetesImageRepository) VariableSchema() clusterv1.VariableSchema {
58+
func (KubernetesImageRegistry) VariableSchema() clusterv1.VariableSchema {
5959
return clusterv1.VariableSchema{
6060
OpenAPIV3Schema: clusterv1.JSONSchemaProps{
61-
Description: "Sets the Kubernetes imageRepository used for the KubeadmControlPlane.",
61+
Description: "Sets the Kubernetes image registry used for the KubeadmControlPlane.",
6262
Type: "string",
6363
},
6464
}
6565
}
6666

67-
func (v KubernetesImageRepository) String() string {
67+
func (v KubernetesImageRegistry) String() string {
6868
return string(v)
6969
}
7070

api/v1alpha1/zz_generated.deepcopy.go

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cmd/main.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import (
3131
"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/cni/calico"
3232
"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/extraapiservercertsans"
3333
"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/httpproxy"
34-
"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/kubernetesimagerepository"
34+
"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/kubernetesimageregistry"
3535
"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/servicelbgc"
3636
)
3737

@@ -126,8 +126,8 @@ func main() {
126126

127127
auditpolicy.NewPatch(),
128128

129-
kubernetesimagerepository.NewVariable(),
130-
kubernetesimagerepository.NewPatch(kubernetesimagerepository.VariableName),
129+
kubernetesimageregistry.NewVariable(),
130+
kubernetesimageregistry.NewPatch(kubernetesimageregistry.VariableName),
131131

132132
clusterconfig.NewVariable(),
133133
mutation.NewMetaGeneratePatchesHandler(
@@ -138,9 +138,9 @@ func main() {
138138
extraapiservercertsans.VariableName,
139139
),
140140
auditpolicy.NewPatch(),
141-
kubernetesimagerepository.NewPatch(
141+
kubernetesimageregistry.NewPatch(
142142
clusterconfig.VariableName,
143-
kubernetesimagerepository.VariableName,
143+
kubernetesimageregistry.VariableName,
144144
),
145145
),
146146
)

docs/content/cluster-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ spec:
3535
variables:
3636
- name: clusterConfig
3737
value:
38-
kubernetesImageRepository: "my-registry.io/my-org/my-repo"
38+
kubernetesImageRegistry: "my-registry.io/my-org/my-repo"
3939
extraAPIServerCertSANs:
4040
- a.b.c.example.com
4141
- d.e.f.example.com

docs/content/kubernetes-image-repository.md renamed to docs/content/kubernetes-image-registry.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: "Kubernete Image Repository"
2+
title: "Kubernete Image Registry"
33
---
44

5-
Override the container image repository used when pulling Kubernetes images.
5+
Override the container image registry used when pulling Kubernetes images.
66

7-
To enable this handler set the `imagerepositorypatch` and `imagerepositoryvars` external patches on `ClusterClass`.
7+
To enable this handler set the `imageregistrypatch` and `imageregistryvars` external patches on `ClusterClass`.
88

99
```yaml
1010
apiVersion: cluster.x-k8s.io/v1beta1
@@ -13,13 +13,13 @@ metadata:
1313
name: <NAME>
1414
spec:
1515
patches:
16-
- name: image-repository
16+
- name: image-registry
1717
external:
18-
generateExtension: "imagerepositorypatch.capi-runtime-extensions"
19-
discoverVariablesExtension: "imagerepositoryvars.capi-runtime-extensions"
18+
generateExtension: "imageregistrypatch.capi-runtime-extensions"
19+
discoverVariablesExtension: "imageregistryvars.capi-runtime-extensions"
2020
```
2121
22-
On the cluster resource then specify desired Kubernetes image repository value:
22+
On the cluster resource then specify desired Kubernetes image registry value:
2323
2424
```yaml
2525
apiVersion: cluster.x-k8s.io/v1beta1
@@ -29,7 +29,7 @@ metadata:
2929
spec:
3030
topology:
3131
variables:
32-
- name: kubernetesImageRepository
32+
- name: kubernetesImageRegistry
3333
value: "my-registry.io/my-org/my-repo"
3434
```
3535

pkg/handlers/kubernetesimagerepository/inject.go renamed to pkg/handlers/kubernetesimageregistry/inject.go

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright 2023 D2iQ, Inc. All rights reserved.
22
// SPDX-License-Identifier: Apache-2.0
33

4-
package kubernetesimagerepository
4+
package kubernetesimageregistry
55

66
import (
77
"context"
@@ -27,28 +27,28 @@ import (
2727

2828
const (
2929
// HandlerNamePatch is the name of the inject handler.
30-
HandlerNamePatch = "ImageRepositoryPatch"
30+
HandlerNamePatch = "ImageRegistryPatch"
3131
)
3232

33-
type imageRepositoryPatchHandler struct {
33+
type imageRegistryPatchHandler struct {
3434
decoder runtime.Decoder
3535
variableName string
3636
variableFieldPath []string
3737
}
3838

3939
var (
40-
_ handlers.Named = &imageRepositoryPatchHandler{}
41-
_ mutation.GeneratePatches = &imageRepositoryPatchHandler{}
40+
_ handlers.Named = &imageRegistryPatchHandler{}
41+
_ mutation.GeneratePatches = &imageRegistryPatchHandler{}
4242
)
4343

4444
func NewPatch(
4545
variableName string,
4646
variableFieldPath ...string,
47-
) *imageRepositoryPatchHandler {
47+
) *imageRegistryPatchHandler {
4848
scheme := runtime.NewScheme()
4949
_ = bootstrapv1.AddToScheme(scheme)
5050
_ = controlplanev1.AddToScheme(scheme)
51-
return &imageRepositoryPatchHandler{
51+
return &imageRegistryPatchHandler{
5252
decoder: serializer.NewCodecFactory(scheme).UniversalDecoder(
5353
controlplanev1.GroupVersion,
5454
bootstrapv1.GroupVersion,
@@ -58,11 +58,11 @@ func NewPatch(
5858
}
5959
}
6060

61-
func (h *imageRepositoryPatchHandler) Name() string {
61+
func (h *imageRegistryPatchHandler) Name() string {
6262
return HandlerNamePatch
6363
}
6464

65-
func (h *imageRepositoryPatchHandler) GeneratePatches(
65+
func (h *imageRegistryPatchHandler) GeneratePatches(
6666
ctx context.Context,
6767
req *runtimehooksv1.GeneratePatchesRequest,
6868
resp *runtimehooksv1.GeneratePatchesResponse,
@@ -82,7 +82,7 @@ func (h *imageRepositoryPatchHandler) GeneratePatches(
8282
"holderRef", holderRef,
8383
)
8484

85-
imageRepositoryVar, found, err := variables.Get[v1alpha1.KubernetesImageRepository](
85+
imageRegistryVar, found, err := variables.Get[v1alpha1.KubernetesImageRegistry](
8686
vars,
8787
h.variableName,
8888
h.variableFieldPath...,
@@ -91,7 +91,7 @@ func (h *imageRepositoryPatchHandler) GeneratePatches(
9191
return err
9292
}
9393
if !found {
94-
log.V(5).Info("kubernetesImageRepository variable not defined")
94+
log.V(5).Info("kubernetesImageRegistry variable not defined")
9595
return nil
9696
}
9797

@@ -101,7 +101,7 @@ func (h *imageRepositoryPatchHandler) GeneratePatches(
101101
"variableFieldPath",
102102
h.variableFieldPath,
103103
"variableValue",
104-
imageRepositoryVar,
104+
imageRegistryVar,
105105
)
106106

107107
return patches.Generate(
@@ -110,12 +110,12 @@ func (h *imageRepositoryPatchHandler) GeneratePatches(
110110
log.WithValues(
111111
"patchedObjectKind", obj.GetObjectKind().GroupVersionKind().String(),
112112
"patchedObjectName", client.ObjectKeyFromObject(obj),
113-
).Info("setting kubernetesImageRepository in kubeadm config spec")
113+
).Info("setting imageRepository in kubeadm config spec")
114114

115115
if obj.Spec.Template.Spec.KubeadmConfigSpec.ClusterConfiguration == nil {
116116
obj.Spec.Template.Spec.KubeadmConfigSpec.ClusterConfiguration = &bootstrapv1.ClusterConfiguration{}
117117
}
118-
obj.Spec.Template.Spec.KubeadmConfigSpec.ClusterConfiguration.ImageRepository = imageRepositoryVar.String()
118+
obj.Spec.Template.Spec.KubeadmConfigSpec.ClusterConfiguration.ImageRepository = imageRegistryVar.String()
119119

120120
return nil
121121
},

pkg/handlers/kubernetesimagerepository/inject_test.go renamed to pkg/handlers/kubernetesimageregistry/inject_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright 2023 D2iQ, Inc. All rights reserved.
22
// SPDX-License-Identifier: Apache-2.0
33

4-
package kubernetesimagerepository
4+
package kubernetesimageregistry
55

66
import (
77
"testing"
@@ -22,11 +22,11 @@ func TestGeneratePatches(t *testing.T) {
2222
Name: "unset variable",
2323
},
2424
capitest.PatchTestDef{
25-
Name: "kubernetesImageRepository set",
25+
Name: "kubernetesImageRegistry set",
2626
Vars: []runtimehooksv1.Variable{
2727
capitest.VariableWithValue(
2828
VariableName,
29-
v1alpha1.KubernetesImageRepository("my-registry.io/my-org/my-repo"),
29+
v1alpha1.KubernetesImageRegistry("my-registry.io/my-org/my-repo"),
3030
),
3131
},
3232
RequestItem: capitest.NewKubeadmControlPlaneTemplateRequestItem(),
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright 2023 D2iQ, Inc. All rights reserved.
22
// SPDX-License-Identifier: Apache-2.0
33

4-
package kubernetesimagerepository
4+
package kubernetesimageregistry
55

66
import (
77
"context"
@@ -15,37 +15,37 @@ import (
1515
)
1616

1717
var (
18-
_ handlers.Named = &imageRepositoryVariableHandler{}
19-
_ mutation.DiscoverVariables = &imageRepositoryVariableHandler{}
18+
_ handlers.Named = &imageRegistryVariableHandler{}
19+
_ mutation.DiscoverVariables = &imageRegistryVariableHandler{}
2020
)
2121

2222
const (
2323
// VariableName is http proxy external patch variable name.
24-
VariableName = "kubernetesImageRepository"
24+
VariableName = "kubernetesImageRegistry"
2525

2626
// HandlerNameVariable is the name of the variable handler.
27-
HandlerNameVariable = "ImageRepositoryVars"
27+
HandlerNameVariable = "ImageRegistryVars"
2828
)
2929

30-
func NewVariable() *imageRepositoryVariableHandler {
31-
return &imageRepositoryVariableHandler{}
30+
func NewVariable() *imageRegistryVariableHandler {
31+
return &imageRegistryVariableHandler{}
3232
}
3333

34-
type imageRepositoryVariableHandler struct{}
34+
type imageRegistryVariableHandler struct{}
3535

36-
func (h *imageRepositoryVariableHandler) Name() string {
36+
func (h *imageRegistryVariableHandler) Name() string {
3737
return HandlerNameVariable
3838
}
3939

40-
func (h *imageRepositoryVariableHandler) DiscoverVariables(
40+
func (h *imageRegistryVariableHandler) DiscoverVariables(
4141
ctx context.Context,
4242
_ *runtimehooksv1.DiscoverVariablesRequest,
4343
resp *runtimehooksv1.DiscoverVariablesResponse,
4444
) {
4545
resp.Variables = append(resp.Variables, clusterv1.ClusterClassVariable{
4646
Name: VariableName,
4747
Required: false,
48-
Schema: v1alpha1.KubernetesImageRepository("").VariableSchema(),
48+
Schema: v1alpha1.KubernetesImageRegistry("").VariableSchema(),
4949
})
5050
resp.SetStatus(runtimehooksv1.ResponseStatusSuccess)
5151
}

pkg/handlers/kubernetesimagerepository/variables_test.go renamed to pkg/handlers/kubernetesimageregistry/variables_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright 2023 D2iQ, Inc. All rights reserved.
22
// SPDX-License-Identifier: Apache-2.0
33

4-
package kubernetesimagerepository
4+
package kubernetesimageregistry
55

66
import (
77
"testing"
@@ -16,7 +16,7 @@ func TestVariableValidation(t *testing.T) {
1616
capitest.ValidateDiscoverVariables(
1717
t,
1818
VariableName,
19-
ptr.To(v1alpha1.KubernetesImageRepository("").VariableSchema()),
19+
ptr.To(v1alpha1.KubernetesImageRegistry("").VariableSchema()),
2020
NewVariable,
2121
capitest.VariableTestDef{
2222
Name: "set",

0 commit comments

Comments
 (0)