Skip to content

document --service-container on podman-kube-play #25708

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

erdnaxeli
Copy link

This flag was added on Podman v4.4.0 but was not documented.

Does this PR introduce a user-facing change?

Document `--service-container` on podman-kube-play

This flag was added on Podman v4.4.0 but was not documented.

Signed-off-by: Alexandre Morignot <erdnaxeli@cervoi.se>
Copy link
Contributor

openshift-ci bot commented Mar 27, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: erdnaxeli
Once this PR has been reviewed and has the lgtm label, please assign mtrmac for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@erdnaxeli
Copy link
Author

I just read this:

  // Below flags are local-only and hidden since they are used in
  // kube-play's systemd integration only and hence hidden from
  // users.

As this flag can be seen with systemctl status (example below) I think it should be documented anyway.

× someservice.service - Some Service
     Loaded: loaded (/home/podman/.config/containers/systemd/someservice.kube; generated)
     Active: failed (Result: exit-code) since Thu 2025-03-27 14:19:38 UTC; 48min ago
    Process: 2361448 ExecStart=/usr/bin/podman kube play --replace --service-container=true /home/podman/someservice/kube.yaml (code=exited, status=125)
    Process: 2361838 ExecStopPost=/usr/bin/podman kube down /home/podman/someservice/kube.yaml (code=exited, status=0/SUCCESS)
   Main PID: 2361448 (code=exited, status=125)
        CPU: 1.292s

@Luap99
Copy link
Member

Luap99 commented Mar 27, 2025

The reason we hide because we only use it for the systemd integration and don't expect users to use that directly as such it is hidden.

It is not stable as we can change it anytime what it does internally. As such I don't think it should be documented. If it would be it would have to sat it is not stable and not supposed to be used outside of systemd.

@erdnaxeli
Copy link
Author

erdnaxeli commented Mar 27, 2025

I understand why it is hidden, but I saw it in the output of systemctl status and I was wondering what it does. I found no documentation in the manpage, and I finally found the changelog which is the only mention of it.

Copy link

A friendly reminder that this PR had no activity for 30 days.

@danishprakash
Copy link
Contributor

It'd be a good idea to document it, even if it's a flag not intended for end users. But as @Luap99 suggested, if we choose to document this, we should mention the fact that it's meant for systemd integration and perhaps that it's subject to changes as well.

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants