Skip to content

Commit 97319e8

Browse files
rseedorffsecureCodeBoxBot
authored andcommitted
Updating Helm Docs
Signed-off-by: GitHub Actions <securecodebox@iteratec.com>
1 parent 22aeed8 commit 97319e8

2 files changed

Lines changed: 6 additions & 8 deletions

File tree

‎hooks/generic-webhook/README.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,12 @@ Kubernetes: `>=v1.11.0-0`
5656
| Key | Type | Default | Description |
5757
|-----|------|---------|-------------|
5858
| hook.affinity | object | `{}` | 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/) |
59-
| hook.authentication | object | `{"basic":{"passwordKey":"password","userSecret":"generic-webhook-credentials","usernameKey":"username"}}` | Optional basic authentication credentials |
59+
| hook.authentication | object | `{"apikey":{"headerName":"X-Example-Header","headerValue":"example","userSecret":"generic-webhook-credentials"},"basic":{"passwordKey":"password","userSecret":"generic-webhook-credentials","usernameKey":"username"}}` | Optional basic authentication credentials or apikey |
60+
| hook.authentication.apikey.headerName | string | `"X-Example-Header"` | Customize header name as per your needs ex: X-Api-Key |
61+
| hook.authentication.apikey.userSecret | string | `"generic-webhook-credentials"` | Link a pre-existing generic secret with `usernameKey` and `passwordKey` key / value pairs |
6062
| hook.authentication.basic.passwordKey | string | `"password"` | Name of the password key in the `userSecret` secret. Use this if you already have a secret with different key / value pairs |
6163
| hook.authentication.basic.userSecret | string | `"generic-webhook-credentials"` | Link a pre-existing generic secret with `usernameKey` and `passwordKey` key / value pairs |
6264
| hook.authentication.basic.usernameKey | string | `"username"` | Name of the username key in the `userSecret` secret. Use this if you already have a secret with different key / value pairs |
63-
| hook.authentication.apikey.userSecret | string | `"generic-webhook-credentials"` | Link a pre-existing generic secret with `usernameKey` and `passwordKey` key / value pairs |
64-
| hook.authentication.apikey.headerName | string | `"X-api-key"` | Customize header name as per your needs |
65-
| hook.authentication.apikey.headerValue | string | `"26ea529e517748baa6d87ebfe5781475"` | Use your API key |
6665
| hook.image.repository | string | `"docker.io/securecodebox/hook-generic-webhook"` | Hook image repository |
6766
| hook.image.tag | string | defaults to the charts version | The image Tag defaults to the charts version if not defined. |
6867
| hook.labels | object | `{}` | Add Kubernetes Labels to the hook definition |

‎hooks/generic-webhook/docs/README.ArtifactHub.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,12 @@ Kubernetes: `>=v1.11.0-0`
6464
| Key | Type | Default | Description |
6565
|-----|------|---------|-------------|
6666
| hook.affinity | object | `{}` | 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/) |
67-
| hook.authentication | object | `{"basic":{"passwordKey":"password","userSecret":"generic-webhook-credentials","usernameKey":"username"}}` | Optional basic authentication credentials |
67+
| hook.authentication | object | `{"apikey":{"headerName":"X-Example-Header","headerValue":"example","userSecret":"generic-webhook-credentials"},"basic":{"passwordKey":"password","userSecret":"generic-webhook-credentials","usernameKey":"username"}}` | Optional basic authentication credentials or apikey |
68+
| hook.authentication.apikey.headerName | string | `"X-Example-Header"` | Customize header name as per your needs ex: X-Api-Key |
69+
| hook.authentication.apikey.userSecret | string | `"generic-webhook-credentials"` | Link a pre-existing generic secret with `usernameKey` and `passwordKey` key / value pairs |
6870
| hook.authentication.basic.passwordKey | string | `"password"` | Name of the password key in the `userSecret` secret. Use this if you already have a secret with different key / value pairs |
6971
| hook.authentication.basic.userSecret | string | `"generic-webhook-credentials"` | Link a pre-existing generic secret with `usernameKey` and `passwordKey` key / value pairs |
7072
| hook.authentication.basic.usernameKey | string | `"username"` | Name of the username key in the `userSecret` secret. Use this if you already have a secret with different key / value pairs |
71-
| hook.authentication.apikey.userSecret | string | `"generic-webhook-credentials"` | Link a pre-existing generic secret with `usernameKey` and `passwordKey` key / value pairs |
72-
| hook.authentication.apikey.headerName | string | `"X-api-key"` | Customize header name as per your needs |
73-
| hook.authentication.apikey.headerValue | string | `"26ea529e517748baa6d87ebfe5781475"` | Use your API key |
7473
| hook.image.repository | string | `"docker.io/securecodebox/hook-generic-webhook"` | Hook image repository |
7574
| hook.image.tag | string | defaults to the charts version | The image Tag defaults to the charts version if not defined. |
7675
| hook.labels | object | `{}` | Add Kubernetes Labels to the hook definition |

0 commit comments

Comments
 (0)