Update docs to indicate that providers are no longer enabled by default #1530
Conversation
|
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
|
@cmacknz @blakerouse Would either of you mind reviewing this when you have a moment? |
| @@ -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. | |||
There was a problem hiding this comment.
This is not correct.
| Providers are disabled by default. | |
| Providers are automatically enabled if a provided is referenced in a policy. |
| 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. | ||
| Explicitly enable a provider by setting `enabled: true`. |
There was a problem hiding this comment.
Even this will not cause a provide to run. The provider must be referenced in the policy or it will not run.
|
|
||
| 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`. |
There was a problem hiding this comment.
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.
| `enabled`:: (Optional) Defaults to true. To explicitly disable the LeaderElection provider, | ||
| set `enabled: false`. | ||
| `enabled`:: (Optional) Defaults to false. To explicitly enable the LeaderElection provider, | ||
| set `enabled: true`. |
There was a problem hiding this comment.
Not true. It will turn on if anywhere in the policy references the kubernetes_leaderelection.
This updates the Provider docs to indicate that providers are no longer enabled by default, as a result of elastic/elastic-agent#6169
The main change is to Configure providers for standalone Elastic Agent:
I've also updated the Kubernetes LeaderElection Provider
I don't think any other providers pages need updating. The Kubernetes provider supports enabling individual resources (pods, nodes, or services), but I assume the defaults for that remain as is.
Closes: #1529
Target: 8.18