Skip to content

docs(podman-systemd.unit.5.md): document protocol support for PublishPort Fixes: #28146#28163

Merged
mheon merged 1 commit intocontainers:mainfrom
ysinghc:docs-publishport-protocol
Mar 1, 2026
Merged

docs(podman-systemd.unit.5.md): document protocol support for PublishPort Fixes: #28146#28163
mheon merged 1 commit intocontainers:mainfrom
ysinghc:docs-publishport-protocol

Conversation

@ysinghc
Copy link
Contributor

@ysinghc ysinghc commented Feb 27, 2026

Checklist

Ensure you have completed the following checklist for your pull request to be reviewed:

  • Certify you wrote the patch or otherwise have the right to pass it on as an open-source patch by signing all
    commits. (git commit -s). (If needed, use git commit -s --amend). The author email must match
    the sign-off email address. See CONTRIBUTING.md
    for more information.
  • Referenced issues using Fixes: Documentation: PublishPort does not mention the possibility to define a protocol #28146 in commit message (if applicable)
  • Tests have been added/updated (or no tests are needed)
  • Documentation has been updated (or no documentation changes are needed)
  • All commits pass make validatepr (format/lint checks)
  • Release note entered in the section below (or None if no user-facing changes)

Does this PR introduce a user-facing change?

None

Copilot AI review requested due to automatic review settings February 27, 2026 00:04
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR enhances the documentation for the PublishPort option in Podman systemd units by explicitly documenting protocol support (tcp, udp, sctp), addressing a gap identified in issue #28146 where users discovered protocol specification worked but wasn't documented.

Changes:

  • Added protocol documentation to three PublishPort sections (Container, Pod, and Kube units)
  • Included format example showing protocol syntax: hostPort:containerPort/tcp
  • Listed valid protocols: tcp, udp, and sctp

@packit-as-a-service
Copy link

[NON-BLOCKING] Packit jobs failed. @containers/packit-build please check. Everyone else, feel free to ignore.

2 similar comments
@packit-as-a-service
Copy link

[NON-BLOCKING] Packit jobs failed. @containers/packit-build please check. Everyone else, feel free to ignore.

@packit-as-a-service
Copy link

[NON-BLOCKING] Packit jobs failed. @containers/packit-build please check. Everyone else, feel free to ignore.

Copy link

@robin-checkmk robin-checkmk left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thanks!

@ysinghc
Copy link
Contributor Author

ysinghc commented Feb 27, 2026

mb, messed up the order a little, i will fix it asap and squash them

@ysinghc ysinghc force-pushed the docs-publishport-protocol branch from 6a36aaf to 14c4608 Compare February 27, 2026 08:51
@ysinghc
Copy link
Contributor Author

ysinghc commented Feb 27, 2026

@danishprakash Did the changes and squashed them

Copy link
Member

@Honny1 Honny1 left a comment

Choose a reason for hiding this comment

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

I have one comment; otherwise, LGTM. Thanks.

…Port

Fixes: containers#28146
Signed-off-by: Yuvraj Singh Chauhan <ysinghcin@gmail.com>

Update docs/source/markdown/podman-systemd.unit.5.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Yuvraj Singh Chauhan <24429@iiitu.ac.in>

Update docs/source/markdown/podman-systemd.unit.5.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Yuvraj Singh Chauhan <24429@iiitu.ac.in>

Update docs/source/markdown/podman-systemd.unit.5.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Yuvraj Singh Chauhan <24429@iiitu.ac.in>

docs(podman-systemd.unit.5.md): clarify supported protocols for PublishPort

Update docs/source/markdown/podman-systemd.unit.5.md

Co-authored-by: Danish Prakash <contact@danishpraka.sh>
Signed-off-by: Yuvraj Singh Chauhan <24429@iiitu.ac.in>

docs(podman-systemd.unit.5.md): update valid protocols for PublishPort to include sctp (rootful only)

docs(podman-systemd.unit.5.md): clarify supported protocols for PublishPort
@ysinghc ysinghc force-pushed the docs-publishport-protocol branch from 14c4608 to 30f0673 Compare February 27, 2026 10:01
Copy link
Member

@Honny1 Honny1 left a comment

Choose a reason for hiding this comment

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

LGTM

@TomSweeneyRedHat
Copy link
Member

LGTM
Thanks @ysinghc ! I've restarted the one failing test, it is a flake.

@TomSweeneyRedHat
Copy link
Member

@mheon, PTAL

@mheon
Copy link
Member

mheon commented Mar 1, 2026

LGTM

@mheon mheon merged commit 559dce7 into containers:main Mar 1, 2026
42 checks passed
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.

Documentation: PublishPort does not mention the possibility to define a protocol

7 participants