Skip to content

Commit 3e77779

Browse files
committed
Address review comments
1 parent a1a3d0e commit 3e77779

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

reference/fleet/providers.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ How you use providers depends on whether you're running a standalone or a {{flee
2323

2424
### Using providers on standalone {{agent}} [using-providers-standalone-agent]
2525

26-
On standalone {{agent}}, providers can be configured through the `providers` key in the `elastic-agent.yml` configuration file. You can enable, disable, and configure provider settings as needed. For more details, refer to [Provider configuration](#provider_configuration).
26+
On standalone {{agent}}, providers can be configured through the `providers` key in the `elastic-agent.yml` configuration file. By default, all providers are enabled, but {{agent}} runs them only if they are referenced in the configuration file or in an {{agent}} policy. Disabled providers are not run even if they are referenced.
27+
28+
You can enable, disable, and configure provider settings as needed. For more details, refer to [Provider configuration](#provider_configuration).
2729

2830
### Using providers on {{fleet}}-managed {{agent}} [using-providers-fleet-managed-agent]
2931

@@ -34,7 +36,9 @@ Some providers can be configured on {{k8s}} deployments using ConfigMaps. For mo
3436

3537
## Provider configuration [provider_configuration]
3638

37-
On standalone {{agent}}, provider configuration is specified under the top-level `providers` key in the `elastic-agent.yml` configuration. All registered providers are enabled by default. If a provider cannot connect, no mappings are produced.
39+
On standalone {{agent}}, provider configuration is specified under the top-level `providers` key in the `elastic-agent.yml` configuration file. All registered providers are enabled by default but they are run by {{agent}} only if they are referenced. If a provider cannot connect, no mappings are produced.
40+
41+
All providers are prefixed without name collisions. The name of the provider is in the key in the configuration.
3842

3943
The following example shows two providers (`local` and `local_dynamic`) that supply custom keys on a standalone {{agent}}:
4044

@@ -53,16 +57,16 @@ providers:
5357
item: key3
5458
```
5559
56-
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.
57-
58-
For example, to disable the Docker provider in a standalone {{agent}}:
60+
If a provider is referenced in an {{agent}} policy, it is turned on automatically unless it's explicitly disabled in the `elastic-agent.yml` configuration file. For example, to disable the Docker provider in a standalone {{agent}}, set:
5961

6062
```yaml
6163
providers:
6264
docker:
6365
enabled: false
6466
```
6567

68+
With this setting, {{agent}} will not run the Docker provider even if it's referenced in an {{agent}} policy.
69+
6670
{{agent}} supports two broad types of providers: [context](#context-providers) and [dynamic](#dynamic-providers).
6771

6872

@@ -97,11 +101,11 @@ Dynamic providers give an array of multiple key-value mappings. Each key-value m
97101

98102
### Disabling providers by default [disable-providers-by-default]
99103

100-
All registered providers are disabled by default until they are referenced in a policy.
104+
Registered providers are run by {{agent}} if they are referenced in the {{agent}} configuration or in a policy.
101105

102-
On standalone {{agent}}, you can disable all providers even if they are referenced in a policy by setting `agent.providers.initial_default: false`.
106+
On standalone {{agent}}, you can disable all providers by setting `agent.providers.initial_default: false`, preventing them from running even if they are referenced.
103107

104-
The following configuration disables all providers from running except for the docker provider, if it becomes referenced in the policy:
108+
The following configuration disables all providers with the exception of the Docker provider, which is run when it's referenced in the policy:
105109

106110
```yaml
107111
agent.providers.initial_default: false

0 commit comments

Comments
 (0)