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

Create dedicated docs for Teleport's discovery service #38741

Closed
zmb3 opened this issue Feb 28, 2024 · 0 comments · Fixed by #38848
Closed

Create dedicated docs for Teleport's discovery service #38741

zmb3 opened this issue Feb 28, 2024 · 0 comments · Fixed by #38848
Assignees

Comments

@zmb3
Copy link
Collaborator

zmb3 commented Feb 28, 2024

Details

Several releases ago, we moved away from having individual services (kube_service, db_service, etc) perform discovery, and created a dedicated discovery_service that's responsible for discovering and enrolling resources in a Teleport cluster.

It's very hard to find any information on this service in our docs, because we don't have a dedicated section on discovery and the discovery docs are scattered across multiple separate sections.

How will we know this is resolved?

  • I would like to see a dedicated page on the discovery_service, what it is responsible for, and how to configure it.
  • Consider moving all discovery related information to dedicated sidebar section instead of splitting it across multiple separate sections.

Related Issues

@ptgott ptgott self-assigned this Feb 29, 2024
ptgott added a commit that referenced this issue Mar 1, 2024
Closes #38741

Add a dedicated sidebar section for the Teleport Discovery Service.
Since the Discovery Service is a separate agent service from the SSH
Service, Kubernetes Service, etc., it makes sense to add a dedicated
section for this service. In the future, we can include configuration
guides, architecture guides, etc. in this section.

To create the new section, this change moves existing auto-discovery
guides from other sections of the docs.
github-merge-queue bot pushed a commit that referenced this issue Mar 1, 2024
* Add a Discovery Service section

Closes #38741

Add a dedicated sidebar section for the Teleport Discovery Service.
Since the Discovery Service is a separate agent service from the SSH
Service, Kubernetes Service, etc., it makes sense to add a dedicated
section for this service. In the future, we can include configuration
guides, architecture guides, etc. in this section.

To create the new section, this change moves existing auto-discovery
guides from other sections of the docs.

* Respond to hugoShaka feedback

- Move the Kubernetes application discovery docs
- Edit the "Kubernetes Access" intro to include a link to Kubernetes
  auto-discovery
github-actions bot pushed a commit that referenced this issue Mar 1, 2024
Closes #38741

Add a dedicated sidebar section for the Teleport Discovery Service.
Since the Discovery Service is a separate agent service from the SSH
Service, Kubernetes Service, etc., it makes sense to add a dedicated
section for this service. In the future, we can include configuration
guides, architecture guides, etc. in this section.

To create the new section, this change moves existing auto-discovery
guides from other sections of the docs.
github-merge-queue bot pushed a commit that referenced this issue Mar 1, 2024
* Add a Discovery Service section

Closes #38741

Add a dedicated sidebar section for the Teleport Discovery Service.
Since the Discovery Service is a separate agent service from the SSH
Service, Kubernetes Service, etc., it makes sense to add a dedicated
section for this service. In the future, we can include configuration
guides, architecture guides, etc. in this section.

To create the new section, this change moves existing auto-discovery
guides from other sections of the docs.

* Respond to hugoShaka feedback

- Move the Kubernetes application discovery docs
- Edit the "Kubernetes Access" intro to include a link to Kubernetes
  auto-discovery
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants