Documentation
¶
Overview ¶
Package cmd holds implementations of the runsc commands.
Index ¶
- type ArchInfo
- type Boot
- type Checkpoint
- type CheckpointCompression
- type CompatibilityInfo
- type Create
- type Debug
- type Delete
- type Do
- type Events
- type Exec
- type Gofer
- type Help
- type Install
- type Kill
- type List
- type MetricExport
- type MetricMetadata
- type MetricServer
- type Mitigate
- type PS
- type Pause
- type Platforms
- type PortForward
- type ReadControl
- type Restore
- type Resume
- type Run
- type Spec
- type Start
- type State
- type Statefile
- type Symbolize
- type SyscallDoc
- type Syscalls
- type Umount
- type Uninstall
- type Usage
- type Wait
- type WriteControl
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ArchInfo ¶
type ArchInfo struct {
// Syscalls maps syscall number for the architecture to the doc.
Syscalls map[uintptr]SyscallDoc `json:"syscalls"`
}
ArchInfo is compatibility doc for an architecture.
type Boot ¶
type Boot struct {
// contains filtered or unexported fields
}
Boot implements subcommands.Command for the "boot" command which starts a new sandbox. It should not be called directly.
func (*Boot) Execute ¶
func (b *Boot) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute. It starts a sandbox in a waiting state.
type Checkpoint ¶
type Checkpoint struct {
// contains filtered or unexported fields
}
Checkpoint implements subcommands.Command for the "checkpoint" command.
func (*Checkpoint) Execute ¶
func (c *Checkpoint) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
func (*Checkpoint) Name ¶
func (*Checkpoint) Name() string
Name implements subcommands.Command.Name.
func (*Checkpoint) SetFlags ¶
func (c *Checkpoint) SetFlags(f *flag.FlagSet)
SetFlags implements subcommands.Command.SetFlags.
func (*Checkpoint) Synopsis ¶
func (*Checkpoint) Synopsis() string
Synopsis implements subcommands.Command.Synopsis.
func (*Checkpoint) Usage ¶
func (*Checkpoint) Usage() string
Usage implements subcommands.Command.Usage.
type CheckpointCompression ¶
type CheckpointCompression statefile.CompressionLevel
CheckpointCompression represents checkpoint image writer behavior. The default behavior is to compress because the default behavior used to be to always compress.
func (*CheckpointCompression) Get ¶
func (g *CheckpointCompression) Get() any
Get implements flag.Getter.
func (CheckpointCompression) Level ¶
func (g CheckpointCompression) Level() statefile.CompressionLevel
Level returns corresponding statefile.CompressionLevel value.
func (*CheckpointCompression) Set ¶
func (g *CheckpointCompression) Set(v string) error
Set implements flag.Value.
func (CheckpointCompression) String ¶
func (g CheckpointCompression) String() string
String implements flag.Value.
type CompatibilityInfo ¶
CompatibilityInfo is a map of system and architecture to compatibility doc. Maps operating system to architecture to ArchInfo.
type Create ¶
type Create struct {
// contains filtered or unexported fields
}
Create implements subcommands.Command for the "create" command.
func (*Create) Execute ¶
func (c *Create) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Debug ¶
type Debug struct {
// contains filtered or unexported fields
}
Debug implements subcommands.Command for the "debug" command.
func (*Debug) Execute ¶
func (d *Debug) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Delete ¶
type Delete struct {
// contains filtered or unexported fields
}
Delete implements subcommands.Command for the "delete" command.
func (*Delete) Execute ¶
func (d *Delete) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Do ¶
type Do struct {
// contains filtered or unexported fields
}
Do implements subcommands.Command for the "do" command. It sets up a simple sandbox and executes the command inside it. See Usage() for more details.
func (*Do) Execute ¶
func (c *Do) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Events ¶
type Events struct {
// contains filtered or unexported fields
}
Events implements subcommands.Command for the "events" command.
func (*Events) Execute ¶
func (evs *Events) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Exec ¶
type Exec struct {
// contains filtered or unexported fields
}
Exec implements subcommands.Command for the "exec" command.
func (*Exec) Execute ¶
func (ex *Exec) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute. It starts a process in an already created container.
type Gofer ¶
type Gofer struct {
// contains filtered or unexported fields
}
Gofer implements subcommands.Command for the "gofer" command, which starts a filesystem gofer. This command should not be called directly.
func (*Gofer) Execute ¶
func (g *Gofer) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.
type Help ¶
type Help struct {
// contains filtered or unexported fields
}
Help implements subcommands.Command for the "help" command. The 'help' command prints help for commands registered to a Commander but also allows for registering additional help commands that print other documentation.
func NewHelp ¶
func NewHelp(cdr *subcommands.Commander) *Help
NewHelp returns a help command for the given commander.
func (*Help) Execute ¶
func (h *Help) Execute(ctx context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
func (*Help) Register ¶
func (h *Help) Register(cmd subcommands.Command)
Register registers a new help command.
type Install ¶
type Install struct {
ConfigFile string
Runtime string
Experimental bool
Clobber bool
CgroupDriver string
// contains filtered or unexported fields
}
Install implements subcommands.Command.
func (*Install) Execute ¶
func (i *Install) Execute(_ context.Context, f *flag.FlagSet, _ ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Kill ¶
type Kill struct {
// contains filtered or unexported fields
}
Kill implements subcommands.Command for the "kill" command.
func (*Kill) Execute ¶
func (k *Kill) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type List ¶
type List struct {
// contains filtered or unexported fields
}
List implements subcommands.Command for the "list" command.
func (*List) Execute ¶
func (l *List) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type MetricExport ¶
type MetricExport struct {
// contains filtered or unexported fields
}
MetricExport implements subcommands.Command for the "metric-export" command.
func (*MetricExport) Execute ¶
func (m *MetricExport) Execute(ctx context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
func (*MetricExport) Name ¶
func (*MetricExport) Name() string
Name implements subcommands.Command.Name.
func (*MetricExport) SetFlags ¶
func (m *MetricExport) SetFlags(f *flag.FlagSet)
SetFlags implements subcommands.Command.SetFlags.
func (*MetricExport) Synopsis ¶
func (*MetricExport) Synopsis() string
Synopsis implements subcommands.Command.Synopsis.
func (*MetricExport) Usage ¶
func (*MetricExport) Usage() string
Usage implements subcommands.Command.Usage.
type MetricMetadata ¶
type MetricMetadata struct {
}
MetricMetadata implements subcommands.Command for the "metric-metadata" command.
func (*MetricMetadata) Execute ¶
func (m *MetricMetadata) Execute(ctx context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
func (*MetricMetadata) Name ¶
func (*MetricMetadata) Name() string
Name implements subcommands.Command.Name.
func (*MetricMetadata) SetFlags ¶
func (m *MetricMetadata) SetFlags(f *flag.FlagSet)
SetFlags implements subcommands.Command.SetFlags.
func (*MetricMetadata) Synopsis ¶
func (*MetricMetadata) Synopsis() string
Synopsis implements subcommands.Command.Synopsis.
func (*MetricMetadata) Usage ¶
func (*MetricMetadata) Usage() string
Usage implements subcommands.Command.Usage.
type MetricServer ¶
type MetricServer struct {
metricservercmd.Cmd
}
MetricServer implements subcommands.Command for the "metric-server" command.
func (*MetricServer) Execute ¶
func (m *MetricServer) Execute(ctx context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Mitigate ¶
type Mitigate struct {
// contains filtered or unexported fields
}
Mitigate implements subcommands.Command for the "mitigate" command.
func (*Mitigate) Execute ¶
func (m *Mitigate) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type PS ¶
type PS struct {
// contains filtered or unexported fields
}
PS implements subcommands.Command for the "ps" command.
func (*PS) Execute ¶
func (ps *PS) Execute(ctx context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Pause ¶
type Pause struct{}
Pause implements subcommands.Command for the "pause" command.
func (*Pause) Execute ¶
func (*Pause) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Platforms ¶
type Platforms struct{}
Platforms implements subcommands.Command for the "platforms" command.
func (*Platforms) Execute ¶
func (*Platforms) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type PortForward ¶
type PortForward struct {
// contains filtered or unexported fields
}
PortForward implements subcommands.Command for the "portforward" command.
func (*PortForward) Execute ¶
func (p *PortForward) Execute(ctx context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
func (*PortForward) Name ¶
func (*PortForward) Name() string
Name implements subcommands.Command.Name.
func (*PortForward) SetFlags ¶
func (p *PortForward) SetFlags(f *flag.FlagSet)
SetFlags implements subcommands.Command.SetFlags.
func (*PortForward) Synopsis ¶
func (*PortForward) Synopsis() string
Synopsis implements subcommands.Command.Synopsis.
func (*PortForward) Usage ¶
func (*PortForward) Usage() string
Usage implements subcommands.Command.Usage.
type ReadControl ¶
type ReadControl struct{}
ReadControl implements subcommands.Command for the "read-control" command.
func (*ReadControl) Execute ¶
func (r *ReadControl) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
func (*ReadControl) Name ¶
func (*ReadControl) Name() string
Name implements subcommands.Command.Name.
func (*ReadControl) SetFlags ¶
func (r *ReadControl) SetFlags(f *flag.FlagSet)
SetFlags implements subcommands.Command.SetFlags.
func (*ReadControl) Synopsis ¶
func (*ReadControl) Synopsis() string
Synopsis implements subcommands.Command.Synopsis.
func (*ReadControl) Usage ¶
func (*ReadControl) Usage() string
Usage implements subcommands.Command.Usage.
type Restore ¶
type Restore struct {
// Restore flags are a super-set of those for Create.
Create
// contains filtered or unexported fields
}
Restore implements subcommands.Command for the "restore" command.
func (*Restore) Execute ¶
func (r *Restore) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Resume ¶
type Resume struct{}
Resume implements subcommands.Command for the "resume" command.
func (*Resume) Execute ¶
func (r *Resume) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Run ¶
type Run struct {
// Run flags are a super-set of those for Create.
Create
// contains filtered or unexported fields
}
Run implements subcommands.Command for the "run" command.
func (*Run) Execute ¶
func (r *Run) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Spec ¶
type Spec struct {
// contains filtered or unexported fields
}
Spec implements subcommands.Command for the "spec" command.
func (*Spec) Execute ¶
func (s *Spec) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Start ¶
type Start struct{}
Start implements subcommands.Command for the "start" command.
func (*Start) Execute ¶
func (*Start) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type State ¶
type State struct{}
State implements subcommands.Command for the "state" command.
func (*State) Execute ¶
func (*State) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Statefile ¶
type Statefile struct {
// contains filtered or unexported fields
}
Statefile implements subcommands.Command for the "statefile" command.
func (*Statefile) Execute ¶
func (s *Statefile) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Symbolize ¶
type Symbolize struct {
// contains filtered or unexported fields
}
Symbolize implements subcommands.Command for the "symbolize" command.
func (*Symbolize) Execute ¶
func (c *Symbolize) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type SyscallDoc ¶
type SyscallDoc struct {
Name string `json:"name"`
Support string `json:"support"`
Note string `json:"note,omitempty"`
URLs []string `json:"urls,omitempty"`
// contains filtered or unexported fields
}
SyscallDoc represents a single item of syscall documentation.
type Syscalls ¶
type Syscalls struct {
// contains filtered or unexported fields
}
Syscalls implements subcommands.Command for the "syscalls" command.
func (*Syscalls) Execute ¶
func (s *Syscalls) Execute(context.Context, *flag.FlagSet, ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Umount ¶
type Umount struct {
// contains filtered or unexported fields
}
Umount implements subcommands.Command for the "umount" command.
func (*Umount) Execute ¶
func (u *Umount) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Uninstall ¶
Uninstall implements subcommands.Command.
func (*Uninstall) Execute ¶
func (u *Uninstall) Execute(context.Context, *flag.FlagSet, ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Usage ¶
type Usage struct {
// contains filtered or unexported fields
}
Usage implements subcommands.Command for the "usage" command.
func (*Usage) Execute ¶
func (u *Usage) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
type Wait ¶
type Wait struct {
// contains filtered or unexported fields
}
Wait implements subcommands.Command for the "wait" command.
func (*Wait) Execute ¶
func (wt *Wait) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute. It waits for a process in a container to exit before returning.
type WriteControl ¶
type WriteControl struct{}
WriteControl implements subcommands.Command for the "write-control" command.
func (*WriteControl) Execute ¶
func (r *WriteControl) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus
Execute implements subcommands.Command.Execute.
func (*WriteControl) Name ¶
func (*WriteControl) Name() string
Name implements subcommands.Command.Name.
func (*WriteControl) SetFlags ¶
func (r *WriteControl) SetFlags(f *flag.FlagSet)
SetFlags implements subcommands.Command.SetFlags.
func (*WriteControl) Synopsis ¶
func (*WriteControl) Synopsis() string
Synopsis implements subcommands.Command.Synopsis.
func (*WriteControl) Usage ¶
func (*WriteControl) Usage() string
Usage implements subcommands.Command.Usage.
Source Files
¶
- boot.go
- capability.go
- checkpoint.go
- chroot.go
- cmd.go
- create.go
- debug.go
- delete.go
- do.go
- events.go
- exec.go
- fd_mapping.go
- gofer.go
- help.go
- install.go
- kill.go
- list.go
- metric_export.go
- metric_metadata.go
- metric_server_elided.go
- metric_server_embedded.go
- mitigate.go
- mitigate_extras.go
- path.go
- pause.go
- platforms.go
- portforward.go
- ps.go
- read_control.go
- restore.go
- resume.go
- run.go
- spec.go
- start.go
- state.go
- statefile.go
- symbolize.go
- syscalls.go
- umount_unsafe.go
- usage.go
- wait.go
- write_control.go
Directories
¶
| Path | Synopsis |
|---|---|
|
The metricserver binary is a separate binary that implements the 'runsc metric-server' subcommand.
|
The metricserver binary is a separate binary that implements the 'runsc metric-server' subcommand. |
|
metricservercmd
Package metricservercmd partially implements the 'metric-server' subcommand.
|
Package metricservercmd partially implements the 'metric-server' subcommand. |
|
Package nvproxy provides subcommands for the nvproxy command.
|
Package nvproxy provides subcommands for the nvproxy command. |
|
Package trace provides subcommands for the trace command.
|
Package trace provides subcommands for the trace command. |
|
Package util groups a bunch of common helper functions used by commands.
|
Package util groups a bunch of common helper functions used by commands. |