Categorygithub.com/sipsma/go-runc
modulepackage
0.0.0-20190923131748-a2952bc25f51
Repository: https://github.com/sipsma/go-runc.git
Documentation: pkg.go.dev

# README

go-runc

Build Status codecov

This is a package for consuming the runc binary in your Go applications. It tries to expose all the settings and features of the runc CLI. If there is something missing then add it, its opensource!

This needs runc @ a9610f2c0 or greater.

Docs

Docs can be found at godoc.org.

Project details

The go-runc is a containerd sub-project, licensed under the Apache 2.0 license. As a containerd sub-project, you will find the:

information in our containerd/project repository.

# Functions

LeaveRunning keeps the container running after the checkpoint has been completed.
NewConsoleSocket creates a new unix socket at the provided path to accept a pty master created by runc for use by the container.
NewNullIO returns IO setup for /dev/null use with runc.
NewPipeIO creates pipe pairs to be used with runc.
No description provided by the author
NewTempConsoleSocket returns a temp console socket for use with a container On Close(), the socket is deleted.
ParsePSOutput parses the runtime's ps raw output and returns a TopResults.
PreDump allows a pre-dump of the checkpoint to be made and completed later.
ReadPidFile reads the pid file at the provided path and returns the pid or an error if the read and conversion is unsuccessful.

# Constants

DefaultCommand is the default command for Runc.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
Container hold information for a runc container.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IOOption holds I/O creation options.
KillOpts specifies options for killing a container and its processes.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Runc is the client to the runc cli.
Socket is a unix socket that accepts the pty master created by runc.
No description provided by the author
No description provided by the author
TopBody represents the structured data of the full ps output.
No description provided by the author

# Interfaces

No description provided by the author
No description provided by the author
ProcessMonitor is an interface for process monitoring It allows daemons using go-runc to have a SIGCHLD handler to handle exits without introducing races between the handler and go's exec.Cmd These methods should match the methods exposed by exec.Cmd to provide a consistent experience for the caller.
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
Format is the type of log formatting options avaliable.
IOOpt sets I/O creation options.