Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

add comments to qm.container service #710

Merged
merged 1 commit into from
Feb 6, 2025

Conversation

pengshanyu
Copy link
Collaborator

resolve part of: #384
Update [Service] section in qm.container to describe in short comments what are the options.

@pengshanyu
Copy link
Collaborator Author

I am not sure about the parameter values for qm scenario, I did some searching and refer to "systemd.resource-control - Resource control unit settings".
Hi @dougsland , @Yarboa , could you please give me some review and reference? Thanks.

@Yarboa
Copy link
Collaborator

Yarboa commented Jan 27, 2025

@pengshanyu

There is also this PR #678
This is quadlet file, it is all written in man quadlet

related to man please search for /\[Service\]
It refers you to that one, as you already found, why not redirecting users to that?

[Service] table and [Install] tables pass directly to systemd and are handled by  it.
       See systemd.unit(5) man page for more information.

So I would suggest to show where to find the relevant directive for the service
man systemd.directives
You could find each directive, to refer

man systemd.directives | grep -A1 ".* AllowedCPUs=.*"
       AllowedCPUs=
           systemd.resource-control(5)

then man systemd.resource-control explains the relevant information

Please share your thoughts here
If we are not aware of it, i assume other contributors will repeat the same loop

So instead of wording, I would refer to the relevant man section, which is all about systemd and resource-control

@pengshanyu
Copy link
Collaborator Author

Hi @Yarboa , thank you so much for your suggestion.
You are right. Refer to the relevant man section people can get more accurate information.
You mean that in the comment, we just need to write the man command for example man systemd.resource-control, right? So that they can directly find the relevant parameters.

Copy link
Collaborator

@Yarboa Yarboa left a comment

Choose a reason for hiding this comment

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

please see my comment below

qm.container Outdated Show resolved Hide resolved
Signed-off-by: pengshanyu <[email protected]>
@pengshanyu pengshanyu force-pushed the add-comment-for-service branch from 2b2d96b to 1c53e0f Compare February 5, 2025 03:03
@pengshanyu
Copy link
Collaborator Author

Hi @Yarboa , could you please help to review it again, thanks.

Copy link
Collaborator

@Yarboa Yarboa left a comment

Choose a reason for hiding this comment

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

LGTM

@Yarboa Yarboa merged commit 16a3ca7 into containers:main Feb 6, 2025
13 of 14 checks passed
@pengshanyu pengshanyu deleted the add-comment-for-service branch February 7, 2025 05:21
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