Skip to content

Commit 2393fac

Browse files
authored
Update AKS Arc telemetry pod resource documentation
1 parent 679ad8f commit 2393fac

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

AKS-Arc/telemetry-pod-resources.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: AKS Arc telemetry pod is consuming too much memory and CPU
3-
description: Learn how to troubleshoot when AKS Arc telemetry pod is consuming too much memory and CPU
2+
title: AKS Arc telemetry pod consumes too much memory and CPU
3+
description: Learn how to troubleshoot when AKS Arc telemetry pod consumes too much memory and CPU.
44
ms.topic: troubleshooting
55
author: sethmanheim
66
ms.author: sethm
@@ -9,7 +9,7 @@ ms.reviewer: abha
99

1010
---
1111

12-
# AKS Arc telemetry pod is consuming too much memory and CPU
12+
# AKS Arc telemetry pod consumes too much memory and CPU
1313

1414
## Symptoms
1515

@@ -26,20 +26,21 @@ NAME CPU(cores) MEMORY(bytes)
2626
akshci-telemetry-5df56fd5-rjqk4 996m 152Mi
2727
```
2828

29-
## Mitigation Steps
29+
## Mitigation
3030

31-
To resolve this issue, we need to set default **resource limits** for the pods in the `kube-system` namespace.
31+
To resolve this issue, set default **resource limits** for the pods in the `kube-system` namespace.
3232

33-
### Important Notes:
34-
- Please verify if you have any pods in the **kube-system** namespace that might require more memory than the default limit setting below. If so, adjustments may be needed.
35-
- The **LimitRange** is applied to the **namespace** (in this case, the `kube-system` namespace). The default resource limits will also apply to new pods that don't specify their own limits.
36-
- **Existing pods** (including those that already have resource limits) will not be affected.
37-
- **New pods** that don't specify their own resource limits will be constrained by the limits set below.
38-
- After setting the resource limits and deleting the telemetry pod, the new pod might eventually hit the memory limit and get killed with **OOM (Out-Of-Memory)** errors. This is a **temporary mitigation**.
33+
### Important notes
34+
35+
- Verify if you have any pods in the **kube-system** namespace that might require more memory than the default limit setting. If so, adjustments might be needed.
36+
- The **LimitRange** is applied to the **namespace**; in this case, the `kube-system` namespace. The default resource limits also apply to new pods that don't specify their own limits.
37+
- **Existing pods**, including those that already have resource limits, aren't affected.
38+
- **New pods** that don't specify their own resource limits are constrained by the limits set in the next section.
39+
- After you set the resource limits and delete the telemetry pod, the new pod might eventually hit the memory limit and generate **OOM (Out-Of-Memory)** errors. This is a temporary mitigation.
3940

40-
To proceed with setting the resource limits, you can run the following script. While the below script uses `az aksarc get-credentials`, you can also use `az connectedk8s proxy` to get the proxy kubeconfig and access the Kubernetes cluster.
41+
To proceed with setting the resource limits, you can run the following script. While the script uses `az aksarc get-credentials`, you can also use `az connectedk8s proxy` to get the proxy kubeconfig and access the Kubernetes cluster.
4142

42-
### Define the **LimitRange YAML** to set default CPU and memory limits:
43+
### Define the LimitRange YAML to set default CPU and memory limits
4344

4445
```powershell
4546
# Set the $cluster_name and $resource_group of the aksarc cluster
@@ -75,14 +76,16 @@ sleep 5
7576
kubectl get pods -l app=akshci-telemetry -n kube-system --kubeconfig "./kubeconfig-$cluster_name"
7677
```
7778

78-
### Validate if the resource limits have been applied correctly
79+
### Validate if the resource limits were applied correctly
7980

8081
1. Check the resource limits in the pod's YAML configuration:
82+
8183
```powershell
8284
kubectl get pods -l app=akshci-telemetry -n kube-system --kubeconfig "./kubeconfig-$cluster_name" -o yaml
8385
```
8486

85-
2. In the output, verify that the **resources** section includes the limits:
87+
1. In the output, verify that the `resources` section includes the limits:
88+
8689
```yaml
8790
resources:
8891
limits:

0 commit comments

Comments
 (0)