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.

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
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ 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 enabled automatically if a provider is referenced in an {agent} policy.
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,12 +90,14 @@ 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 until they are referenced in a policy.

Disable all providers by default and only enable explicitly configured providers by setting `agent.providers.initial_default: false`.
You can disable all providers even if they are referenced in a policy by setting `agent.providers.initial_default: false`.

The following configuration disables all providers from running except for the docker provider, if it becomes referenced in the policy:

[source,yaml]
----
Expand Down