Skip to content

Commit 08d54a3

Browse files
wangyeleiapecloud-bot
wangyelei
authored and
apecloud-bot
committed
chore: support image replacement of parameters based on the serviceVersion (#10038)
(cherry picked from commit 2a7e088)
1 parent 524b118 commit 08d54a3

File tree

8 files changed

+203
-3
lines changed

8 files changed

+203
-3
lines changed

‎apis/parameters/v1alpha1/parametersdefinition_types.go‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -355,12 +355,26 @@ type ToolConfig struct {
355355
// +optional
356356
Image string `json:"image,omitempty"`
357357

358+
// Defines image mapping for different service versions.
359+
// +optional
360+
ImageMappings []ImageMapping `json:"imageMappings,omitempty"`
361+
358362
// Specifies the command to be executed by the init container.
359363
//
360364
// +optional
361365
Command []string `json:"command,omitempty"`
362366
}
363367

368+
type ImageMapping struct {
369+
// ServiceVersions is a list of service versions that this mapping applies to.
370+
// +kubebuilder:validation:Required
371+
ServiceVersions []string `json:"serviceVersions"`
372+
373+
// Image is the container image addresses to use for the matched service versions.
374+
// +kubebuilder:validation:Required
375+
Image string `json:"image"`
376+
}
377+
364378
// DownwardAPIChangeTriggeredAction defines an action that triggers specific commands in response to changes in Pod labels.
365379
// For example, a command might be executed when the 'role' label of the Pod is updated.
366380
type DownwardAPIChangeTriggeredAction struct {

‎apis/parameters/v1alpha1/zz_generated.deepcopy.go‎

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

‎config/crd/bases/parameters.kubeblocks.io_parametersdefinitions.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -449,6 +449,28 @@ spec:
449449
image:
450450
description: Specifies the tool container image.
451451
type: string
452+
imageMappings:
453+
description: Defines image mapping for different
454+
service versions.
455+
items:
456+
properties:
457+
image:
458+
description: Image is the container image
459+
addresses to use for the matched service
460+
versions.
461+
type: string
462+
serviceVersions:
463+
description: ServiceVersions is a list of
464+
service versions that this mapping applies
465+
to.
466+
items:
467+
type: string
468+
type: array
469+
required:
470+
- image
471+
- serviceVersions
472+
type: object
473+
type: array
452474
name:
453475
description: Specifies the name of the init container.
454476
maxLength: 63

‎deploy/helm/crds/parameters.kubeblocks.io_parametersdefinitions.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -449,6 +449,28 @@ spec:
449449
image:
450450
description: Specifies the tool container image.
451451
type: string
452+
imageMappings:
453+
description: Defines image mapping for different
454+
service versions.
455+
items:
456+
properties:
457+
image:
458+
description: Image is the container image
459+
addresses to use for the matched service
460+
versions.
461+
type: string
462+
serviceVersions:
463+
description: ServiceVersions is a list of
464+
service versions that this mapping applies
465+
to.
466+
items:
467+
type: string
468+
type: array
469+
required:
470+
- image
471+
- serviceVersions
472+
type: object
473+
type: array
452474
name:
453475
description: Specifies the name of the init container.
454476
maxLength: 63

‎docs/developer_docs/api-reference/parameters.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1510,6 +1510,45 @@ IniConfig
15101510
</tr>
15111511
</tbody>
15121512
</table>
1513+
<h3 id="parameters.kubeblocks.io/v1alpha1.ImageMapping">ImageMapping
1514+
</h3>
1515+
<p>
1516+
(<em>Appears on:</em><a href="#parameters.kubeblocks.io/v1alpha1.ToolConfig">ToolConfig</a>)
1517+
</p>
1518+
<div>
1519+
</div>
1520+
<table>
1521+
<thead>
1522+
<tr>
1523+
<th>Field</th>
1524+
<th>Description</th>
1525+
</tr>
1526+
</thead>
1527+
<tbody>
1528+
<tr>
1529+
<td>
1530+
<code>serviceVersions</code><br/>
1531+
<em>
1532+
[]string
1533+
</em>
1534+
</td>
1535+
<td>
1536+
<p>ServiceVersions is a list of service versions that this mapping applies to.</p>
1537+
</td>
1538+
</tr>
1539+
<tr>
1540+
<td>
1541+
<code>image</code><br/>
1542+
<em>
1543+
string
1544+
</em>
1545+
</td>
1546+
<td>
1547+
<p>Image is the container image addresses to use for the matched service versions.</p>
1548+
</td>
1549+
</tr>
1550+
</tbody>
1551+
</table>
15131552
<h3 id="parameters.kubeblocks.io/v1alpha1.IniConfig">IniConfig
15141553
</h3>
15151554
<p>
@@ -2992,6 +3031,20 @@ string
29923031
</tr>
29933032
<tr>
29943033
<td>
3034+
<code>imageMappings</code><br/>
3035+
<em>
3036+
<a href="#parameters.kubeblocks.io/v1alpha1.ImageMapping">
3037+
[]ImageMapping
3038+
</a>
3039+
</em>
3040+
</td>
3041+
<td>
3042+
<em>(Optional)</em>
3043+
<p>Defines image mapping for different service versions.</p>
3044+
</td>
3045+
</tr>
3046+
<tr>
3047+
<td>
29953048
<code>command</code><br/>
29963049
<em>
29973050
[]string

‎pkg/parameters/config_util.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -518,7 +518,7 @@ func buildConfigManagerParams(cli client.Client, ctx context.Context, cluster *a
518518
if err := cfgcm.BuildConfigManagerContainerParams(cli, ctx, cfgManagerParams); err != nil {
519519
return nil, err
520520
}
521-
if err := buildReloadToolsContainer(cfgManagerParams, podSpec); err != nil {
521+
if err := buildReloadToolsContainer(cfgManagerParams, podSpec, comp.ServiceVersion); err != nil {
522522
return nil, err
523523
}
524524
return cfgManagerParams, nil

‎pkg/parameters/tool_image_builder.go‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ package parameters
2121

2222
import (
2323
"path/filepath"
24+
"slices"
2425

2526
corev1 "k8s.io/api/core/v1"
2627

@@ -39,7 +40,7 @@ const (
3940
kbToolsImagePlaceHolder = "$(KUBEBLOCKS_TOOLS_IMAGE)"
4041
)
4142

42-
func buildReloadToolsContainer(cfgManagerParams *cfgcm.CfgManagerBuildParams, podSpec *corev1.PodSpec) error {
43+
func buildReloadToolsContainer(cfgManagerParams *cfgcm.CfgManagerBuildParams, podSpec *corev1.PodSpec, serviceVersion string) error {
4344
if len(cfgManagerParams.ConfigSpecsBuildParams) == 0 {
4445
return nil
4546
}
@@ -58,6 +59,15 @@ func buildReloadToolsContainer(cfgManagerParams *cfgcm.CfgManagerBuildParams, po
5859
if _, ok := toolsImageMap[toolImage.Name]; ok {
5960
continue
6061
}
62+
if len(toolImage.ImageMappings) > 0 {
63+
for _, mapping := range toolImage.ImageMappings {
64+
if !slices.Contains(mapping.ServiceVersions, serviceVersion) {
65+
continue
66+
}
67+
toolImage.Image = mapping.Image
68+
break
69+
}
70+
}
6171
toolsImageMap[toolImage.Name] = buildParam
6272
replaceToolsImageHolder(&toolImage, podSpec, buildParam.ConfigSpec.VolumeName)
6373
if AsSidecarContainerImage(toolImage) && sidecarImage == "" {

‎pkg/parameters/tool_image_builder_test.go‎

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,12 +93,64 @@ var _ = Describe("ToolsImageBuilderTest", func() {
9393
}},
9494
}
9595
cfgManagerParams.ConfigSpecsBuildParams[0].ConfigSpec.VolumeName = "data"
96-
Expect(buildReloadToolsContainer(cfgManagerParams, &its.Spec.Template.Spec)).Should(Succeed())
96+
Expect(buildReloadToolsContainer(cfgManagerParams, &its.Spec.Template.Spec, "1.0.1")).Should(Succeed())
9797
Expect(3).Should(BeEquivalentTo(len(cfgManagerParams.ToolsContainers)))
9898
Expect("test_images").Should(BeEquivalentTo(cfgManagerParams.ToolsContainers[0].Image))
9999
Expect(its.Spec.Template.Spec.Containers[0].Image).Should(BeEquivalentTo(cfgManagerParams.ToolsContainers[1].Image))
100100
Expect(kbToolsImage).Should(BeEquivalentTo(cfgManagerParams.ToolsContainers[2].Image))
101101
})
102102
})
103103

104+
It("TesImageMappings", func() {
105+
its, err := factory.BuildInstanceSet(clusterComponent, nil)
106+
Expect(err).Should(Succeed())
107+
108+
cfgManagerParams := &cfgcm.CfgManagerBuildParams{
109+
ManagerName: constant.ConfigSidecarName,
110+
ComponentName: clusterComponent.Name,
111+
Image: viper.GetString(constant.KBToolsImage),
112+
Volumes: make([]corev1.VolumeMount, 0),
113+
Cluster: clusterObj,
114+
ConfigSpecsBuildParams: []cfgcm.ConfigSpecMeta{{
115+
ConfigSpecInfo: cfgcm.ConfigSpecInfo{
116+
ConfigSpec: component.ConfigTemplates(clusterComponent)[0],
117+
ReloadType: parametersv1alpha1.ShellType,
118+
},
119+
ToolsImageSpec: &parametersv1alpha1.ToolsSetup{
120+
MountPoint: "/opt/tools",
121+
ToolConfigs: []parametersv1alpha1.ToolConfig{
122+
{
123+
Name: "test",
124+
Image: "test_images",
125+
Command: noneCommand,
126+
ImageMappings: []parametersv1alpha1.ImageMapping{
127+
{
128+
ServiceVersions: []string{
129+
"1.0.1",
130+
},
131+
Image: "test_images_v1.0.1",
132+
},
133+
},
134+
},
135+
{
136+
Name: "test2",
137+
Image: "",
138+
Command: noneCommand,
139+
// AsContainerImage: cfgutil.ToPointer(true),
140+
},
141+
{
142+
Name: "test3",
143+
Image: "$(KUBEBLOCKS_TOOLS_IMAGE)",
144+
Command: noneCommand,
145+
},
146+
},
147+
},
148+
}},
149+
}
150+
cfgManagerParams.ConfigSpecsBuildParams[0].ConfigSpec.VolumeName = "data"
151+
Expect(buildReloadToolsContainer(cfgManagerParams, &its.Spec.Template.Spec, "1.0.1")).Should(Succeed())
152+
Expect(3).Should(BeEquivalentTo(len(cfgManagerParams.ToolsContainers)))
153+
Expect("test_images_v1.0.1").Should(BeEquivalentTo(cfgManagerParams.ToolsContainers[0].Image))
154+
})
155+
104156
})

0 commit comments

Comments
 (0)