Skip to main content

Update Field

License Apache-2.0GitHub release (latest SemVer)OWASP Lab ProjectArtifact HUBGitHub Repo starsTwitter Follower

What is "Update Field" Hook about?

✍ This documentation is currently work-in-progress.

Deployment

The update-field-hook chart can be deployed via helm:

# Install HelmChart (use -n to configure another namespace)
helm upgrade --install update-field-hook secureCodeBox/update-field-hook

Requirements

Kubernetes: >=v1.11.0-0

Additional Chart Configurations

Installing the Update Field hook will add a ReadAndWrite Hook to your namespace, which can be used to add or update fields from your findings.

helm upgrade --install ufh secureCodeBox/update-field-hook --set attribute.name="category" --set attribute.value="my-own-category"

✍ This documentation is currently work-in-progress.

Values

KeyTypeDefaultDescription
attribute.namestring"category"The name of the attribute you want to add to each finding result
attribute.valuestring"my-own-category"The value of the attribute you want to add to each finding result
hook.affinityobject{}Optional affinity settings that control how the hook job is scheduled (see: https://kubernetes.io/docs/tasks/configure-pod-container/assign-pods-nodes-using-node-affinity/)
hook.image.repositorystring"docker.io/securecodebox/hook-update-field-hook"Hook image repository
hook.image.tagstringdefaults to the charts versionThe image Tag defaults to the charts version if not defined.
hook.labelsobject{}Add Kubernetes Labels to the hook definition
hook.priorityint0Hook priority. Higher priority Hooks are guaranteed to execute before low priority Hooks.
hook.resourcesobject{ requests: { cpu: "200m", memory: "100Mi" }, limits: { cpu: "400m", memory: "200Mi" } }Optional resources lets you control resource limits and requests for the hook container. See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
hook.tolerationslist[]Optional tolerations settings that control how the hook job is scheduled (see: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/)
hook.ttlSecondsAfterFinishedstringnilSeconds after which the kubernetes job for the hook will be deleted. Requires the Kubernetes TTLAfterFinished controller: https://kubernetes.io/docs/concepts/workloads/controllers/ttlafterfinished/
imagePullSecretslist[]Define imagePullSecrets when a private registry is used (see: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/)

License

License

Code of secureCodeBox is licensed under the Apache License 2.0.