Official documentation on the usage of kind List

[vio-f]

What would you like to be added:
Could official documentation be created on the usage of kind List?

Why is this needed:
While brianpursley's comment on issue #837 kind of explained it, that does not represent official documentation, plus it does not properly address the purpose of it (only some use cases). Is it just a custom resource list? More explanation and examples are needed.
NOTE - this is a request for a documentation update, so please don't close it like #837 was. That being said, explanations, use cases, examples are welcome.

I would be happy to do it myself if someone points me to the right direction.

[eddiezane]

This issue is scoped beyond kubectl and probably belongs elsewhere.

Leaving this open until I chat with sig-apimachinery.

[eddiezane]

/assign

[brianpursley]

@viorelflorian When you say official documentation, can you clarify what are you referring to? Are you asking for something to be added to https://kubernetes.io?

[eddiezane]

@brianpursley I Googled and followed the tree of linked issues for #837 (especially the Helm one - helm/helm#8615) and kind: List seems to be a source of confusion for folks all around.

We should probably have some actual info about it since it only appears in that example and not in the the main docs or the API Reference.

I put in on the agenda for apimachinery tomorrow to get their take.

[eddiezane]

I checked in with apimachinery and kind: List is more of an internal resource that wasn't meant to be exposed. We currently use this inside kubectl when dealing with lists of mixed resources.

How to proceed is currently being discussed.

[vio-f]

I found usages of it in third party helm charts (traefik v2.3) and i was wondering what is the original intended usage of such a thing (it's not a resource, is it?)
For the record yes kubernetes.io sounds like a good place to document it. I believe there is a mention of it in the custom resources section.

[eddiezane]

@viorelflorian we're still not sure about the proper solution as this internal type was not meant to be exposed.

For now though we'd gladly accept documentation on it to https://github.com/kubernetes-sigs/cli-experimental/tree/master/site if you're still interested.

https://kubectl.docs.kubernetes.io/

[vio-f]

Sure. I would love to as soon as someone assigns this to me.

[eddiezane]

You should be able to /assign yourself. GitHub doesn't let us assign folks out of the org.

(Unless this works because you opened the issue)

/assign @viorelflorian

[eddiezane]

/triage accepted
/priority backlog

[sftim]

I'd be happy to move this issue to k/website but only a few people have access to move issues between repos.

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale

[vio-f]

/remove-lifecycle stale

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle rotten

[azhurbilo]

/remove-lifecycle rotten

[eddiezane]

Let's track this over at kubernetes/website#25944

/close

[k8s-ci-robot]

@eddiezane: Closing this issue.

In response to this:

Let's track this over at kubernetes/website#25944

/close

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/test-infra repository.

[zmquan]

https://kubernetes.io/zh/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/

使用 CustomResourceDefinition 扩展 Kubernetes API , kubectl get $CRDRESOURCESNAME -o yaml