From 23b3e524d052db51020e3e65f479d0910b90f579 Mon Sep 17 00:00:00 2001 From: Dmitry Shurupov Date: Thu, 21 Nov 2024 12:25:43 +0700 Subject: [PATCH] Fix duplicated glossary entry for CRI Signed-off-by: Dmitry Shurupov Co-authored-by: Tim Bannister --- content/en/docs/concepts/architecture/cri.md | 2 +- .../glossary/container-runtime-interface.md | 22 ------------------- content/en/docs/reference/glossary/cri.md | 22 +++++++++++-------- .../cri-pod-container-metrics.md | 4 ++-- .../reference/instrumentation/node-metrics.md | 2 +- 5 files changed, 17 insertions(+), 35 deletions(-) delete mode 100644 content/en/docs/reference/glossary/container-runtime-interface.md diff --git a/content/en/docs/concepts/architecture/cri.md b/content/en/docs/concepts/architecture/cri.md index 055df28b4f..c12ee19e78 100644 --- a/content/en/docs/concepts/architecture/cri.md +++ b/content/en/docs/concepts/architecture/cri.md @@ -15,7 +15,7 @@ each Node in your cluster, so that the {{< glossary_tooltip text="kubelet" term_id="kubelet" >}} can launch {{< glossary_tooltip text="Pods" term_id="pod" >}} and their containers. -{{< glossary_definition prepend="The Container Runtime Interface (CRI) is" term_id="container-runtime-interface" length="all" >}} +{{< glossary_definition prepend="The Container Runtime Interface (CRI) is" term_id="cri" length="all" >}} diff --git a/content/en/docs/reference/glossary/container-runtime-interface.md b/content/en/docs/reference/glossary/container-runtime-interface.md deleted file mode 100644 index f0f8cba9be..0000000000 --- a/content/en/docs/reference/glossary/container-runtime-interface.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Container Runtime Interface -id: container-runtime-interface -date: 2021-11-24 -full_link: /docs/concepts/architecture/cri -short_description: > - The main protocol for the communication between the kubelet and Container Runtime. - -aka: -tags: - - cri ---- - -The main protocol for the communication between the {{< glossary_tooltip text="kubelet" term_id="kubelet" >}} and Container Runtime. - - - -The Kubernetes Container Runtime Interface (CRI) defines the main -[gRPC](https://grpc.io) protocol for the communication between the -[node components](/docs/concepts/architecture/#node-components) -{{< glossary_tooltip text="kubelet" term_id="kubelet" >}} and -{{< glossary_tooltip text="container runtime" term_id="container-runtime" >}}. diff --git a/content/en/docs/reference/glossary/cri.md b/content/en/docs/reference/glossary/cri.md index c690bcb18d..82044c1166 100644 --- a/content/en/docs/reference/glossary/cri.md +++ b/content/en/docs/reference/glossary/cri.md @@ -1,18 +1,22 @@ --- -title: Container runtime interface (CRI) +title: Container Runtime Interface (CRI) id: cri -date: 2019-03-07 -full_link: /docs/concepts/architecture/#container-runtime +date: 2021-11-24 +full_link: /docs/concepts/architecture/cri short_description: > - An API for container runtimes to integrate with kubelet - + Protocol for communication between the kubelet and the local container runtime. aka: tags: -- fundamental + - fundamental --- -The container runtime interface (CRI) is an API for container runtimes -to integrate with the {{< glossary_tooltip text="kubelet" term_id="kubelet" >}} on a node. + +The main protocol for the communication between the {{< glossary_tooltip text="kubelet" term_id="kubelet" >}} and Container Runtime. + -For more information, see the [CRI](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/container-runtime-interface.md) API and specifications. +The Kubernetes Container Runtime Interface (CRI) defines the main +[gRPC](https://grpc.io) protocol for the communication between the +[node components](/docs/concepts/architecture/#node-components) +{{< glossary_tooltip text="kubelet" term_id="kubelet" >}} and +{{< glossary_tooltip text="container runtime" term_id="container-runtime" >}}. diff --git a/content/en/docs/reference/instrumentation/cri-pod-container-metrics.md b/content/en/docs/reference/instrumentation/cri-pod-container-metrics.md index 80488452bf..72c5e0aa0b 100644 --- a/content/en/docs/reference/instrumentation/cri-pod-container-metrics.md +++ b/content/en/docs/reference/instrumentation/cri-pod-container-metrics.md @@ -14,7 +14,7 @@ description: >- The [kubelet](/docs/reference/command-line-tools-reference/kubelet/) collects pod and container metrics via [cAdvisor](https://github.com/google/cadvisor). As an alpha feature, Kubernetes lets you configure the collection of pod and container -metrics via the {{< glossary_tooltip term_id="container-runtime-interface" text="Container Runtime Interface">}} (CRI). You +metrics via the {{< glossary_tooltip term_id="cri" text="Container Runtime Interface">}} (CRI). You must enable the `PodAndContainerStatsFromCRI` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) and use a compatible CRI implementation (containerd >= 1.6.0, CRI-O >= 1.23.0) to use the CRI based collection mechanism. @@ -35,4 +35,4 @@ collection with cAdvisor include: - It further decouples the kubelet and the container runtime allowing collection of metrics for container runtimes that don't run processes directly on the host with kubelet where they are observable by cAdvisor (for example: container runtimes that use virtualization). - \ No newline at end of file + diff --git a/content/en/docs/reference/instrumentation/node-metrics.md b/content/en/docs/reference/instrumentation/node-metrics.md index df264fc844..32eab955bd 100644 --- a/content/en/docs/reference/instrumentation/node-metrics.md +++ b/content/en/docs/reference/instrumentation/node-metrics.md @@ -40,7 +40,7 @@ By default, Kubernetes fetches node summary metrics data using an embedded [cAdvisor](https://github.com/google/cadvisor) that runs within the kubelet. If you enable the `PodAndContainerStatsFromCRI` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) in your cluster, and you use a container runtime that supports statistics access via -{{< glossary_tooltip term_id="container-runtime-interface" text="Container Runtime Interface">}} (CRI), then +{{< glossary_tooltip term_id="cri" text="Container Runtime Interface">}} (CRI), then the kubelet [fetches Pod- and container-level metric data using CRI](/docs/reference/instrumentation/cri-pod-container-metrics), and not via cAdvisor. ## {{% heading "whatsnext" %}}