Website: Add more glossary terms

[chenopis]

This is a...

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

[Bubblemelon]

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]

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
• [x] Etcd

[nikhita]

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]

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

[sdague]

Label appears to already be added to the glossary -https://github.com/kubernetes/website/blob/2999938d81c87068fe333b9f69e10f551e70ae90/_data/glossary/labels.yaml#L1

[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-testing, kubernetes/test-infra and/or fejta.
/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-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten
/remove-lifecycle stale

[nikhita]

/remove-lifecycle rotten

still some terms left

[nikhita]

@chenopis would the help wanted label suit here? this also looks like something new contributors could tackle! :) good first issue might be nice as well.

[chenopis]

@nikhita Yes, for sure. The glossary is probably the easiest thing to contribute to, especially for new contributors. =)

[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-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[nikhita]

/remove-lifecycle stale

[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-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[nikhita]

/remove-lifecycle stale

On Tue, Dec 18, 2018 at 12:05 PM fejta-bot [e-mail] wrote:

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
https://github.com/fejta.
/lifecycle stale

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/kubernetes/website/issues/5993#issuecomment-448112733,
or mute the thread
https://github.com/notifications/unsubscribe-auth/APXA0PR5fyBtIyKv-2LGuZSalp8KrIlwks5u6IytgaJpZM4QBQyb
.

[raunakjhawar]

I would like to have a glossary for Network Policy Most users who search for setting up custom rules for namespace access also search for Network Policy

[xmulligan]

@chenopis I updated your list and these are the ones that still haven't been written yet

• [ ] Device Plugin
• [ ] Disruption
• [ ] Extension
• [ ] Federation
• [ ] Garbage Collection
• [ ] HostAliases
• [ ] Logging
• [ ] Network Plugin
• [ ] Pod Disruption Budget
• [ ] Pod Lifecycle
• [ ] Pod Priority
• [ ] Preemption
• [ ] Proxy
• [ ] Sysctls

[sourabh1031]

I would like to work on this @nikhita

[sourabh1031]

/assign

[k8s-ci-robot]

@sourabh1031: GitHub didn't allow me to assign the following users: sourabh1031.

Note that only kubernetes members and repo collaborators can be assigned and that issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

/assign

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.

[daminisatya]

@sourabh1031 I worked on adding HostAliases, Pod Priority, Extension and Preemption to the Glossary page, Please feel free to pick others. 😃

[sftim]

/language en

[sftim]

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]

Is it OK to skip terms for:

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

?

[sftim]

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

[sftim]

/priority backlog
because most of the work is done

[sftim]

/status active

[sftim]

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

[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-testing, kubernetes/test-infra and/or fejta.
/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-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

[sftim]

Also see #19535

[sftim]

@chenopsis is this OK to /close?

[fejta-bot]

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]

@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]

Related: #24528 Add _object_ to glossary