kubernetes / kubernetes/website

Documentation: syntax error in CRI-O drop-in file on "Switching to EventedPLEG" page

Open
#55,670 2 comments 0 reactions 1 assignee Claimed by @namanraofullstack View on GitHub
kind/bug sig/node triage/accepted
Dominant language
HTML
Stars
5.4k
Forks
15.7k
Avg merge
4d 18h
Merged PRs (30d)
204

Description

**Problem:**
I'd like to experimentally enable the `EventedPLEG` feature in a CRI-O-based Kubernetes cluster where CPU usage is higher than expected.

To attempt that I've been following the `Switching from Polling to CRI Event-based Update to Container Status` guidance:

- https://kubernetes.io/docs/tasks/administer-cluster/switch-to-evented-pleg/
- https://github.com/kubernetes/website/blob/d597d02347d8c26191e7b42b61cdadedbf872907/content/en/docs/tasks/administer-cluster/switch-to-evented-pleg.md

(also available in [`zh-cn` translation](https://github.com/kubernetes/website/blob/d597d02347d8c26191e7b42b61cdadedbf872907/content/zh-cn/docs/tasks/administer-cluster/switch-to-evented-pleg.md))

However, there is a syntax error in the CRI-O drop-in configuration file suggested to enable the feature:

```toml
[crio.runtime]
enable_pod_events: true
```

Attempting to run `crio config` with this config in place produces a fatal error `unable to decode configuration ... expected '.' or '=', but got ':' instead`.

**Proposed Solution:**
Assigning a value to a configuration variable in this context should follow a `x = value` syntax, not a `x: value` syntax.

In both translations, adjust the suggested drop-in file content to:

```toml
[crio.runtime]
enable_pod_events = true
```

**Page to Update:**
https://kubernetes.io/docs/tasks/administer-cluster/switch-to-evented-pleg/

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.