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.

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

Adding clarification that Endpoints are still required when EndpointSlices are enabled. #16684

Merged
merged 1 commit into from
Oct 6, 2019
Merged

Adding clarification that Endpoints are still required when EndpointSlices are enabled. #16684

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 9 additions & 0 deletions content/en/docs/tasks/administer-cluster/enabling-endpoint-slices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,15 @@ network endpoints, they will be split into multiple smaller Endpoint Slice
resources instead of a single large Endpoints resource.

## Enabling Endpoint Slices

{{< feature-state for_k8s_version="v1.16" state="alpha" >}}

{{< note >}}
Although Endpoint Slices may eventually replace Endpoints, many Kubernetes
components still rely on Endpoints. For now, enabling Endpoint Slices should be
seen as an addition to Endpoints in a cluster, not a replacement for them.
{{< /note >}}

As an alpha feature, Endpoint Slices are not enabled by default in Kubernetes.
Copy link
Contributor

Choose a reason for hiding this comment

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

hello @robscott .
As I recall, this task page is evolving. What do you think about adding:

  • a feature state shortcode at around line 30 or in the overview section?

{{< feature-state for_k8s_version="v1.16" state="alpha" >}}

  • a note shortcode to replace the content in the new section:

{{< note >}}
Although Endpoint Slices may eventually replace Endpoints, many Kubernetes
components still rely on Endpoints. For now, enabling Endpoint Slices should be
seen as an addition to Endpoints in a cluster, not a replacement for them.
{{< /note >}}

Copy link
Member Author

Choose a reason for hiding this comment

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

Hey @kbhawkey, I really like this idea, thanks! I've pushed an update with those changes. As I'm thinking about this a bit more, this entire task is only relevant when Endpoint Slices are in alpha, and once they graduate to beta and are enabled by default (hopefully in 1.17), the task should be removed. Do I need to do anything to make that more clear in this task or should I just add a PR to remove the task once EndpointSlices reach beta?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @robscott . I suppose you can decide whether to update or remove this page when Endpoint Slices reaches beta. Of course you can add more content or change the content anytime.

Enabling Endpoint Slices requires as many as 3 changes to Kubernetes cluster
configuration.
Expand Down