Skip to content

Commit 9df5bea

Browse files
PeefyPeefy
authored
Merge pull request #126 from Peefy/feat-arguments-references
feat: arguments references
2 parents 62a7bde + 0a60441 commit 9df5bea

File tree

6 files changed

+85
-43
lines changed

6 files changed

+85
-43
lines changed

‎api/v1alpha1/kclrun_types.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ type KCLRunSpec struct {
130130
// ConfigReference holds references to ConfigMaps and Secrets containing
131131
// the KCL compile config. The ConfigMap and the Secret data keys represent the config names.
132132
// +optional
133-
ConfigReference *ConfigReference `json:"configReference,omitempty" yaml:"configReference,omitempty"`
133+
ArgumentsReferences []ArgumentReference `json:"argumentsReferences,omitempty" yaml:"argumentsReferences,omitempty"`
134134

135135
// Prune enables garbage collection.
136136
// +required
@@ -194,8 +194,8 @@ type ConfigSpec struct {
194194
DisableNone bool `json:"disableNone,omitempty" yaml:"disableNone,omitempty"`
195195
}
196196

197-
// ConfigReference contains a reference to a resource containing the KCL compile config.
198-
type ConfigReference struct {
197+
// ArgumentReference contains a reference to a resource containing the KCL compile config.
198+
type ArgumentReference struct {
199199
// Kind of the values referent, valid values are ('Secret', 'ConfigMap').
200200
// +kubebuilder:validation:Enum=Secret;ConfigMap
201201
// +required

‎api/v1alpha1/kclrun_types_test.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ func TestKCLRunDeserialize(t *testing.T) {
3535
assert.Equal(t, "/path/to/kcl_mod_file_path", kclRun.Spec.Path)
3636
assert.NotNil(t, kclRun.Spec.Config)
3737
assert.Contains(t, kclRun.Spec.Config.Arguments, "env=\"prod\"")
38-
assert.NotNil(t, kclRun.Spec.ConfigReference)
39-
assert.Equal(t, "ConfigMap", kclRun.Spec.ConfigReference.Kind)
40-
assert.Equal(t, "config-map-reference", kclRun.Spec.ConfigReference.Name)
38+
assert.NotNil(t, kclRun.Spec.ArgumentsReferences)
39+
assert.Equal(t, "ConfigMap", kclRun.Spec.ArgumentsReferences[0].Kind)
40+
assert.Equal(t, "config-map-reference", kclRun.Spec.ArgumentsReferences[0].Name)
4141
}

‎api/v1alpha1/testdata/kclrun.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ spec:
3939
sortKeys: true
4040
showHidden: false
4141
disableNone: true
42-
configReference:
43-
kind: ConfigMap
44-
name: config-map-reference
45-
optional: false
42+
argumentsReferences:
43+
- kind: ConfigMap
44+
name: config-map-reference
45+
optional: false
4646
prune: true
4747
healthChecks:
4848
- kind: Pod

‎config/crd/bases/krm.kcl.dev.fluxcd_kclruns.yaml‎

Lines changed: 34 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,40 @@ spec:
3939
spec:
4040
description: KCLRunSpec defines the desired state of KCLRun
4141
properties:
42+
argumentsReferences:
43+
description: |-
44+
ConfigReference holds references to ConfigMaps and Secrets containing
45+
the KCL compile config. The ConfigMap and the Secret data keys represent the config names.
46+
items:
47+
description: ArgumentReference contains a reference to a resource
48+
containing the KCL compile config.
49+
properties:
50+
kind:
51+
description: Kind of the values referent, valid values are ('Secret',
52+
'ConfigMap').
53+
enum:
54+
- Secret
55+
- ConfigMap
56+
type: string
57+
name:
58+
description: |-
59+
Name of the values referent. Should reside in the same namespace as the
60+
referring resource.
61+
maxLength: 253
62+
minLength: 1
63+
type: string
64+
optional:
65+
default: false
66+
description: |-
67+
Optional indicates whether the referenced resource must exist, or whether to
68+
tolerate its absence. If true and the referenced resource is absent, proceed
69+
as if the resource was present but empty, without any variables defined.
70+
type: boolean
71+
required:
72+
- kind
73+
- name
74+
type: object
75+
type: array
4276
commonMetadata:
4377
description: |-
4478
CommonMetadata specifies the common labels and annotations that are
@@ -99,36 +133,6 @@ spec:
99133
description: Vendor denotes running kcl in the vendor mode.
100134
type: boolean
101135
type: object
102-
configReference:
103-
description: |-
104-
ConfigReference holds references to ConfigMaps and Secrets containing
105-
the KCL compile config. The ConfigMap and the Secret data keys represent the config names.
106-
properties:
107-
kind:
108-
description: Kind of the values referent, valid values are ('Secret',
109-
'ConfigMap').
110-
enum:
111-
- Secret
112-
- ConfigMap
113-
type: string
114-
name:
115-
description: |-
116-
Name of the values referent. Should reside in the same namespace as the
117-
referring resource.
118-
maxLength: 253
119-
minLength: 1
120-
type: string
121-
optional:
122-
default: false
123-
description: |-
124-
Optional indicates whether the referenced resource must exist, or whether to
125-
tolerate its absence. If true and the referenced resource is absent, proceed
126-
as if the resource was present but empty, without any variables defined.
127-
type: boolean
128-
required:
129-
- kind
130-
- name
131-
type: object
132136
dependsOn:
133137
description: |-
134138
DependsOn may contain a meta.NamespacedObjectReference slice

‎internal/controller/kclrun_controller.go‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,8 +278,40 @@ func (r *KCLRunReconciler) Reconcile(ctx context.Context, req ctrl.Request) (res
278278
conditions.MarkFalse(&obj, meta.ReadyCondition, meta.ArtifactFailedReason, "%s", err)
279279
return ctrl.Result{}, err
280280
}
281+
vars := make(map[string]string)
282+
for _, reference := range obj.Spec.ArgumentsReferences {
283+
namespacedName := types.NamespacedName{Namespace: obj.GetNamespace(), Name: reference.Name}
284+
switch reference.Kind {
285+
case "ConfigMap":
286+
cm := &corev1.ConfigMap{}
287+
if err := r.Client.Get(ctx, namespacedName, cm); err != nil {
288+
if reference.Optional && apierrors.IsNotFound(err) {
289+
// If optional, skip the not found error.
290+
continue
291+
} else {
292+
return ctrl.Result{}, fmt.Errorf("config reference from 'ConfigMap/%s' error: %w", reference.Name, err)
293+
}
294+
}
295+
for k, v := range cm.Data {
296+
vars[k] = strings.ReplaceAll(v, "\n", "")
297+
}
298+
case "Secret":
299+
secret := &corev1.Secret{}
300+
if err := r.Client.Get(ctx, namespacedName, secret); err != nil {
301+
if reference.Optional && apierrors.IsNotFound(err) {
302+
// If optional, skip the not found error.
303+
continue
304+
} else {
305+
return ctrl.Result{}, fmt.Errorf("config reference from 'Secret/%s' error: %w", reference.Name, err)
306+
}
307+
}
308+
for k, v := range secret.Data {
309+
vars[k] = strings.ReplaceAll(string(v), "\n", "")
310+
}
311+
}
312+
}
281313
// Compile the KCL source code into the Kubernetes manifests
282-
res, err := kcl.CompileKclPackage(&obj, dirPath)
314+
res, err := kcl.CompileKclPackage(&obj, dirPath, vars)
283315
if err != nil {
284316
conditions.MarkFalse(&obj, meta.ReadyCondition, "FetchFailed", err.Error())
285317
log.Error(err, "failed to compile the KCL source code")

‎internal/kcl/kcl.go‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
)
1414

1515
// Compile the KCL source code into kubernetes manifests.
16-
func CompileKclPackage(obj *v1alpha1.KCLRun, pkgPath string) (*kcl.KCLResultList, error) {
16+
func CompileKclPackage(obj *v1alpha1.KCLRun, pkgPath string, vars map[string]string) (*kcl.KCLResultList, error) {
1717
cli, _ := client.NewKpmClient()
1818
opts := opt.DefaultCompileOptions()
1919

@@ -29,15 +29,21 @@ func CompileKclPackage(obj *v1alpha1.KCLRun, pkgPath string) (*kcl.KCLResultList
2929
opts.Merge(kcl.WithSettings(settings))
3030
opts.SetHasSettingsYaml(true)
3131
}
32+
// Build KCL top level arguments
33+
var options []string
34+
for k, v := range vars {
35+
options = append(options, fmt.Sprintf("%s=%s", k, v))
36+
}
3237
if obj != nil {
38+
options = append(options, obj.Spec.Config.Arguments...)
3339
if obj.Spec.Config != nil {
3440
for _, s := range obj.Spec.Config.Settings {
3541
opts.Merge(kcl.WithSettings(s))
3642
opts.SetHasSettingsYaml(true)
3743
}
3844
opts.SetVendor(obj.Spec.Config.Vendor)
3945
opts.Merge(
40-
kcl.WithOptions(obj.Spec.Config.Arguments...),
46+
kcl.WithOptions(options...),
4147
kcl.WithOverrides(obj.Spec.Config.Overrides...),
4248
kcl.WithSelectors(obj.Spec.Config.PathSelectors...),
4349
kcl.WithSortKeys(obj.Spec.Config.SortKeys),

0 commit comments

Comments
 (0)