MINOR: Add Docker version requirement and permission warning to README#19994
Conversation
github-actions
Bot
added
triage
chia7712
left a comment
chia7712
left a comment
There was a problem hiding this comment.
@LoganZhuZzz Could you please share the error message with us if Docker is running on older versions?
|
|
||
| Note that the `Docker` version **must be >= 20.10.4**. | ||
|
|
||
| The prior Docker versions (e.g., 17.03.x–20.10.3) may cause permission errors when running the Kafka container, as they do not correctly set directory permissions when creating container paths like `/opt/kafka/config`. |
There was a problem hiding this comment.
It should be fine to assume the older versions have such issues, so it is not required to list older versions explicitly
encounter the following error during container startup when using older Docker versions: |
Yunyung
left a comment
Yunyung
left a comment
There was a problem hiding this comment.
Thanks for the PR. I left some comments.
| If you are using the prior version, you may encounter the following error during container startup: | ||
| ```text | ||
| ===> User | ||
| uid=1000(appuser) gid=1000(appuser) groups=1000(appuser) | ||
| ===> Setting default values of environment variables if not already set. | ||
| ===> Configuring … | ||
| Running in KRaft mode… | ||
| /opt/kafka/config/ file not writable | ||
| ``` | ||
|
|
||
| To avoid this, **please upgrade Docker to 20.10.4 or later**. | ||
|
|
||
| This issue was fixed in Docker [20.10.4 release](https://docs.docker.com/engine/release-notes/20.10/#20104), specifically in Use 0755 permissions when creating missing directories [moby/moby#42017](https://github.com/moby/moby/pull/42017). |
There was a problem hiding this comment.
I prefer leaving the detailed errors in the PR discussion rather than explicitly writing them in the README.
Co-authored-by: Jhen-Yung Hsu <[email protected]>
DL1231
left a comment
DL1231
left a comment
There was a problem hiding this comment.
Thanks for the PR, LGTM.
5 participants
Adds a new section "Installation Preparation" to the Kafka Docker
examples README. It documents a known issue with Docker versions prior
to 20.10.4, where directory permissions (such as
/opt/kafka/config)are not properly set, causing startup failures for non-root users (e.g.,
appuser).This issue was fixed in Docker 20.10.4
release,
specifically in Use 0755 permissions when creating missing directories
moby/moby#42017.
Reviewers: Jhen-Yung Hsu [email protected], Lan Ding
[email protected], Chia-Ping Tsai [email protected]