Skip to content

docs: document experimental Docker CE support and known limitations#562

Merged
joe0BAB merged 1 commit into
mainfrom
feat/docs
Jun 25, 2026
Merged

docs: document experimental Docker CE support and known limitations#562
joe0BAB merged 1 commit into
mainfrom
feat/docs

Conversation

@joe0BAB

@joe0BAB joe0BAB commented Jun 25, 2026

Copy link
Copy Markdown
Collaborator

Replace the Docker CE roadmap note with install/uninstall instructions for the experimental, early-access integration (Docker Engine 29.2.0+), and add a Known limitations section covering multi-user support, the keyring backend requirement, and manual restart after a dockerd restart.

Replace the Docker CE roadmap note with install/uninstall instructions for
the experimental, early-access integration (Docker Engine 29.2.0+), and add a
Known limitations section covering multi-user support, the keyring backend
requirement, and manual restart after a dockerd restart.
@joe0BAB joe0BAB marked this pull request as ready for review June 25, 2026 11:43

@docker-agent docker-agent left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assessment: 🟡 NEEDS ATTENTION

This PR adds clear and helpful documentation for the experimental Docker CE integration. One broken anchor link will silently fail in the rendered README and should be fixed before merge.

Comment thread README.md
> [!WARNING]
> Docker CE support is experimental and may change between releases. Do not
> rely on it for production workloads yet. Also see
> [known limitations](#known-limitations).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[MEDIUM] Broken anchor: #known-limitations won't scroll to the section

The WARNING callout links to #known-limitations, but GitHub generates the anchor from the actual heading ## Known limitations and issues as #known-limitations-and-issues. The link will be silently dead in the rendered README — clicking it does nothing.

Fix: Change line 42 from:

[known limitations](#known-limitations)

to:

[known limitations](#known-limitations-and-issues)

Comment thread README.md

```shell
systemctl --user disable --now docker-secrets-engine.service
sudo apt remove docker-secrets-engine-plugins docker-secrets-engine

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LOW] Uninstall section omits systemctl --user daemon-reload after apt remove

The install section explicitly runs systemctl --user daemon-reload to register the new unit file with systemd. The uninstall section skips the equivalent step after package removal, which can leave stale unit metadata in systemd (e.g., the unit may still show as "loaded" in systemctl --user status docker-secrets-engine even after the package is gone).

Suggested fix: Add a daemon-reload at the end of the uninstall block:

systemctl --user disable --now docker-secrets-engine.service
sudo apt remove docker-secrets-engine-plugins docker-secrets-engine
systemctl --user daemon-reload

@joe0BAB joe0BAB merged commit 91d9431 into main Jun 25, 2026
28 checks passed
@joe0BAB joe0BAB deleted the feat/docs branch June 25, 2026 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants