Skip to content

Add kubernetes_secrets provider docs #482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChrsMark merged 2 commits into from
Apr 1, 2021
Merged

Add kubernetes_secrets provider docs #482

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99dda5d
Add kubernetes_secrets provider docs
ChrsMark Apr 1, 2021
f4bee22
minor fix
ChrsMark Apr 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/en/ingest-management/elastic-agent/elastic-agent-providers.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,40 @@ foo=bar elastic-agent run

You can reference the environment variable as `${env.foo}`.

[[kubernetes_secrets-provider]]
==== Kubernetes Secrets Provider

Provides access to the Kubernetes Secrets API.

Provider needs a `kubeconfig` file so as to establish connection to Kubernetes API,
or it can automatically reach the API if it runs in an inCluster environment (Agent runs as Pod).

[source,yaml]
----
providers.kubernetes_secrets:
#kube_config: /Users/elastic-agent/.kube/config
----

You can reference the Kubernetes Secrets variable as `${kubernetes_secrets.default.somesecret.value}`,
where `default` is the namespace of the Secret, `somesecret` is the name of the Secret and `value` the field
of the Secret to access.

If you run Agent on Kubernetes the proper rule in the `ClusterRole` is required so as Agent Pod to have access
to Secrets API:

[source,yaml]
----
- apiGroups: [""]
resources:
- secrets
verbs: ["get"]
----

CAUTION: The above rule will give permission to Agent Pod to access Kubernetes Secrets API.
This means that anyone who have access to Agent Pod (`kubectl exec` for example) will be able to
access Kubernetes Secrets API and get a specific secret no matter which namespace it belongs to.
In this, this option should be carefully considered.

[[dynamic-providers]]
=== Dynamic Providers

Expand Down