Helm - Juice Shop - Custom environment variables and application config.yml

[fbuchmeier-abi]

Description

Added two new options to the Juice Shop Helm Chart:

• customConfig allows passing in a custom config file in yaml format
• containerEnv allows setting custom container environment variables (for the juice-shop container), e.g. to use a different config file

Quick question, which license header to I have to add to the new configmap.yaml and what implications does this have?

Thanks!

Checklist

• [ x ] Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests.

[J12934]

Hi @fbuchmeier-abi thanks for the contribution looks good 👍

Not a lawyer so can't give you any legal guidance but my understanding is:

• The License header should match the copyright field from the License file: https://github.com/secureCodeBox/secureCodeBox/blob/main/LICENSES/Apache-2.0.txt#L61
• The license header is more of a precaution in case somebody copies / takes a single file out of the context of the repo
• The sign-off flag on the commit gives the repo owner the (copy?)right to potentially use the code in a context outside the current Apache 2.0 license, e.g. release a new version of the SCB under MIT license without having to collect the signature of all previous contributors.

I'd like to change the copyright holder in the future to some "entity" which isn't just "iteratec", like "secureCodeBox core team" but not sure what the entails legally so can't promise anything 🤞

[J12934]

Some small suggestions to properly include the descriptions / comments in side the helm docs page shown on artificthub.io.

(These are automatically generated using: https://github.com/norwoodj/helm-docs)

[fbuchmeier-abi]

@J12934 thank you for the suggestions and the explanation. I need to check with my coworker first if the license header is OK for us. I'll update you once this is done.

Regards,
Florian.

[fbuchmeier-abi]

@J12934 I've updated the PR with the license header as requested: 78149d2

Anything else I can do?

Regards,
Florian.

[J12934]

Perfect, thank you 🚀

[J12934]

Tested this out works great 👍

One thing I've noticed is that you'll have to pretty much the entire default config file to have all required config values.
This is "normally" not required in Juice Shop as the customConfig get merged with the default config. Any values not overwritten will just use the default config. This doesn't work here as the volumeMount overwrites the entire config directory.

Was this intentional @fbuchmeier-abi ? Otherwise we could configure the mount of the custom config file to just write the one file without replacing the complete config directory.