Skip to content

Docs: add DiscoveryConfig as an alternative method for configuring server discovery#62746

Merged
marcoandredinis merged 4 commits intomasterfrom
marco/docs/discovery-config-alternative
Jan 16, 2026
Merged

Docs: add DiscoveryConfig as an alternative method for configuring server discovery#62746
marcoandredinis merged 4 commits intomasterfrom
marco/docs/discovery-config-alternative

Conversation

@marcoandredinis
Copy link
Copy Markdown
Contributor

@marcoandredinis marcoandredinis commented Jan 9, 2026

Server Discovery allows users to auto enroll cloud server instances (eg, EC2, Azure VMs) into Teleport.
As an example, see
https://goteleport.com/docs/enroll-resources/auto-discovery/servers/ec2-discovery/ec2-discovery-manual/#step-45-configure-teleport-to-discover-ec2-instances
https://goteleport.com/docs/enroll-resources/auto-discovery/databases/#discovery-service-configuration

DiscoveryConfig resource was created some time ago to allow the dynamic registration of auto discovery rules.
This allow users to change them without interfering with the teleport.yaml of a DiscoveryService.
No file change and no service restart is required.

It is mostly used by the Discovery Wizard, however, we added some other entry points recently:

This PR changes server discovery guide docs to let users know that instead of using the static configuration (aka adding discovery rules in the teleport.yaml file), they can use the DiscoveryConfig.

I only changed the Server discovery guide to ensure we focus on that one and get it right.
After this PR gets merged, I'll change all the other guides accordingly.

@marcoandredinis marcoandredinis added the no-changelog Indicates that a PR does not require a changelog entry label Jan 9, 2026
@marcoandredinis marcoandredinis force-pushed the marco/docs/discovery-config-alternative branch from cb603c7 to 9d0f657 Compare January 9, 2026 18:35
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 9, 2026

Amplify deployment status

Branch Commit Job ID Status Preview Updated (UTC)
marco/docs/discovery-config-alternative 84106e7 17 ✅SUCCEED marco-docs-discovery-config-alternative 2026-01-16 16:08:20

@marcoandredinis marcoandredinis force-pushed the marco/docs/discovery-config-alternative branch from 9d0f657 to b718185 Compare January 12, 2026 09:33
@marcoandredinis marcoandredinis force-pushed the marco/docs/discovery-config-alternative branch from b718185 to 2940095 Compare January 12, 2026 10:43
@marcoandredinis marcoandredinis force-pushed the marco/docs/discovery-config-alternative branch from 2940095 to 796f306 Compare January 12, 2026 11:15
@marcoandredinis marcoandredinis force-pushed the marco/docs/discovery-config-alternative branch from 796f306 to cd086f6 Compare January 12, 2026 18:54
@marcoandredinis marcoandredinis force-pushed the marco/docs/discovery-config-alternative branch from cd086f6 to 2545174 Compare January 13, 2026 11:59
@marcoandredinis marcoandredinis changed the title Docs: add DiscoveryConfig as an alternative method for configuring discovery rules Docs: add DiscoveryConfig as an alternative method for configuring server discovery Jan 13, 2026
@marcoandredinis marcoandredinis force-pushed the marco/docs/discovery-config-alternative branch from 2545174 to e0af776 Compare January 13, 2026 14:52
@marcoandredinis marcoandredinis force-pushed the marco/docs/discovery-config-alternative branch from e0af776 to 3c97de8 Compare January 13, 2026 14:56
@marcoandredinis marcoandredinis force-pushed the marco/docs/discovery-config-alternative branch from 3c97de8 to 1369632 Compare January 13, 2026 15:14
@marcoandredinis marcoandredinis force-pushed the marco/docs/discovery-config-alternative branch from 1369632 to fdbdd2e Compare January 13, 2026 15:24
@marcoandredinis marcoandredinis force-pushed the marco/docs/discovery-config-alternative branch from fdbdd2e to cdba80a Compare January 13, 2026 15:35
@marcoandredinis marcoandredinis force-pushed the marco/docs/discovery-config-alternative branch from cdba80a to 15ecc4a Compare January 13, 2026 15:44
@marcoandredinis marcoandredinis marked this pull request as ready for review January 13, 2026 15:56
@github-actions github-actions bot requested a review from mmcallister January 13, 2026 15:56
@r0mant
Copy link
Copy Markdown
Collaborator

r0mant commented Jan 14, 2026

@marcoandredinis Ah, ok, I didn't know the IaC reference already includes it. It works but IMO the way it's structured right now makes it difficult to understand how the entire resource looks like. Can we include something at the beginning on it to show a couple of examples of a full resource spec like some other reference pages do (e.g. Role, User, etc.)?

@marcoandredinis
Copy link
Copy Markdown
Contributor Author

@ptgott Can you please take another look? I added an optional example yaml to the Teleport Resource Reference generator

@marcoandredinis
Copy link
Copy Markdown
Contributor Author

@r0mant Can you please take another look?

Copy link
Copy Markdown
Contributor

@ptgott ptgott left a comment

Choose a reason for hiding this comment

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

Good idea adding the examples directory!

@marcoandredinis marcoandredinis force-pushed the marco/docs/discovery-config-alternative branch from 7074b53 to 84106e7 Compare January 16, 2026 16:02
@marcoandredinis marcoandredinis added this pull request to the merge queue Jan 16, 2026
Merged via the queue into master with commit 7b0e6fe Jan 16, 2026
44 checks passed
@marcoandredinis marcoandredinis deleted the marco/docs/discovery-config-alternative branch January 16, 2026 16:46
marcoandredinis added a commit that referenced this pull request Jan 16, 2026
…rver discovery (#62746)

* Add discovery_config alternative to EC2 discovery guide

* add paragraph before tabs for dynamic / static matchers

* add example to discovery config

* add top level fields section to resource ref template
github-merge-queue bot pushed a commit that referenced this pull request Jan 16, 2026
…rver discovery (#62746) (#62926)

* Add discovery_config alternative to EC2 discovery guide

* add paragraph before tabs for dynamic / static matchers

* add example to discovery config

* add top level fields section to resource ref template
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport/branch/v18 documentation no-changelog Indicates that a PR does not require a changelog entry size/md

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants