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.

Sign up for GitHub

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

Jump to bottom

Add object to glossary #24528

Merged
merged 1 commit into from
Oct 30, 2020
Merged

Add object to glossary #24528

merged 1 commit into from
Oct 30, 2020

Conversation

sftim
Copy link
Contributor

@sftim sftim commented Oct 12, 2020 •
edited
Loading

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 12, 2020
@sftim sftim mentioned this pull request Oct 12, 2020
Closed
65 tasks
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 12, 2020
@netlify
Copy link

netlify bot commented Oct 12, 2020

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 791d7ad

https://deploy-preview-24528--kubernetes-io-master-staging.netlify.app

@zparnold
Copy link
Member

@sftim might it be useful to include example objects? Pods, Deployments, ConfigMaps...so on?

@kbhawkey
Copy link
Contributor

I am not completely convinced that "objects" is the right term. What about "resources"?
There are a lot of "objects" in a cluster (a very generic software term)?

@sftim
Copy link
Contributor Author

sftim commented Oct 20, 2020

We need to define what the word “object” means when people use it, even if this definition isn't the right one.

kbhawkey
kbhawkey reviewed Oct 20, 2020
View reviewed changes
content/en/docs/reference/glossary/object.md
<!--more-->
A Kubernetes object is typically a “record of intent”—once you create the object, the Kubernetes
{{< glossary_tooltip text="control plane" term_id="control-plane" >}} works constantly to ensure
that the item it represents actually exists.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @sftim .
I agree that this term should be added.
The long definition seems to be a duplicate of the "Kubernetes API" definition.
Could you drop the last sentence and add a sentence citing some examples of objects.
The core [or fundamental] Kubernetes objects are: Pod, Deployment, Job, Volume, Secret, Service, ...
Note: The glossary categories selector lists "Core object" as: a resource type that Kubernetes supports by default.

@kbhawkey
Copy link
Contributor

Let's get the term in the glossary and if needed adjust the definition.
Thanks @sftim
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kbhawkey

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 23, 2020
@kbhawkey
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 30, 2020
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 5fefb57fd51d1278403ed5176809b0658147cf3b

@k8s-ci-robot k8s-ci-robot merged commit 2bc2e8f into kubernetes:master Oct 30, 2020
@sftim sftim deleted the 20201012_add_object_to_glossary branch September 12, 2021 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kbhawkey kbhawkey kbhawkey left review comments

@jimangel jimangel Awaiting requested review from jimangel

@kbarnard10 kbarnard10 Awaiting requested review from kbarnard10

Assignees

@kbhawkey kbhawkey

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@sftim @zparnold @kbhawkey @k8s-ci-robot