Skip to content

Update docs for deprecation of Endpoints API #49831

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Apr 9, 2025
Merged

Update docs for deprecation of Endpoints API #49831

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6fb21ab
KEP-4974: Update documentation for Endpoints deprecation
danwinship Feb 16, 2025
56ed5a8
Bring EndpointSlice docs up to date
danwinship Feb 16, 2025
4f21c78
Fix up examples that still used `kubectl get endpoints`
danwinship Feb 16, 2025
2411fae
Replace various passing references to Endpoints with EndpointSlices
danwinship Feb 16, 2025
57347a6
Update main headings for Endpoints and Endpoint Slice Mirroring
danwinship Feb 16, 2025
0d29bb5
Update glossary for Endpoints deprecation
danwinship Apr 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions content/en/docs/reference/glossary/endpoint-slice.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,13 @@ id: endpoint-slice
date: 2018-04-12
full_link: /docs/concepts/services-networking/endpoint-slices/
short_description: >
A way to group network endpoints together with Kubernetes resources.
EndpointSlices track the IP addresses of Pods with matching Service selectors.

aka:
tags:
- networking
---
A way to group network endpoints together with Kubernetes resources.
EndpointSlices track the IP addresses of Pods with matching {{< glossary_tooltip text="selectors" term_id="selector" >}}.

<!--more-->

A scalable and extensible way to group network endpoints together. These can be
used by {{< glossary_tooltip text="kube-proxy" term_id="kube-proxy" >}} to
establish network routes on each {{< glossary_tooltip text="node" term_id="node" >}}.
EndpointSlices can be configured manually for {{< glossary_tooltip text="Services" term_id="service" >}} without selectors specified.
13 changes: 9 additions & 4 deletions content/en/docs/reference/glossary/endpoint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,19 @@ id: endpoints
date: 2020-04-23
full_link:
short_description: >
Endpoints track the IP addresses of Pods with matching Service selectors.
An endpoint of a Service is one of the Pods (or external servers) that implements the Service.
Copy link
Member

Choose a reason for hiding this comment

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

despite is deprecated the API exist, so I think the old definition still applies

Copy link
Member

Choose a reason for hiding this comment

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

I see, it was dicussed here #49831 (comment) , it seems is the preference to follow this path


aka:
tags:
- networking
---
Endpoints track the IP addresses of Pods with matching {{< glossary_tooltip text="selectors" term_id="selector" >}}.
An endpoint of a {{< glossary_tooltip text="Service" term_id="service" >}} is one of the {{< glossary_tooltip text="Pods" term_id="pod" >}} (or external servers) that implements the Service.

<!--more-->
Endpoints can be configured manually for {{< glossary_tooltip text="Services" term_id="service" >}} without selectors specified.
The {{< glossary_tooltip text="EndpointSlice" term_id="endpoint-slice" >}} resource provides a scalable and extensible alternative to Endpoints.
For Services with {{< glossary_tooltip text="selectors" term_id="selector" >}},
the EndpointSlice controller will automatically create one or more {{<
glossary_tooltip text="EndpointSlices" term_id="endpoint-slice" >}} giving the
IP addresses of the selected endpoint Pods.

EndpointSlices can also be created manually to indicate the endpoints of
Services that have no selector specified.