Glossary: Add a definition for "resource"

[stefanlasiewski]

I just learned about https://kubernetes.io/docs/reference/glossary and I think it's a great tool that will help provide a common language for the community, and also for our team where we struggle often over simple definitions.

I was reading through different definitions, and that many definitions refer to the term "resource", but the term itself is not defined. Some of the usage is confusing. It would be great to define the term resource, and since it's used in different contexts, clarify the usage for those contexts.

Here's a few quotes from the Glossary.

From the following 3 definitions, we know that a "resource" is something like a Deployment or a Pod. A command likekubectl get pods will return a list of pod resources and their names. In the API, I can refer to that resource at /api/v1/pods/some-name. Although, is object actually the correct term here and not resource? If not, what is the difference between the term resource used here and an object?

• DisruptionDisruptions are events that lead to one or more Pods going out of service. A disruption has consequences for workload resources, such as Deployment, that rely on the affected Pods.

• Selector
  Allows users to filter a list of resources based on labels.

• Name
  A client-provided string that refers to an object in a resource URL, such as /api/v1/pods/some-name

The page also uses resource to refer to things in a host context, such as the following definitions. I might call these node resources.

• LimitRangeProvides constraints to limit resource consumption per Containers or Pods in a namespace.

• Node-pressure eviction
  Also known as:kubelet eviction
  Node-pressure eviction is the process by which the kubelet proactively terminates pods to reclaim resources on nodes

[k8s-ci-robot]

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

[tengqm]

From the description, I fail to see which usage is confusing. Within a context, the user knows what the word is referring to, right?

[sftim]

We use the word “resource” in several places within the documention. There are generic meanings and also at least two Kubernetes-specific meanings. I'm sure a glossary definition to explain some of these different meanings would help newcomers.

This looks to me like a duplicate of issue #20074 though.
/language en

[afro-coder]

Hey @sftim I would like to contribute to the issue, however, I'm very new to Kubernetes, I understand that a resource would be something like a Deployment or pod as the OP said or it can also be something like a CPU resource limit(Please correct me if I'm wrong). I'm still confused as to what is the primary definition and how to find the other definitions, any hints would be appreciated.

searching online leads me to articles like this.
https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

[stefanlasiewski]

This looks to me like a duplicate of issue #20074 though.

I'd be fine with moving this question into #20074, although unfortunately that issue is stale and I don't want this issue to get lost.

I do think that newcomers, including people who are experienced with other systems outside of kubernetes, may find parts of the documentation confusing. The context in much of the conversation is not clear. Here's another example from

https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#kubernetes-objects

Kubernetes objects are persistent entities in the Kubernetes system. Kubernetes uses these entities to represent the state of your cluster. Specifically, they can describe:

• What containerized applications are running (and on which nodes)
• The resources available to those applications
• The policies around how those applications behave, such as restart policies, upgrades, and fault-tolerance

I'm not actually sure what "resources" means in this context. Is that text trying to say that an Kubernetes objects have access to Kubernetes resources? If that's the case, what's the relationship between an Object and a Resource?

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue or PR with /reopen
• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

[k8s-ci-robot]

@k8s-triage-robot: Closing this issue.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue or PR with /reopen
• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/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.

[sftim]

/reopen

[k8s-ci-robot]

@sftim: Reopened this issue.

In response to this:

/reopen

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.

[sftim]

/triage duplicate
/remove-lifecycle rotten
/close

See #25903

[k8s-ci-robot]

@sftim: Closing this issue.

In response to this:

/triage duplicate
/remove-lifecycle rotten
/close

See #25903

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.