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 man page for krun #1297

Merged
merged 1 commit into from
Sep 11, 2023
Merged

Add man page for krun #1297

merged 1 commit into from
Sep 11, 2023

Conversation

rhatdan
Copy link
Member

@rhatdan rhatdan commented Sep 7, 2023

No description provided.

@rhatdan
Copy link
Member Author

rhatdan commented Sep 7, 2023

@flouthoc
Copy link
Collaborator

flouthoc commented Sep 8, 2023

LGTM, for info: krun is also mentioned here: https://github.com/containers/crun/blob/main/crun.1.md#runocihandlerhandler , do we need a dedicated man page as well ?

@giuseppe
Copy link
Member

giuseppe commented Sep 8, 2023

LGTM, could you please commit also the krun.1 file so we don't need the goo toolchain in the CI (for go-md2man)?

krun.1 Outdated
containers that follow the Open Container Initiative (OCI) format.

.PP
krun uses the dynamic libkrun library to run processes in isolated environment
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
krun uses the dynamic libkrun library to run processes in isolated environment
krun uses the dynamic libkrun library to run processes in an isolated environment

krun.1 Outdated
using KVM Virtualization.

.PP
libkrun integrates a VMM (Virtual Machine Monitor, the userspace side of an
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
libkrun integrates a VMM (Virtual Machine Monitor, the userspace side of an
libkrun integrates a VMM (Virtual Machine Monitor, the userspace side of a

krun.1 Outdated

.PP
libkrun integrates a VMM (Virtual Machine Monitor, the userspace side of an
Hypervisor) with the minimum amount of emulated devices required to its purpose,
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Hypervisor) with the minimum amount of emulated devices required to its purpose,
Hypervisor) with the minimum amount of emulated devices required for its purpose,

krun.1 Outdated
.PP
libkrun integrates a VMM (Virtual Machine Monitor, the userspace side of an
Hypervisor) with the minimum amount of emulated devices required to its purpose,
abstracting most of the complexity that comes from Virtual Machine management.
Copy link
Member

Choose a reason for hiding this comment

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

Soft suggestion: drop "that comes"

libkrun integrates a VMM (Virtual Machine Monitor, the userspace side of an
Hypervisor) with the minimum amount of emulated devices required to its purpose,
abstracting most of the complexity that comes from Virtual Machine management.

Copy link
Member

Choose a reason for hiding this comment

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

Ditto comments from above in this file

@slp
Copy link
Contributor

slp commented Sep 8, 2023

Should we somehow clarify this isn't an independent OCI runtime but a way to tell crun to enable the libkrun plugin?

@rhatdan rhatdan force-pushed the man branch 2 times, most recently from d6ac519 to faf7324 Compare September 8, 2023 15:08
@rhatdan
Copy link
Member Author

rhatdan commented Sep 8, 2023

@TomSweeneyRedHat @slp Version 2 now available for review.

@rhatdan
Copy link
Member Author

rhatdan commented Sep 8, 2023

@giuseppe I think this is ready to in.

@slp @TomSweeneyRedHat one last look?

krun.1.md Outdated
command is a symbolic link to the crun execuable, that tells crun to run in
krun mode.

krun uses the dynamic libkrun library to run processes in isolated environment
Copy link
Member

Choose a reason for hiding this comment

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

need "an" between "in and "isolated" here and above.

@TomSweeneyRedHat
Copy link
Member

One tweak, otherwise LGTM

krun.1 Outdated

.PP
Because of the additional isolation, sharing content with processes and other
containres outside of the krun VM is more difficult.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
containres outside of the krun VM is more difficult.
containers outside of the krun VM is more difficult.

krun.1 Outdated
.PP
krun is a sub package of the crun command line program for running Linux
containers that follow the Open Container Initiative (OCI) format. The krun
command is a symbolic link to the crun execuable, that tells crun to run in
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
command is a symbolic link to the crun execuable, that tells crun to run in
command is a symbolic link to the crun executable, that tells crun to run in

krun.1.md Outdated Show resolved Hide resolved
krun.1.md Outdated Show resolved Hide resolved
Signed-off-by: Daniel J Walsh <[email protected]>
@slp
Copy link
Contributor

slp commented Sep 11, 2023

LGTM!

@rhatdan rhatdan merged commit 905552d into containers:main Sep 11, 2023
@edsantiago edsantiago mentioned this pull request Sep 26, 2023
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.

6 participants