Skip to main content

Generic WebHook

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

What is "Generic WebHook" Hook about?

Installing the Generic WebHook hook will add a ReadOnly Hook to your namespace which is capable of sending scan results containing findings to a given webhook url.

Deployment

The generic-webhook chart can be deployed via helm:

# Install HelmChart (use -n to configure another namespace)
helm upgrade --install generic-webhook secureCodeBox/generic-webhook

Requirements

Kubernetes: >=v1.11.0-0

Additional Chart Configurations

✍ This documentation is currently work-in-progress.

Values

KeyTypeDefaultDescription
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.authenticationobject{"basic":{"passwordKey":"password","userSecret":"generic-webhook-credentials","usernameKey":"username"}}Optional basic authentication credentials
hook.authentication.basic.passwordKeystring"password"Name of the password key in the userSecret secret. Use this if you already have a secret with different key / value pairs
hook.authentication.basic.userSecretstring"generic-webhook-credentials"Link a pre-existing generic secret with usernameKey and passwordKey key / value pairs
hook.authentication.basic.usernameKeystring"username"Name of the username key in the userSecret secret. Use this if you already have a secret with different key / value pairs
hook.image.repositorystring"docker.io/securecodebox/hook-generic-webhook"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.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/)
webhookUrlstring"http://example.com"The URL of your WebHook endpoint

License

License

Code of secureCodeBox is licensed under the Apache License 2.0.