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

kilfoyle · 2024-12-10T22:59:15Z

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

github-actions · 2024-12-10T22:59:29Z

A documentation preview will be available soon.

🔨 Buildkite builds
📚 HTML diff
📙 Preview page

Request a new doc build by commenting

Rebuild this PR: run docs-build
Rebuild this PR and all Elastic docs: run docs-build rebuild

_{run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.}

_{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.}

kilfoyle · 2024-12-18T19:14:31Z

@cmacknz @blakerouse Would either of you mind reviewing this when you have a moment?

blakerouse · 2024-12-23T16:01:00Z

.../en/ingest-management/elastic-agent/configuration/providers/elastic-agent-providers.asciidoc

@@ -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.


This is not correct.

Suggested change

Providers are disabled by default.

Providers are automatically enabled if a provided is referenced in a policy.

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

blakerouse · 2024-12-23T16:01:22Z

.../en/ingest-management/elastic-agent/configuration/providers/elastic-agent-providers.asciidoc

-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`.


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

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

blakerouse · 2024-12-23T16:02:09Z

.../en/ingest-management/elastic-agent/configuration/providers/elastic-agent-providers.asciidoc


-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`.


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.

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

blakerouse · 2024-12-23T16:02:59Z

...management/elastic-agent/configuration/providers/kubernetes_leaderelection-provider.asciidoc

-`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`.


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

Changed to:

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

kilfoyle · 2025-01-02T18:36:46Z

Thanks a lot @blakerouse! I've updated as you suggested.

kilfoyle · 2025-01-09T21:28:33Z

@blakerouse does this look okay to merge?

blakerouse

Still some issues with it. See inline comments, hopefully it explains it better.

.../en/ingest-management/elastic-agent/configuration/providers/elastic-agent-providers.asciidoc

blakerouse · 2025-01-10T20:42:21Z

.../en/ingest-management/elastic-agent/configuration/providers/elastic-agent-providers.asciidoc


 Disable all providers by default and only enable explicitly configured providers by setting `agent.providers.initial_default: false`.

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


I don't think this needs to be change.

blakerouse · 2025-01-10T20:42:31Z

.../en/ingest-management/elastic-agent/configuration/providers/elastic-agent-providers.asciidoc

 providers:
  docker:
-    enabled: true


I don't think this needs to be change.

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).

blakerouse · 2025-01-10T20:43:39Z

...management/elastic-agent/configuration/providers/kubernetes_leaderelection-provider.asciidoc

@@ -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


Don't change.

blakerouse · 2025-01-10T20:44:11Z

...management/elastic-agent/configuration/providers/kubernetes_leaderelection-provider.asciidoc

@@ -23,8 +23,8 @@ providers.kubernetes_leaderelection:
  #leader_renewdeadline: 10
 ----

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


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.

…s/elastic-agent-providers.asciidoc Co-authored-by: Blake Rouse <blake.rouse@elastic.co>

kilfoyle · 2025-01-10T21:23:28Z

Thanks @blakerouse! I've reverted the changes you suggested to undo, and for the configuration example I provided the extra context that you suggested.

Sorry that I misunderstood this code change! :-)

blakerouse

Looks good, except I think the headers of that section also need to be reverted. The section is still talking about disabling providers.

.../en/ingest-management/elastic-agent/configuration/providers/elastic-agent-providers.asciidoc

…s/elastic-agent-providers.asciidoc Co-authored-by: Blake Rouse <blake.rouse@elastic.co>

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

6e2807a

kilfoyle added the backport-8.x label Dec 10, 2024

kilfoyle requested review from cmacknz and blakerouse December 10, 2024 22:59

kilfoyle requested a review from a team as a code owner December 10, 2024 22:59

blakerouse requested changes Dec 23, 2024

View reviewed changes

kilfoyle added 2 commits January 2, 2025 13:31

Add changes from Blake's review

7595bbc

touchup

d5a915d

kilfoyle requested a review from blakerouse January 2, 2025 18:36

blakerouse requested changes Jan 10, 2025

View reviewed changes

kilfoyle and others added 3 commits January 10, 2025 16:11

Update docs/en/ingest-management/elastic-agent/configuration/provider…

08ac123

…s/elastic-agent-providers.asciidoc Co-authored-by: Blake Rouse <blake.rouse@elastic.co>

Update docs/en/ingest-management/elastic-agent/configuration/provider…

e8c8071

…s/elastic-agent-providers.asciidoc Co-authored-by: Blake Rouse <blake.rouse@elastic.co>

Address Blake's comments

c2b3558

kilfoyle requested a review from blakerouse January 10, 2025 21:22

blakerouse previously approved these changes Jan 10, 2025

View reviewed changes

.../en/ingest-management/elastic-agent/configuration/providers/elastic-agent-providers.asciidoc Outdated Show resolved Hide resolved

.../en/ingest-management/elastic-agent/configuration/providers/elastic-agent-providers.asciidoc Outdated Show resolved Hide resolved

Update docs/en/ingest-management/elastic-agent/configuration/provider…

65978e9

…s/elastic-agent-providers.asciidoc Co-authored-by: Blake Rouse <blake.rouse@elastic.co>

kilfoyle dismissed blakerouse’s stale review via 65978e9 January 10, 2025 22:22

Update docs/en/ingest-management/elastic-agent/configuration/provider…

e017811

…s/elastic-agent-providers.asciidoc Co-authored-by: Blake Rouse <blake.rouse@elastic.co>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

kilfoyle commented Dec 10, 2024

github-actions bot commented Dec 10, 2024

kilfoyle commented Dec 18, 2024

blakerouse Dec 23, 2024

kilfoyle Jan 2, 2025

blakerouse Dec 23, 2024

kilfoyle Jan 2, 2025

blakerouse Dec 23, 2024

kilfoyle Jan 2, 2025

blakerouse Dec 23, 2024

kilfoyle Jan 2, 2025

kilfoyle commented Jan 2, 2025

kilfoyle commented Jan 9, 2025

blakerouse left a comment

blakerouse Jan 10, 2025

blakerouse Jan 10, 2025

blakerouse Jan 10, 2025

blakerouse Jan 10, 2025

blakerouse Jan 10, 2025

kilfoyle commented Jan 10, 2025

blakerouse left a comment

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


		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`.

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

Are you sure you want to change the base?

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

Conversation

kilfoyle commented Dec 10, 2024

github-actions bot commented Dec 10, 2024

kilfoyle commented Dec 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kilfoyle commented Jan 2, 2025

kilfoyle commented Jan 9, 2025

blakerouse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kilfoyle commented Jan 10, 2025

blakerouse left a comment

Choose a reason for hiding this comment