Skip to content
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

Update docs to indicate that providers are no longer enabled by default #1530

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Update docs to indicate that providers are no longer enabled by default #1530

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6e2807a
Update docs to indicate that providers are no longer enabled by default
kilfoyle Dec 10, 2024
7595bbc
Add changes from Blake's review
kilfoyle Jan 2, 2025
d5a915d
touchup
kilfoyle Jan 2, 2025
08ac123
Update docs/en/ingest-management/elastic-agent/configuration/provider…
kilfoyle Jan 10, 2025
e8c8071
Update docs/en/ingest-management/elastic-agent/configuration/provider…
kilfoyle Jan 10, 2025
c2b3558
Address Blake's comments
kilfoyle Jan 10, 2025
65978e9
Update docs/en/ingest-management/elastic-agent/configuration/provider…
kilfoyle Jan 10, 2025
e017811
Update docs/en/ingest-management/elastic-agent/configuration/provider…
kilfoyle Jan 10, 2025
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
18 changes: 10 additions & 8 deletions ...nagement/elastic-agent/configuration/providers/elastic-agent-providers.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,10 @@ providers:
- item: key2
----

Explicitly disable a provider by setting `enabled: false`. All providers
are prefixed without name collisions. The name of the provider is in the key in the configuration.
Providers are disabled by default.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not correct.

Suggested change
Providers are disabled by default.
Providers are automatically enabled if a provided is referenced in a policy.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to Providers are enabled automatically if a provider is referenced in an {agent} policy. via 7595bbc

Explicitly enable a provider by setting `enabled: true`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even this will not cause a provide to run. The provider must be referenced in the policy or it will not run.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the "Explicitly enable..." sentence.

All providers are prefixed without name collisions.
The name of the provider is in the key in the configuration.

[source,yaml]
----
Expand Down Expand Up @@ -89,19 +91,19 @@ configuration.
* <<kubernetes-provider,Kubernetes Provider>>

[discrete]
[[disable-providers-by-default]]
=== Disabling Providers By Default
[[enable-providers-by-default]]
kilfoyle marked this conversation as resolved.
Show resolved Hide resolved
=== Enabling providers By default
kilfoyle marked this conversation as resolved.
Show resolved Hide resolved

All registered providers are enabled by default.
All registered providers are disabled by default.
kilfoyle marked this conversation as resolved.
Show resolved Hide resolved

Disable all providers by default and only enable explicitly configured providers by setting `agent.providers.initial_default: false`.
Enable all providers by default and only disable explicitly configured providers by setting `agent.providers.initial_default: true`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should really keep this section how it was. As this still applies.

If you set initial_default: false and you have a provider referenced in the policy the provider still will not run.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Roger that. I've changed this back to the original.


[source,yaml]
----
agent.providers.initial_default: false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this needs to be change.

agent.providers.initial_default: true
providers:
docker:
enabled: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this needs to be change.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could possibly provide context on what this configuration is doing.

This disables all provides from running except for the docker provider (if it becomes referenced in the policy).

enabled: false
----

include::local-provider.asciidoc[leveloffset=+1]
Expand Down
6 changes: 3 additions & 3 deletions ...astic-agent/configuration/providers/kubernetes_leaderelection-provider.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ It can automatically reach the API if it's running in an InCluster environment (
[source,yaml]
----
providers.kubernetes_leaderelection:
#enabled: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't change.

#enabled: false
#kube_config: /Users/elastic-agent/.kube/config
#kube_client_options:
# qps: 5
Expand All @@ -23,8 +23,8 @@ providers.kubernetes_leaderelection:
#leader_renewdeadline: 10
----

`enabled`:: (Optional) Defaults to true. To explicitly disable the LeaderElection provider,
set `enabled: false`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't change this.

It is still on, if its referenced. Setting to enabled: false would turn it off completely, even if it was referenced.

`enabled`:: (Optional) Defaults to false. To explicitly enable the LeaderElection provider,
set `enabled: true`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not true. It will turn on if anywhere in the policy references the kubernetes_leaderelection.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to:

`enabled`:: (Optional) Defaults to false.
The LeaderElection provider is enabled automatically when the `kubernetes_leaderelection` is referenced anywhere in the {agemt} policy.

`kube_config`:: (Optional) Use the given config file as configuration for the Kubernetes
client. If `kube_config` is not set, `KUBECONFIG` environment variable will be
checked and will fall back to InCluster if it's not present.
Expand Down
Loading