add docs for k8s kubeconfig, defaultNamespace (#3803)

* add docs for k8s kubeconfig, defaultNamespace

Signed-off-by: Mukundan Sundararajan <65565396+mukundansundar@users.noreply.github.com>

* address review comments.

Signed-off-by: Mukundan Sundararajan <65565396+mukundansundar@users.noreply.github.com>

---------

Signed-off-by: Mukundan Sundararajan <65565396+mukundansundar@users.noreply.github.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
This commit is contained in:
Mukundan Sundararajan 2023-10-10 08:25:44 -07:00 committed by GitHub
parent af4b79388c
commit ea00e24dbc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 2 deletions

View File

@ -36,6 +36,7 @@ spec:
| `namespace` | Y | Input | The Kubernetes namespace to read events from | `"default"` |
| `resyncPeriodInSec` | N | Input | The period of time to refresh event list from Kubernetes API server. Defaults to `"10"` | `"15"`
| `direction` | N | Input | The direction of the binding | `"input"`
| `kubeconfigPath` | N | Input | The path to the kubeconfig file. If not specified, the binding uses the default in-cluster config value | `"/path/to/kubeconfig"`
## Binding support

View File

@ -33,7 +33,11 @@ The above example uses secrets as plain strings. It is recommended to use a secr
## Spec metadata fields
For the Kubernetes secret store component, there are no metadata attributes.
| Field | Required | Details | Example |
|--------------------|:--------:|------------|-----|---------|
| `defaultNamespace` | N | Default namespace to retrieve secrets from. If unset, the namespace must be specified for each key, as `namespace/secretName/key` | `"default-ns"` |
| `kubeconfigPath` | N | The path to the kubeconfig file. If not specified, the component uses the default in-cluster config value | `"/path/to/kubeconfig"`
## Related links
[Cryptography building block]({{< ref cryptography >}})

View File

@ -32,7 +32,12 @@ spec:
```
## Spec metadata fields
For the Kubernetes secret store component, there are no metadata attributes.
| Field | Required | Details | Example |
|--------------------|:--------:|------------|-----|---------|
| `defaultNamespace` | N | Default namespace to retrieve secrets from. If unset, the `namespace` must be specified in each request metadata or via environment variable `NAMESPACE` | `"default-ns"` |
| `kubeconfigPath` | N | The path to the kubeconfig file. If not specified, the store uses the default in-cluster config value | `"/path/to/kubeconfig"`
## Optional per-request metadata properties