Include missing core object in glossary #48318

abhilasha2418 · 2024-10-13T12:23:55Z

Description

This is the first part of resolving the issue regarding core objects in the Kubernetes glossary.
In this PR, I have included necessary API kinds that are built into Kubernetes as core objects, such as Node, PodTemplate, and NetworkPolicy.

Issue

#45972

linux-foundation-easycla · 2024-10-13T12:23:59Z

The committers listed above are authorized under a signed CLA.

✅ login: abhilasha2418 / name: abhilasha (6b47ec3, cea6f08)

abhilasha2418 · 2024-10-13T12:26:38Z

/assign

sftim

The core object is called PodTemplate; let's fix that.

sftim · 2024-10-13T15:13:21Z

content/en/docs/reference/glossary/pod-template.md

@@ -0,0 +1,17 @@
+---
+title: Pod Template


Suggested change

title: Pod Template

title: PodTemplate

sftim · 2024-10-13T15:13:48Z

content/en/docs/reference/glossary/pod-template.md

+id: pod-template
+date: 2024-10-13
+short_description: >
+  A Pod Template defines template for creating pods.


Suggested change

A Pod Template defines template for creating pods.

A template for creating Pods.

sftim · 2024-10-13T15:13:58Z

content/en/docs/reference/glossary/pod-template.md

+short_description: >
+  A Pod Template defines template for creating pods.
+
+aka: 


Suggested change

aka:

aka:

- pod template

sftim · 2024-10-13T15:15:38Z

content/en/docs/reference/glossary/pod-template.md

+- core-object
+
+---
+An API object that defines a template for creating {{< glossary_tooltip text="pod" term_id="pod" >}}, typically used in higher-level controllers.


Suggested change

An API object that defines a template for creating {{< glossary_tooltip text="pod" term_id="pod" >}}, typically used in higher-level controllers.

An API object that defines a template for creating {{< glossary_tooltip text="Pods" term_id="pod" >}}.

The PodTemplate API is also embedded in API definitions for workload management, such as

{{< glossary_tooltip text="Deployment" term_id="deployment" >}} or

{{< glossary_tooltip text="StatefulSets" term_id="StatefulSet" >}}.

sftim · 2024-10-13T15:19:31Z

content/en/docs/reference/glossary/pod-template.md

+
+<!--more--> 
+
+Pod Templates provide a specification that includes metadata, labels, and a pod's desired state, which is utilized by controllers like {{< glossary_tooltip text="deployment" term_id="deployment" >}} and {{< glossary_tooltip text="statefulset" term_id="statefulset" >}} to create and manage multiple {{< glossary_tooltip text="replicas" term_id="" >}} of {{< glossary_tooltip text="pod" term_id="pod" >}}.


Try this:

Suggested change

Pod Templates provide a specification that includes metadata, labels, and a pod's desired state, which is utilized by controllers like {{< glossary_tooltip text="deployment" term_id="deployment" >}} and {{< glossary_tooltip text="statefulset" term_id="statefulset" >}} to create and manage multiple {{< glossary_tooltip text="replicas" term_id="" >}} of {{< glossary_tooltip text="pod" term_id="pod" >}}.

Pod templates allow you to define common metadata (such as labels, or a template for the name of a

new Pod) as well as to specify a pod's desired state.

[Workload management](/docs/concepts/workloads/controllers/) controllers use Pod templates

(embedded into another object, such as a Deployment or StatefulSet)

to define and manage one or more {{< glossary_tooltip text="Pods" term_id="pod" >}}.

When there can be multiple Pods based on the same template, these are called

{{< glossary_tooltip term_id="replica" text="replicas" >}}.

Although you can create a PodTemplate object directly, you rarely need to do so.

abhilasha2418 · 2024-10-13T16:07:00Z

@sftim I've added the changes as you suggested !

netlify · 2024-10-13T16:08:42Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`cea6f08`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/670beea35598b0000928b04c
😎 Deploy Preview	https://deploy-preview-48318--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

sftim · 2024-10-14T09:36:13Z

I'm going to edit the issue description to remove

Closes #45972

as this PR is not a complete fix.

sftim · 2024-10-14T09:36:36Z

/lgtm

k8s-ci-robot · 2024-10-14T09:36:43Z

LGTM label has been added.

Git tree hash: 5f5117522c08920ab6c7036c7f45572e954c34a0

abhilasha2418 · 2024-10-14T11:15:41Z

@dipesh-rawat can you please approve the PR.

sftim · 2024-10-14T14:55:07Z

/assign @salaxander

dipesh-rawat

Thanks!
/approve

k8s-ci-robot · 2024-10-14T23:23:04Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dipesh-rawat

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:

~~content/en/docs/OWNERS~~ [dipesh-rawat]

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 added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. language/en Issues or PRs related to English language labels Oct 13, 2024

k8s-ci-robot requested review from drewhagen and kbhawkey October 13, 2024 12:24

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Oct 13, 2024

feature: include missing core object in glossary

6b47ec3

abhilasha2418 force-pushed the includeCoreObject branch from 3bc0dd4 to 6b47ec3 Compare October 13, 2024 12:26

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Oct 13, 2024

k8s-ci-robot assigned abhilasha2418 Oct 13, 2024

sftim reviewed Oct 13, 2024

View reviewed changes

fix: Improve PodTemplate glossary

cea6f08

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 13, 2024

abhilasha2418 requested a review from sftim October 13, 2024 16:10

k8s-ci-robot assigned sftim Oct 14, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 14, 2024

abhilasha2418 mentioned this pull request Oct 14, 2024

Remove the object from glossary which are not part of core objects #48333

Merged

k8s-ci-robot assigned salaxander Oct 14, 2024

dipesh-rawat reviewed Oct 14, 2024

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 14, 2024

k8s-ci-robot merged commit 1c007bd into kubernetes:main Oct 14, 2024
6 checks passed

asem-hamid mentioned this pull request Oct 21, 2024

Sub-Umbrella Issue: List of Glossary files to Localize in Bangla #45729

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Include missing core object in glossary #48318

Include missing core object in glossary #48318

abhilasha2418 commented Oct 13, 2024 •

edited by sftim

Loading

linux-foundation-easycla bot commented Oct 13, 2024 •

edited

Loading

abhilasha2418 commented Oct 13, 2024

sftim left a comment

sftim Oct 13, 2024

sftim Oct 13, 2024

sftim Oct 13, 2024

sftim Oct 13, 2024 •

edited

Loading

sftim Oct 13, 2024 •

edited

Loading

abhilasha2418 commented Oct 13, 2024 •

edited

Loading

netlify bot commented Oct 13, 2024

sftim commented Oct 14, 2024

sftim commented Oct 14, 2024

k8s-ci-robot commented Oct 14, 2024

abhilasha2418 commented Oct 14, 2024

sftim commented Oct 14, 2024

dipesh-rawat left a comment

k8s-ci-robot commented Oct 14, 2024

	A Pod Template defines template for creating pods.
	A template for creating Pods.

-An API object that defines a template for creating {{< glossary_tooltip text="pod" term_id="pod" >}}, typically used in higher-level controllers.
+An API object that defines a template for creating {{< glossary_tooltip text="Pods" term_id="pod" >}}.
+The PodTemplate API is also embedded in API definitions for workload management, such as
+{{< glossary_tooltip text="Deployment" term_id="deployment" >}} or
+{{< glossary_tooltip text="StatefulSets" term_id="StatefulSet" >}}.


		<!--more-->

		Pod Templates provide a specification that includes metadata, labels, and a pod's desired state, which is utilized by controllers like {{< glossary_tooltip text="deployment" term_id="deployment" >}} and {{< glossary_tooltip text="statefulset" term_id="statefulset" >}} to create and manage multiple {{< glossary_tooltip text="replicas" term_id="" >}} of {{< glossary_tooltip text="pod" term_id="pod" >}}.

-Pod Templates provide a specification that includes metadata, labels, and a pod's desired state, which is utilized by controllers like {{< glossary_tooltip text="deployment" term_id="deployment" >}} and {{< glossary_tooltip text="statefulset" term_id="statefulset" >}} to create and manage multiple {{< glossary_tooltip text="replicas" term_id="" >}} of {{< glossary_tooltip text="pod" term_id="pod" >}}.
+Pod templates allow you to define common metadata (such as labels, or a template for the name of a
+new Pod) as well as to specify a pod's desired state.
+[Workload management](/docs/concepts/workloads/controllers/) controllers use Pod templates
+(embedded into another object, such as a Deployment or StatefulSet)
+to define and manage one or more {{< glossary_tooltip text="Pods" term_id="pod" >}}.
+When there can be multiple Pods based on the same template, these are called
+{{< glossary_tooltip term_id="replica" text="replicas" >}}.
+Although you can create a PodTemplate object directly, you rarely need to do so.

Include missing core object in glossary #48318

Include missing core object in glossary #48318

Conversation

abhilasha2418 commented Oct 13, 2024 • edited by sftim Loading

Description

Issue

linux-foundation-easycla bot commented Oct 13, 2024 • edited Loading

abhilasha2418 commented Oct 13, 2024

sftim left a comment

Choose a reason for hiding this comment

sftim Oct 13, 2024

Choose a reason for hiding this comment

sftim Oct 13, 2024

Choose a reason for hiding this comment

sftim Oct 13, 2024

Choose a reason for hiding this comment

sftim Oct 13, 2024 • edited Loading

Choose a reason for hiding this comment

sftim Oct 13, 2024 • edited Loading

Choose a reason for hiding this comment

abhilasha2418 commented Oct 13, 2024 • edited Loading

netlify bot commented Oct 13, 2024

✅ Pull request preview available for checking

sftim commented Oct 14, 2024

sftim commented Oct 14, 2024

k8s-ci-robot commented Oct 14, 2024

abhilasha2418 commented Oct 14, 2024

sftim commented Oct 14, 2024

dipesh-rawat left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Oct 14, 2024

abhilasha2418 commented Oct 13, 2024 •

edited by sftim

Loading

linux-foundation-easycla bot commented Oct 13, 2024 •

edited

Loading

sftim Oct 13, 2024 •

edited

Loading

sftim Oct 13, 2024 •

edited

Loading

abhilasha2418 commented Oct 13, 2024 •

edited

Loading