Skip to content

Add more glossary terms #5993

@chenopis

Description

@chenopis

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

Metadata

Metadata

Labels

help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.language/enIssues or PRs related to English languagelifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed.priority/backlogHigher priority than priority/awaiting-more-evidence.

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions