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 more glossary terms #5993

Closed
32 of 65 tasks
chenopis opened this issue Oct 20, 2017 · 34 comments
Closed
32 of 65 tasks

Add more glossary terms #5993

chenopis opened this issue Oct 20, 2017 · 34 comments
Assignees
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. language/en Issues or PRs related to English language lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. priority/backlog Higher priority than priority/awaiting-more-evidence.
Milestone

Comments

@chenopis
Copy link
Contributor

chenopis commented Oct 20, 2017

This is a...

  • Feature Request
  • Bug Report

Problem:
Now that the revamped Glossary has been launched, we need to add more terms to the list.

Proposed Solution:
Add missing terms at Kubernetes doc sprints.

Here is the original glossary list from v1.5 Reference ToC:

  • Aggregation Layer
  • Annotation (@spzala)
  • Certificate (@sdague)
  • Cloud Controller Manager (CCM)
  • Cloud Provider
  • ConfigMap (@zachpuck )
  • Container Environment Variable
  • Container Lifecycle Hook
  • Controller Manager
  • Cron Job
  • Custom Resource Definition (formerly Third Party Resource) (Cheryl)
  • DaemonSet (Brad)
  • Deployment
  • Device Plugin
  • Disruption
  • docker (@jtborek)
  • Dynamic Volume Provisioning (@mohamed)
  • Etcd (Tina)
  • Extension
  • Federation
  • Garbage Collection
  • Horizontal Pod Autoscaling (@zhangxiaoyu-zidif)
  • HostAliases
  • Image (Chris)
  • Ingress Resource
  • Init Container
  • Job (Ryan)
  • kube-proxy
  • kubelet (@spzala)
  • Label
  • Logging
  • Name
  • Namespace
  • Network Plugin
  • Network Policy (Radhika)
  • Node
  • Persistent Volume (Tina)
  • Pod
  • Pod Disruption Budget
  • Pod Lifecycle
  • Pod Preset
  • Pod Priority
  • Pod Security Policy (Radhika)
  • Preemption
  • Proxy
  • Replica Set (Ivange)
  • Replication Controller (Chris)
  • Resource Quota (@radhikapc)
  • rkt
  • Secret
  • Security Context (@erwbgy)
  • Selector
  • Service
  • Service Account (@radhikapc)
  • Stateful Set (formerly Pet Set)
  • Storage Class
  • supervisord
  • Sysctls
  • Taint
  • Toleration
  • Volume (Jared)
  • Volume Plugin (@midoblgsm)
  • fluentd (@radhikapc)

Page to Update:
Add YAML files to /_data/glossary/ directory using the format outline in /_data/glossary/_example.yml. They should then automatically show up in
https://kubernetes.io/docs/reference/glossary/?all=true

For example, /_data/glossary/cluster.yaml has this:

id: cluster
name: Cluster
tags:
- fundamental
- operation
short-description: >
  A set of machines, called nodes, that run containerized applications managed by Kubernetes.
long-description: >
  A cluster has several worker nodes and at least one master node.

A glossary definition can refer to other glossary terms. Here's /_data/glossary/deployment.yaml. The definition of Deployment uses {% glossary_tooltip %} to refer to the definition of Pod:

id: deployment
name: Deployment
full-link: /docs/concepts/workloads/controllers/deployment/
tags:
- fundamental
- core-object
- workload
short-description: >
  An API object that manages a replicated application.
long-description: >
  Each replica is represented by a {% glossary_tooltip term_id="pod" %}, and the Pods are distributed among the nodes of a cluster.

Kubernetes Version: v1.9

@chenopis chenopis added this to the Kubecon 2017 milestone Oct 20, 2017
@xiangpengzhao xiangpengzhao mentioned this issue Oct 22, 2017
@radhikapc radhikapc self-assigned this Nov 21, 2017
jaredbhatti added a commit that referenced this issue Dec 5, 2017
#5993

It's my first stab at a glossary entry.
@Bubblemelon
Copy link
Contributor

Third Party Resource has been deprecated. Custom Resource Definition now replaces it. https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-third-party-resource/

@chenopis
Copy link
Contributor Author

chenopis commented Dec 6, 2017

I just added:

  • Aggregation Layer
  • Certificate
  • Cloud Controller Manager (CCM)
  • Cloud Provider
  • Container Environment Variable
  • Container Lifecycle Hook
  • Controller Manager
  • Custom Resource Definition
  • Device Plugin
  • Disruption
  • Dynamic Volume Provisioning
  • Extension
  • Federation
  • Garbage Collection
  • HostAliases
  • Init Container
  • Label
  • Logging
  • Network Plugin
  • Pod Disruption Budget
  • Pod Lifecycle
  • Pod Preset
  • Pod Priority
  • Preemption
  • Proxy
  • Selector
  • Storage Class
  • Sysctls
  • Taint
  • Toleration
  • Etcd

@nikhita
Copy link
Member

nikhita commented Dec 21, 2017

It would be nice to have a glossary for Custom Resources as well. Most users who search for CRDs would want to search for Custom Resources too.

@midoblgsm
Copy link
Contributor

It would be nice to add Volume Plugin to the list.

sdague added a commit to sdague/kubernetes-website that referenced this issue Feb 20, 2018
sdague added a commit to sdague/kubernetes-website that referenced this issue Feb 20, 2018
k8s-ci-robot pushed a commit that referenced this issue Feb 20, 2018
* Add Certificate glossary term

Part of issue #5993

* Edits for clarity
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label May 14, 2019
yoonian pushed a commit to yoonian/kubernetes-website that referenced this issue May 28, 2019
*  Entry for QoS (kubernetes#5993)

*  QoSClass terminology

*  QoSClass terminology renamming item

*  QoS definition

*  Review update QoS Class and Grammar

*  dash in glossary id qos-class
@sftim
Copy link
Contributor

sftim commented Jun 27, 2019

I suggest: update the issue description with a new list that clearly shows what terms are missing.
(If it helps, I can draw up the list and then someone with edit access can paste it in).

@sftim
Copy link
Contributor

sftim commented Sep 10, 2019

Is it OK to skip terms for:

  • Federation (deprecated)
  • supervisord (not relevant to v1.15 cluster operators)

?

@sftim
Copy link
Contributor

sftim commented Sep 10, 2019

If the above 3 PRs get merged, I think it'd be OK to close this issue as implemented.

@sftim
Copy link
Contributor

sftim commented Sep 10, 2019

/priority backlog
because most of the work is done

@k8s-ci-robot k8s-ci-robot added the priority/backlog Higher priority than priority/awaiting-more-evidence. label Sep 10, 2019
@sftim
Copy link
Contributor

sftim commented Sep 17, 2019

/status active

@sftim
Copy link
Contributor

sftim commented Oct 15, 2019

All remaining work (that is listed) is already started
/remove-good-first-issue

@k8s-ci-robot k8s-ci-robot removed the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Oct 15, 2019
@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-testing, kubernetes/test-infra and/or fejta.
/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 Jan 13, 2020
@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-testing, kubernetes/test-infra and/or fejta.
/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 Feb 12, 2020
@sftim
Copy link
Contributor

sftim commented Mar 7, 2020

Also see #19535

@sftim
Copy link
Contributor

sftim commented Mar 7, 2020

@chenopsis is this OK to /close?

@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-testing, kubernetes/test-infra and/or fejta.
/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-testing, kubernetes/test-infra and/or fejta.
/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 Oct 12, 2020

Related: #24528 Add object to glossary

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. language/en Issues or PRs related to English language lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. priority/backlog Higher priority than priority/awaiting-more-evidence.
Projects
None yet
Development

No branches or pull requests