search

kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.48k stars 14.4k forks source link

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

Open kirenpillay opened 2 months ago

kirenpillay commented 2 months ago

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

k8s-ci-robot commented 2 months ago

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](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
dipesh-rawat commented 2 months ago

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

dipesh-rawat commented 2 months ago

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 commented 2 months ago

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

utkarsh-singh1 commented 2 months ago

You can find addons in tasks.

utkarsh-singh1 commented 2 months ago

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

utkarsh-singh1 commented 2 months ago

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

sftim commented 2 months ago

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 could also mention:

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”?

neolit123 commented 2 months ago

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 commented 2 months ago

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.