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

Improvement for k8s.io/docs/concepts/cluster-administration/addons/ #47420

Open
kirenpillay opened this issue Aug 10, 2024 · 10 comments
Open

Improvement for k8s.io/docs/concepts/cluster-administration/addons/ #47420

kirenpillay opened this issue Aug 10, 2024 · 10 comments
Labels
language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle.

Comments

@kirenpillay
Copy link

Add the actual command to add an add-on into your cluster.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Aug 10, 2024
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@dipesh-rawat
Copy link
Member

Page reported in issue (based on initial title): https://kubernetes.io/docs/concepts/cluster-administration/addons/
/language en

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Aug 10, 2024
@dipesh-rawat
Copy link
Member

At the start of the page, there is a note stating,

Note: This section links to third party projects that provide functionality required by Kubernetes. The Kubernetes project authors aren't responsible for these projects, which are listed alphabetically. To add a project to this list, read the content guide before submitting a change. More information.

This page lists some of the available add-ons and links to their respective installation instructions.

Since these add-ons are maintained by third parties, we do not provide specific commands for adding them to your cluster directly on this page. Instead, we link to the relevant documentation from the third-party projects to ensure you have the most accurate and up-to-date information for installation.

@utkarsh-singh1
Copy link
Contributor

utkarsh-singh1 commented Aug 11, 2024

Some of the tools have their own pages, so it would be better to locate them.

@utkarsh-singh1
Copy link
Contributor

You can find addons in tasks.

@utkarsh-singh1
Copy link
Contributor

utkarsh-singh1 commented Aug 11, 2024

You can explore this link to explore the doc on available clustet-network-addons.

@utkarsh-singh1
Copy link
Contributor

Addtionally this link can be added to what's more section.

@sftim
Copy link
Contributor

sftim commented Aug 12, 2024

We have some in-project addons and the process to set them up is really poorly explained. Despite its title, Installing Addons is just a list of some addons.

Tutorial pages for deploying key addons would be useful; I'm thinking:

  • kube-metrics
  • kube-state-metrics
  • Cluster Autoscaler (or suggest reading cloud provider docs)
  • Karpenter (or suggest reading cloud provider docs)
  • Gateway API
  • Descheduler
  • VerticalPodAutoscaler

We could also mention:

  • Node problem detector
  • JobSet
  • LeaderWorkerSet
  • kueue
  • Node maintenance controller / operator (NB not yet part of Kubernetes)

If we're sure we don't want to document any install steps for any addons, we could still change the page title of Installing Addons.

/sig cluster-lifecycle


@kirenpillay would you be willing to change the focus of this issue, and for its title to be “Document installing official Kubernetes addons”?

@k8s-ci-robot k8s-ci-robot added the sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. label Aug 12, 2024
@neolit123
Copy link
Member

We have some in-project addons and the process to set them up is really poorly explained. Despite its title, Installing Addons is just a list of some addons.

Tutorial pages for deploying key addons would be useful; I'm thinking:

we can claim that the parent "list of addons" page is owned by SIG Cluster Lifecycle, but tutorial pages linked from it should be owned by the relevant SIGs that host a subproject. for example, kube-state-metrics is SIG Instrumentation.

@sftim
Copy link
Contributor

sftim commented Aug 20, 2024

I think the concept of enhancing your cluster with an add-on is a cluster lifecycle concept; that's why I labelled this for the cluster lifecycle SIG.

Maintaining the list? SIG Docs, maybe, or maybe it doesn't matter.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle.
Projects
None yet
Development

No branches or pull requests

6 participants