Skip to content

Commit 417cbc4

Browse files
DharmitDRicardo M. Oliveira
authored and
krishanbhasin-px
committed
feat(SDK+backend): Add optional field for the secret/configmap as env vars (kubeflow#12216)
* Add optional field for the secret/configmap as env vars Signed-off-by: ddalvi <[email protected]> * Add tests for the optional field for secret/configmap environment variables - Update protobuf definitions and regenerate bindings - Fix backend driver to handle Optional field correctly - Update tests and ensure backward compatibility Signed-off-by: ddalvi <[email protected]> --------- Signed-off-by: ddalvi <[email protected]> Co-authored-by: Ricardo M. Oliveira <[email protected]>
1 parent 38fd220 commit 417cbc4

File tree

10 files changed

+522
-91
lines changed

10 files changed

+522
-91
lines changed

‎backend/src/v2/driver/k8s.go‎

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -316,12 +316,19 @@ func extendPodSpecPatch(
316316
// Get secret env information
317317
for _, secretAsEnv := range kubernetesExecutorConfig.GetSecretAsEnv() {
318318
for _, keyToEnv := range secretAsEnv.GetKeyToEnv() {
319+
secretKeySelector := &k8score.SecretKeySelector{
320+
Key: keyToEnv.GetSecretKey(),
321+
}
322+
323+
// Set Optional field when explicitly provided (true or false), leave nil when not specified
324+
if secretAsEnv.Optional != nil {
325+
secretKeySelector.Optional = secretAsEnv.Optional
326+
}
327+
319328
secretEnvVar := k8score.EnvVar{
320329
Name: keyToEnv.GetEnvVar(),
321330
ValueFrom: &k8score.EnvVarSource{
322-
SecretKeyRef: &k8score.SecretKeySelector{
323-
Key: keyToEnv.GetSecretKey(),
324-
},
331+
SecretKeyRef: secretKeySelector,
325332
},
326333
}
327334

@@ -399,12 +406,19 @@ func extendPodSpecPatch(
399406
// Get config map env information
400407
for _, configMapAsEnv := range kubernetesExecutorConfig.GetConfigMapAsEnv() {
401408
for _, keyToEnv := range configMapAsEnv.GetKeyToEnv() {
409+
configMapKeySelector := &k8score.ConfigMapKeySelector{
410+
Key: keyToEnv.GetConfigMapKey(),
411+
}
412+
413+
// Set Optional field when explicitly provided (true or false), leave nil when not specified
414+
if configMapAsEnv.Optional != nil {
415+
configMapKeySelector.Optional = configMapAsEnv.Optional
416+
}
417+
402418
configMapEnvVar := k8score.EnvVar{
403419
Name: keyToEnv.GetEnvVar(),
404420
ValueFrom: &k8score.EnvVarSource{
405-
ConfigMapKeyRef: &k8score.ConfigMapKeySelector{
406-
Key: keyToEnv.GetConfigMapKey(),
407-
},
421+
ConfigMapKeyRef: configMapKeySelector,
408422
},
409423
}
410424

‎backend/src/v2/driver/k8s_test.go‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -602,6 +602,94 @@ func Test_extendPodSpecPatch_Secret(t *testing.T) {
602602
"param_1": structpb.NewStringValue("secret-name"),
603603
},
604604
},
605+
{
606+
"Valid - secret as env with optional true",
607+
&kubernetesplatform.KubernetesExecutorConfig{
608+
SecretAsEnv: []*kubernetesplatform.SecretAsEnv{
609+
{
610+
SecretNameParameter: inputParamConstant("my-secret"),
611+
KeyToEnv: []*kubernetesplatform.SecretAsEnv_SecretKeyToEnvMap{
612+
{
613+
SecretKey: "password",
614+
EnvVar: "SECRET_VAR",
615+
},
616+
},
617+
Optional: &[]bool{true}[0],
618+
},
619+
},
620+
},
621+
&k8score.PodSpec{
622+
Containers: []k8score.Container{
623+
{
624+
Name: "main",
625+
},
626+
},
627+
},
628+
&k8score.PodSpec{
629+
Containers: []k8score.Container{
630+
{
631+
Name: "main",
632+
Env: []k8score.EnvVar{
633+
{
634+
Name: "SECRET_VAR",
635+
ValueFrom: &k8score.EnvVarSource{
636+
SecretKeyRef: &k8score.SecretKeySelector{
637+
LocalObjectReference: k8score.LocalObjectReference{Name: "my-secret"},
638+
Key: "password",
639+
Optional: &[]bool{true}[0],
640+
},
641+
},
642+
},
643+
},
644+
},
645+
},
646+
},
647+
nil,
648+
},
649+
{
650+
"Valid - secret as env with optional false",
651+
&kubernetesplatform.KubernetesExecutorConfig{
652+
SecretAsEnv: []*kubernetesplatform.SecretAsEnv{
653+
{
654+
SecretNameParameter: inputParamConstant("my-secret"),
655+
KeyToEnv: []*kubernetesplatform.SecretAsEnv_SecretKeyToEnvMap{
656+
{
657+
SecretKey: "password",
658+
EnvVar: "SECRET_VAR",
659+
},
660+
},
661+
Optional: &[]bool{false}[0],
662+
},
663+
},
664+
},
665+
&k8score.PodSpec{
666+
Containers: []k8score.Container{
667+
{
668+
Name: "main",
669+
},
670+
},
671+
},
672+
&k8score.PodSpec{
673+
Containers: []k8score.Container{
674+
{
675+
Name: "main",
676+
Env: []k8score.EnvVar{
677+
{
678+
Name: "SECRET_VAR",
679+
ValueFrom: &k8score.EnvVarSource{
680+
SecretKeyRef: &k8score.SecretKeySelector{
681+
LocalObjectReference: k8score.LocalObjectReference{Name: "my-secret"},
682+
Key: "password",
683+
Optional: &[]bool{false}[0],
684+
},
685+
},
686+
},
687+
},
688+
},
689+
},
690+
},
691+
nil,
692+
},
605693
}
606694
for _, tt := range tests {
607695
t.Run(tt.name, func(t *testing.T) {
@@ -1011,6 +1099,94 @@ func Test_extendPodSpecPatch_ConfigMap(t *testing.T) {
10111099
"param_1": structpb.NewStringValue("cm-name"),
10121100
},
10131101
},
1102+
{
1103+
"Valid - config map as env with optional true",
1104+
&kubernetesplatform.KubernetesExecutorConfig{
1105+
ConfigMapAsEnv: []*kubernetesplatform.ConfigMapAsEnv{
1106+
{
1107+
ConfigMapNameParameter: inputParamConstant("my-cm"),
1108+
KeyToEnv: []*kubernetesplatform.ConfigMapAsEnv_ConfigMapKeyToEnvMap{
1109+
{
1110+
ConfigMapKey: "foo",
1111+
EnvVar: "CONFIG_MAP_VAR",
1112+
},
1113+
},
1114+
Optional: &[]bool{true}[0],
1115+
},
1116+
},
1117+
},
1118+
&k8score.PodSpec{
1119+
Containers: []k8score.Container{
1120+
{
1121+
Name: "main",
1122+
},
1123+
},
1124+
},
1125+
&k8score.PodSpec{
1126+
Containers: []k8score.Container{
1127+
{
1128+
Name: "main",
1129+
Env: []k8score.EnvVar{
1130+
{
1131+
Name: "CONFIG_MAP_VAR",
1132+
ValueFrom: &k8score.EnvVarSource{
1133+
ConfigMapKeyRef: &k8score.ConfigMapKeySelector{
1134+
LocalObjectReference: k8score.LocalObjectReference{Name: "my-cm"},
1135+
Key: "foo",
1136+
Optional: &[]bool{true}[0],
1137+
},
1138+
},
1139+
},
1140+
},
1141+
},
1142+
},
1143+
},
1144+
nil,
1145+
},
1146+
{
1147+
"Valid - config map as env with optional false",
1148+
&kubernetesplatform.KubernetesExecutorConfig{
1149+
ConfigMapAsEnv: []*kubernetesplatform.ConfigMapAsEnv{
1150+
{
1151+
ConfigMapNameParameter: inputParamConstant("my-cm"),
1152+
KeyToEnv: []*kubernetesplatform.ConfigMapAsEnv_ConfigMapKeyToEnvMap{
1153+
{
1154+
ConfigMapKey: "foo",
1155+
EnvVar: "CONFIG_MAP_VAR",
1156+
},
1157+
},
1158+
Optional: &[]bool{false}[0],
1159+
},
1160+
},
1161+
},
1162+
&k8score.PodSpec{
1163+
Containers: []k8score.Container{
1164+
{
1165+
Name: "main",
1166+
},
1167+
},
1168+
},
1169+
&k8score.PodSpec{
1170+
Containers: []k8score.Container{
1171+
{
1172+
Name: "main",
1173+
Env: []k8score.EnvVar{
1174+
{
1175+
Name: "CONFIG_MAP_VAR",
1176+
ValueFrom: &k8score.EnvVarSource{
1177+
ConfigMapKeyRef: &k8score.ConfigMapKeySelector{
1178+
LocalObjectReference: k8score.LocalObjectReference{Name: "my-cm"},
1179+
Key: "foo",
1180+
Optional: &[]bool{false}[0],
1181+
},
1182+
},
1183+
},
1184+
},
1185+
},
1186+
},
1187+
},
1188+
nil,
1189+
},
10141190
}
10151191
for _, tt := range tests {
10161192
t.Run(tt.name, func(t *testing.T) {

‎kubernetes_platform/go/kubernetesplatform/kubernetes_executor_config.pb.go‎

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

‎kubernetes_platform/proto/kubernetes_executor_config.proto‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ message SecretAsEnv {
7373
}
7474

7575
repeated SecretKeyToEnvMap key_to_env = 2;
76+
// An optional boolean value indicating whether the Secret must be defined.
77+
optional bool optional = 3;
7678

7779
// Name of the Secret.
7880
ml_pipelines.TaskInputsSpec.InputParameterSpec secret_name_parameter = 4;
@@ -176,6 +178,8 @@ message ConfigMapAsEnv {
176178

177179
// Name of the ConfigMap.
178180
ml_pipelines.TaskInputsSpec.InputParameterSpec config_map_name_parameter = 3;
181+
// An optional boolean value indicating whether the ConfigMap must be defined.
182+
optional bool optional = 4;
179183
}
180184

181185
message GenericEphemeralVolume {

‎kubernetes_platform/python/kfp/kubernetes/config_map.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ def use_config_map_as_env(
2424
task: PipelineTask,
2525
config_map_name: Union[pipeline_channel.PipelineParameterChannel, str],
2626
config_map_key_to_env: Dict[str, str],
27+
optional: bool = False,
2728
) -> PipelineTask:
2829
"""Use a Kubernetes ConfigMap as an environment variable as described by the `Kubernetes documentation
2930
https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#define-container-environment-variables-using-configmap-data` _.
@@ -32,6 +33,7 @@ def use_config_map_as_env(
3233
task: Pipeline task.
3334
config_map_name: Name of the ConfigMap.
3435
config_map_key_to_env: Dictionary of ConfigMap key to environment variable name. For example, ``{'foo': 'FOO'}`` sets the value of the ConfigMap's foo field to the environment variable ``FOO``.
36+
optional: Optional field specifying whether the ConfigMap must be defined.
3537
3638
Returns:
3739
Task object with updated ConfigMap configuration.
@@ -45,7 +47,7 @@ def use_config_map_as_env(
4547
env_var=env_var,
4648
) for config_map_key, env_var in config_map_key_to_env.items()
4749
]
48-
config_map_as_env = pb.ConfigMapAsEnv(key_to_env=key_to_env)
50+
config_map_as_env = pb.ConfigMapAsEnv(key_to_env=key_to_env, optional=optional)
4951

5052
config_map_name_parameter = common.parse_k8s_parameter_input(config_map_name, task)
5153
config_map_as_env.config_map_name_parameter.CopyFrom(config_map_name_parameter)

0 commit comments

Comments
 (0)