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

Add "resource" to glossary #25903

Open
oke-py opened this issue Jan 1, 2021 · 28 comments
Open

Add "resource" to glossary #25903

oke-py opened this issue Jan 1, 2021 · 28 comments
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@oke-py
Copy link
Contributor

oke-py commented Jan 1, 2021

This is a Feature Request

What would you like to be added

I'd like to distinguish "resource" and "object".
"Object" is defined in glossary.

An entity in the Kubernetes system. The Kubernetes API uses these entities to represent the state of your cluster.

A Kubernetes object is typically a “record of intent”—once you create the object, the Kubernetes control plane works constantly to ensure that the item it represents actually exists. By creating an object, you're effectively telling the Kubernetes system what you want that part of your cluster's workload to look like; this is your cluster's desired state.

"Create an object" and "create a resource" are both correct expression?
If so, are they same meaning?

I think "object" is suitable, but (Cluster)Role, audit policy have "resourceNames" field. It's confusing.

Why is this needed

A clear word definition may help understanding.

Comments

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

Aut0R3V commented Jan 1, 2021

@oke-py so what I understood is that the following changes need to be made :

  • Definition of object and resource
  • Explanation of the terms "Creating an object" and "Creating a resource".

Please correct me if I'm wrong. I'll send in a pull request

@oke-py
Copy link
Contributor Author

oke-py commented Jan 2, 2021

@Aut0R3V Thanks. Definition of object exists in glossary.

@sftim
Copy link
Contributor

sftim commented Jan 2, 2021

BTW: https://kubernetes.io/docs/reference/using-api/api-concepts/ covers some of resources vs. objects, and PR #25299 is a (work-in-progress) set of changes to help improve the way we explain it.

@sftim
Copy link
Contributor

sftim commented Jan 4, 2021

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jan 4, 2021
@Aut0R3V
Copy link
Contributor

Aut0R3V commented Jan 5, 2021

@sftim I just checked in #25299. Does this issue require a different commit or can this issue be closed?

@fejta-bot
Copy link

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

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 5, 2021
@fejta-bot
Copy link

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

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels May 5, 2021
@fejta-bot
Copy link

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

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

@k8s-ci-robot
Copy link
Contributor

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

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
Copy link
Contributor

sftim commented Nov 25, 2021

This does sound like a good idea to add. There are several specific meanings of “resource” in Kubernetes.

/remove-lifecycle rotten
/reopen
/language en
/kind feature
/priority important-longterm

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language kind/feature Categorizes issue or PR as related to a new feature. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. labels Nov 25, 2021
@k8s-ci-robot
Copy link
Contributor

@sftim: Reopened this issue.

In response to this:

This does sound like a good idea to add. There are several specific meanings of “resource” in Kubernetes.

/remove-lifecycle rotten
/reopen
/language en
/kind feature
/priority important-longterm

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.

@k8s-ci-robot k8s-ci-robot reopened this Nov 25, 2021
@k8s-ci-robot k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Nov 25, 2021
@k8s-triage-robot
Copy link

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-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 23, 2022
@k8s-triage-robot
Copy link

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

@vaibhav2107
Copy link
Member

/remove-lifecycle rotten

@k8s-triage-robot
Copy link

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-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 1, 2022
@oke-py
Copy link
Contributor Author

oke-py commented May 30, 2022

Thanks. If I understand correctly, this issue should be closed, right?

@sftim
Copy link
Contributor

sftim commented May 30, 2022

In the glossary, we have an entry for resource quotas but not for resource.

I would definitely be happy for more entries to be added. When adding these, bear in mind that (like the English word), the Kubernetes jargon uses this term in different ways and to use different things.

/lifecycle frozen

I don't recommend closing this issue until the extra entries are added. #30092 was closed as duplicating existing issues; let's keep this one and use it to track the work. Once this closes, we can revisit #20074 and see if that is also good to close.

@k8s-ci-robot k8s-ci-robot added the lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. label May 30, 2022
@dipankardas011
Copy link
Contributor

For me
Resources are equivalent to Classes (Boilerplate)
Objects are equivalent to objects (Instance)
CRDs for example provide the definition of objects
@sftim

@sftim
Copy link
Contributor

sftim commented Jun 21, 2022

Resources are equivalent to Classes (Boilerplate)
Objects are equivalent to objects (Instance)
CRDs for example provide the definition of objects

Uh, don't tell me, tell the people reading the website!

Before you do, you might like to check out some of the common uses of the term.

@dipankardas011
Copy link
Contributor

dipankardas011 commented Jun 21, 2022

Just Curious to ask that
Kubernetes written in Go provides the framework for all these like default scheduler, control manager, etc.
we then add stuff using CRD's just like modules in Linux Kernel
then we use the resources (build-in / custom-made) to create objects i.e. which is a physical entity and actionable

What are your thoughts on this? Open for discussion

@k8s-triage-robot
Copy link

This issue has not been updated in over 1 year, and should be re-triaged.

You can:

  • Confirm that this issue is still relevant with /triage accepted (org members only)
  • Close this issue with /close

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted

@k8s-ci-robot k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. and removed triage/accepted Indicates an issue or PR is ready to be actively worked on. labels Jun 21, 2023
@sftim
Copy link
Contributor

sftim commented Oct 2, 2023

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 2, 2023
@divya-mohan0209 divya-mohan0209 moved this from Needs Triage to Triage Accepted in SIG Docs Longterm issues Dec 12, 2023
@sftim
Copy link
Contributor

sftim commented Aug 19, 2024

Help is welcome!

@sftim sftim pinned this issue Oct 19, 2024
@sftim
Copy link
Contributor

sftim commented Oct 19, 2024

/help

@k8s-ci-robot
Copy link
Contributor

@sftim:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/help

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.

@k8s-ci-robot k8s-ci-robot added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Oct 19, 2024
@Ritikaa96
Copy link
Contributor

Just for reference purpose, this is very good explanation done for objects and resources. Anyone working on this can get help using this one as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Status: Triage Accepted
Development

No branches or pull requests

10 participants