Support for optional field in configmap / secret ref

[GuyCarmy]

No description provided.

[GuyCarmy]

Hi @ltamaster, are you still maintaining this repo?
a very small PR to enable "optional" for envFrom for jobs, tested on my side, please review.
Thanks

[GuyCarmy]

Hi @fdevans, I see you were active in this repo last week, any chance you can take a look at this small PR?

[Copilot]

Pull Request Overview

This PR adds support for the optional field in configmap and secret references in Kubernetes job creation. The changes enable users to specify whether a configmap or secret reference should be treated as optional during job execution.

• Extracts configmap and secret references to separate variables for cleaner code
• Adds support for the optional field in both V1ConfigMapEnvSource and V1SecretEnvSource
• Fixes parameter passing by using named parameters instead of positional ones

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

The original code was passing the name as a positional argument, but V1ConfigMapEnvSource expects named parameters. However, the API typically expects the optional parameter to be a boolean. Using .get('optional') could return None, which may not be handled correctly by the Kubernetes client. Consider using .get('optional', False) to provide a default boolean value.

[Copilot]

Similar to the configmap reference, the optional parameter should have a boolean default value. Using .get('optional') could return None, which may cause issues with the Kubernetes client. Consider using .get('optional', False) to ensure a proper boolean value is always passed.

[GuyCarmy]

@fdevans fixed according to the copilot suggestions

[fdevans]

@GuyCarmy Thanks for the contribution! This is a useful feature addition.

Code Review

The implementation looks good:

• ✅ Clean refactoring by extracting refs to variables
• ✅ Proper use of named parameters instead of positional
• ✅ Correct handling of the optional field with .get('optional', False) defaults
• ✅ Follows Kubernetes API conventions

Requests Before Merge

1. Rebase on Latest Master

Your branch is behind master by several commits, including important security updates (urllib3 and kubernetes client upgrades for CVE fixes). Please rebase on the latest master:

git fetch upstream
git rebase upstream/master
# Resolve any conflicts if needed
git push --force-with-lease

2. Add Documentation

Please add an example to the README showing how to use the new optional field. Something like:

In the "Create / Delete / Re-run Jobs" section, add an example showing:

• How to specify optional: true in a configMapRef
• How to specify optional: true in a secretRef
• What the behavior difference is (job starts even if resource is missing vs fails)

This will help users understand when and how to use this feature.

Example Documentation Format

envFrom:
  - configMapRef:
      name: my-config
      optional: true  # Job will start even if my-config doesn't exist
  - secretRef:
      name: my-secret
      optional: false  # Job will fail if my-secret doesn't exist (default)

Once you've rebased and added the documentation, we'll be ready to merge. Thanks again for the contribution!