cmd

package
v0.0.0-...-648dfe1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 22, 2026 License: Apache-2.0, BSD-3-Clause, MIT Imports: 82 Imported by: 3

Documentation

Overview

Package cmd holds implementations of the runsc commands.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WritePidFile 

func WritePidFile(path string, pid int) error

WritePidFile writes pid file atomically if possible.

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 {
	util.InternalSubCommand
	// 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.

func (*Boot) Name 

func (*Boot) Name() string

Name implements subcommands.Command.Name.

func (*Boot) SetFlags 

func (b *Boot) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Boot) Synopsis 

func (*Boot) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Boot) Usage 

func (*Boot) Usage() string

Usage implements subcommands.Command.Usage.

type CPUFeatures 

type CPUFeatures struct{}

CPUFeatures implements subcommands.Command for the "cpu-features" command.

func (*CPUFeatures) Execute 

func (*CPUFeatures) Execute(_ context.Context, _ *flag.FlagSet, args ...any) subcommands.ExitStatus

Execute implements subcommands.Command.Execute.

func (*CPUFeatures) FetchSpec 

func (*CPUFeatures) FetchSpec(_ *config.Config, _ *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*CPUFeatures) Name 

func (*CPUFeatures) Name() string

Name implements subcommands.command.name.

func (*CPUFeatures) SetFlags 

func (*CPUFeatures) SetFlags(*flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*CPUFeatures) Synopsis 

func (*CPUFeatures) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*CPUFeatures) Usage 

func (*CPUFeatures) Usage() string

Usage implements subcommands.Command.Usage.

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) FetchSpec 

func (c *Checkpoint) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

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 

type CompatibilityInfo map[string]map[string]ArchInfo

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.

func (*Create) FetchSpec 

func (c *Create) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Create) Name 

func (*Create) Name() string

Name implements subcommands.Command.Name.

func (*Create) SetFlags 

func (c *Create) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Create) Synopsis 

func (*Create) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Create) Usage 

func (*Create) Usage() string

Usage implements subcommands.Command.Usage.

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.

func (*Debug) FetchSpec 

func (d *Debug) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Debug) Name 

func (*Debug) Name() string

Name implements subcommands.Command.

func (*Debug) SetFlags 

func (d *Debug) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.

func (*Debug) Synopsis 

func (*Debug) Synopsis() string

Synopsis implements subcommands.Command.

func (*Debug) Usage 

func (*Debug) Usage() string

Usage implements subcommands.Command.

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.

func (*Delete) FetchSpec 

func (d *Delete) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Delete) Name 

func (*Delete) Name() string

Name implements subcommands.Command.Name.

func (*Delete) SetFlags 

func (d *Delete) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Delete) Synopsis 

func (*Delete) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Delete) Usage 

func (*Delete) Usage() string

Usage implements subcommands.Command.Usage.

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.

func (*Do) FetchSpec 

func (c *Do) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Do) Name 

func (*Do) Name() string

Name implements subcommands.Command.Name.

func (*Do) SetFlags 

func (c *Do) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Do) Synopsis 

func (*Do) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Do) Usage 

func (*Do) Usage() string

Usage implements subcommands.Command.Usage.

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.

func (*Events) FetchSpec 

func (evs *Events) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Events) Name 

func (*Events) Name() string

Name implements subcommands.Command.Name.

func (*Events) SetFlags 

func (evs *Events) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Events) Synopsis 

func (*Events) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Events) Usage 

func (*Events) Usage() string

Usage implements subcommands.Command.Usage.

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.

func (*Exec) FetchSpec 

func (ex *Exec) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Exec) Name 

func (*Exec) Name() string

Name implements subcommands.Command.Name.

func (*Exec) SetFlags 

func (ex *Exec) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Exec) Synopsis 

func (*Exec) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Exec) Usage 

func (*Exec) Usage() string

Usage implements subcommands.Command.Usage.

type FSCheckpoint 

type FSCheckpoint struct {
	// contains filtered or unexported fields
}

FSCheckpoint implements subcommands.Command for the "fscheckpoint" command.

func (*FSCheckpoint) Execute 

func (c *FSCheckpoint) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus

Execute implements subcommands.Command.Execute.

func (*FSCheckpoint) FetchSpec 

func (c *FSCheckpoint) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*FSCheckpoint) Name 

func (*FSCheckpoint) Name() string

Name implements subcommands.Command.Name.

func (*FSCheckpoint) SetFlags 

func (c *FSCheckpoint) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*FSCheckpoint) Synopsis 

func (*FSCheckpoint) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*FSCheckpoint) Usage 

func (*FSCheckpoint) Usage() string

Usage implements subcommands.Command.Usage.

type Features 

type Features struct{}

Features implements subcommands.Command for the "features" command.

func (*Features) Execute 

func (*Features) Execute(_ context.Context, _ *flag.FlagSet, args ...any) subcommands.ExitStatus

Execute implements subcommands.Command.Execute.

func (*Features) FetchSpec 

func (*Features) FetchSpec(_ *config.Config, _ *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Features) Name 

func (*Features) Name() string

Name implements subcommands.command.name.

func (*Features) SetFlags 

func (*Features) SetFlags(*flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Features) Synopsis 

func (*Features) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Features) Usage 

func (*Features) Usage() string

Usage implements subcommands.Command.Usage.

type Gofer 

type Gofer struct {
	util.InternalSubCommand
	// 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.

func (*Gofer) Name 

func (*Gofer) Name() string

Name implements subcommands.Command.

func (*Gofer) SetFlags 

func (g *Gofer) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.

func (*Gofer) Synopsis 

func (g *Gofer) Synopsis() string

Synopsis implements subcommands.Command.

func (*Gofer) Usage 

func (*Gofer) Usage() string

Usage implements subcommands.Command.

type Install 

type Install struct {
	ConfigFile       string
	Runtime          string
	Experimental     bool
	Clobber          bool
	CgroupDriver     string
	DownloadSidecars sidecarPolicy
	SidecarURL       string
	RequireSidecars  sidecarPolicy
	// contains filtered or unexported fields
}

Install implements subcommands.Command.

func (*Install) Execute 

func (i *Install) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus

Execute implements subcommands.Command.Execute.

func (*Install) FetchSpec 

func (*Install) FetchSpec(_ *config.Config, _ *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Install) Name 

func (*Install) Name() string

Name implements subcommands.Command.Name.

func (*Install) SetFlags 

func (i *Install) SetFlags(fs *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Install) Synopsis 

func (*Install) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Install) Usage 

func (*Install) Usage() string

Usage implements subcommands.Command.Usage.

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.

func (*Kill) FetchSpec 

func (k *Kill) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Kill) Name 

func (*Kill) Name() string

Name implements subcommands.Command.Name.

func (*Kill) SetFlags 

func (k *Kill) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Kill) Synopsis 

func (*Kill) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Kill) Usage 

func (*Kill) Usage() string

Usage implements subcommands.Command.Usage.

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.

func (*List) FetchSpec 

func (l *List) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*List) Name 

func (*List) Name() string

Name implements subcommands.command.name.

func (*List) SetFlags 

func (l *List) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*List) Synopsis 

func (*List) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*List) Usage 

func (*List) Usage() string

Usage implements subcommands.Command.Usage.

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) FetchSpec 

func (m *MetricExport) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

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) FetchSpec 

func (m *MetricMetadata) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

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.

func (*Mitigate) FetchSpec 

func (*Mitigate) FetchSpec(_ *config.Config, _ *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Mitigate) Name 

func (*Mitigate) Name() string

Name implements subcommands.command.name.

func (*Mitigate) SetFlags 

func (m *Mitigate) SetFlags(f *flag.FlagSet)

SetFlags sets flags for the command Mitigate.

func (*Mitigate) Synopsis 

func (*Mitigate) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Mitigate) Usage 

func (m *Mitigate) Usage() string

Usage implements Usage for cmd.Mitigate.

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.

func (*PS) FetchSpec 

func (ps *PS) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*PS) Name 

func (*PS) Name() string

Name implements subcommands.Command.Name.

func (*PS) SetFlags 

func (ps *PS) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*PS) Synopsis 

func (*PS) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*PS) Usage 

func (*PS) Usage() string

Usage implements subcommands.Command.Usage.

type Pause 

type Pause struct {
	// contains filtered or unexported fields
}

Pause implements subcommands.Command for the "pause" command.

func (*Pause) Execute 

func (p *Pause) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus

Execute implements subcommands.Command.Execute.

func (*Pause) FetchSpec 

func (p *Pause) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Pause) Name 

func (*Pause) Name() string

Name implements subcommands.Command.Name.

func (*Pause) SetFlags 

func (*Pause) SetFlags(*flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Pause) Synopsis 

func (*Pause) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Pause) Usage 

func (*Pause) Usage() string

Usage implements subcommands.Command.Usage.

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.

func (*Platforms) Name 

func (*Platforms) Name() string

Name implements subcommands.Command.Name.

func (*Platforms) SetFlags 

func (*Platforms) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Platforms) Synopsis 

func (*Platforms) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Platforms) Usage 

func (*Platforms) Usage() string

Usage implements subcommands.Command.Usage.

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) FetchSpec 

func (p *PortForward) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

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 Read 

type Read struct {
	// contains filtered or unexported fields
}

Read implements subcommands.Command for the "read" command.

func (*Read) Execute 

func (r *Read) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus

Execute implements subcommands.Command.Execute.

func (*Read) FetchSpec 

func (r *Read) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Read) Name 

func (*Read) Name() string

Name implements subcommands.Command.Name.

func (*Read) SetFlags 

func (r *Read) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Read) Synopsis 

func (*Read) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Read) Usage 

func (*Read) Usage() string

Usage implements subcommands.Command.Usage.

type ReadControl 

type ReadControl struct {
	// contains filtered or unexported fields
}

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) FetchSpec 

func (r *ReadControl) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

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.

func (*Restore) FetchSpec 

func (r *Restore) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Restore) Name 

func (*Restore) Name() string

Name implements subcommands.Command.Name.

func (*Restore) SetFlags 

func (r *Restore) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Restore) Synopsis 

func (*Restore) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Restore) Usage 

func (*Restore) Usage() string

Usage implements subcommands.Command.Usage.

type Resume 

type Resume struct {
	// contains filtered or unexported fields
}

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.

func (*Resume) FetchSpec 

func (r *Resume) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Resume) Name 

func (*Resume) Name() string

Name implements subcommands.Command.Name.

func (*Resume) SetFlags 

func (*Resume) SetFlags(*flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Resume) Synopsis 

func (*Resume) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Resume) Usage 

func (*Resume) Usage() string

Usage implements subcommands.Command.Usage.

type RootfsUpper 

type RootfsUpper struct {
	// contains filtered or unexported fields
}

RootfsUpper implements subcommands.Command for the "tar rootfs-upper" command.

func (*RootfsUpper) Execute 

func (r *RootfsUpper) Execute(ctx context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus

Execute implements subcommands.Command.

func (*RootfsUpper) Name 

func (*RootfsUpper) Name() string

Name implements subcommands.Command.

func (*RootfsUpper) SetFlags 

func (r *RootfsUpper) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.

func (*RootfsUpper) Synopsis 

func (*RootfsUpper) Synopsis() string

Synopsis implements subcommands.Command.

func (*RootfsUpper) Usage 

func (*RootfsUpper) Usage() string

Usage implements subcommands.Command.

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.

func (*Run) FetchSpec 

func (r *Run) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Run) Name 

func (*Run) Name() string

Name implements subcommands.Command.Name.

func (*Run) SetFlags 

func (r *Run) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Run) Synopsis 

func (*Run) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Run) Usage 

func (*Run) Usage() string

Usage implements subcommands.Command.Usage.

type SandboxExec 

type SandboxExec struct {
	// contains filtered or unexported fields
}

SandboxExec implements subcommands.Command for the "sandboxexec" command.

func (*SandboxExec) Execute 

func (c *SandboxExec) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus

Execute implements subcommands.Command.Execute.

func (*SandboxExec) FetchSpec 

func (c *SandboxExec) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*SandboxExec) Name 

func (*SandboxExec) Name() string

Name implements subcommands.Command.Name.

func (*SandboxExec) SetFlags 

func (c *SandboxExec) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*SandboxExec) Synopsis 

func (*SandboxExec) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*SandboxExec) Usage 

func (*SandboxExec) Usage() string

Usage implements subcommands.Command.Usage.

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.

func (*Spec) FetchSpec 

func (s *Spec) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Spec) Name 

func (*Spec) Name() string

Name implements subcommands.Command.Name.

func (*Spec) SetFlags 

func (s *Spec) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Spec) Synopsis 

func (*Spec) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Spec) Usage 

func (*Spec) Usage() string

Usage implements subcommands.Command.Usage.

type Start 

type Start struct {
	// contains filtered or unexported fields
}

Start implements subcommands.Command for the "start" command.

func (*Start) Execute 

func (s *Start) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus

Execute implements subcommands.Command.Execute.

func (*Start) FetchSpec 

func (s *Start) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Start) Name 

func (*Start) Name() string

Name implements subcommands.Command.Name.

func (*Start) SetFlags 

func (*Start) SetFlags(*flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Start) Synopsis 

func (*Start) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Start) Usage 

func (*Start) Usage() string

Usage implements subcommands.Command.Usage.

type State 

type State struct {
	// contains filtered or unexported fields
}

State implements subcommands.Command for the "state" command.

func (*State) Execute 

func (s *State) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus

Execute implements subcommands.Command.Execute.

func (*State) FetchSpec 

func (s *State) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*State) Name 

func (*State) Name() string

Name implements subcommands.Command.Name.

func (*State) SetFlags 

func (*State) SetFlags(*flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*State) Synopsis 

func (*State) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*State) Usage 

func (*State) Usage() string

Usage implements subcommands.Command.Usage.

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.

func (*Statefile) FetchSpec 

func (*Statefile) FetchSpec(_ *config.Config, _ *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Statefile) Name 

func (*Statefile) Name() string

Name implements subcommands.Command.

func (*Statefile) SetFlags 

func (s *Statefile) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.

func (*Statefile) Synopsis 

func (*Statefile) Synopsis() string

Synopsis implements subcommands.Command.

func (*Statefile) Usage 

func (*Statefile) Usage() string

Usage implements subcommands.Command.

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.

func (*Symbolize) FetchSpec 

func (c *Symbolize) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Symbolize) Name 

func (*Symbolize) Name() string

Name implements subcommands.Command.Name.

func (*Symbolize) SetFlags 

func (c *Symbolize) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Symbolize) Synopsis 

func (*Symbolize) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Symbolize) Usage 

func (*Symbolize) Usage() string

Usage implements subcommands.Command.Usage.

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.

func (*Syscalls) Name 

func (*Syscalls) Name() string

Name implements subcommands.Command.Name.

func (*Syscalls) SetFlags 

func (s *Syscalls) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Syscalls) Synopsis 

func (*Syscalls) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Syscalls) Usage 

func (*Syscalls) Usage() string

Usage implements subcommands.Command.Usage.

type Tar 

type Tar struct{}

Tar implements subcommands.Command for the "tar" command.

func (*Tar) Execute 

func (*Tar) Execute(ctx context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus

Execute implements subcommands.Command.

func (*Tar) FetchSpec 

func (c *Tar) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Tar) Name 

func (*Tar) Name() string

Name implements subcommands.Command.

func (*Tar) SetFlags 

func (*Tar) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.

func (*Tar) Synopsis 

func (*Tar) Synopsis() string

Synopsis implements subcommands.Command.

func (*Tar) Usage 

func (*Tar) Usage() string

Usage implements subcommands.Command.

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.

func (*Umount) FetchSpec 

func (u *Umount) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Umount) Name 

func (*Umount) Name() string

Name implements subcommands.Command.Name.

func (*Umount) SetFlags 

func (u *Umount) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Umount) Synopsis 

func (*Umount) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Umount) Usage 

func (*Umount) Usage() string

Usage implements subcommands.Command.Usage.

type Uninstall 

type Uninstall struct {
	ConfigFile string
	Runtime    string
}

Uninstall implements subcommands.Command.

func (*Uninstall) Execute 

func (u *Uninstall) Execute(context.Context, *flag.FlagSet, ...any) subcommands.ExitStatus

Execute implements subcommands.Command.Execute.

func (*Uninstall) FetchSpec 

func (*Uninstall) FetchSpec(_ *config.Config, _ *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Uninstall) Name 

func (*Uninstall) Name() string

Name implements subcommands.Command.Name.

func (*Uninstall) SetFlags 

func (u *Uninstall) SetFlags(fs *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Uninstall) Synopsis 

func (*Uninstall) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Uninstall) Usage 

func (*Uninstall) Usage() string

Usage implements subcommands.Command.Usage.

type Update 

type Update struct {
	// contains filtered or unexported fields
}

Update implements subcommands.Command for the "update" command.

func (*Update) Execute 

func (u *Update) Execute(_ context.Context, f *flag.FlagSet, args ...any) subcommands.ExitStatus

Execute implements subcommands.Command.Execute.

func (*Update) FetchSpec 

func (u *Update) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Update) Name 

func (*Update) Name() string

Name implements subcommands.Command.Name.

func (*Update) SetFlags 

func (u *Update) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Update) Synopsis 

func (*Update) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Update) Usage 

func (*Update) Usage() string

Usage implements subcommands.Command.Usage.

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.

func (*Usage) FetchSpec 

func (u *Usage) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Usage) Name 

func (*Usage) Name() string

Name implements subcommands.Command.Name.

func (*Usage) SetFlags 

func (u *Usage) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Usage) Synopsis 

func (*Usage) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Usage) Usage 

func (*Usage) Usage() string

Usage implements subcommands.Command.Usage.

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.

func (*Wait) FetchSpec 

func (wt *Wait) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

func (*Wait) Name 

func (*Wait) Name() string

Name implements subcommands.Command.Name.

func (*Wait) SetFlags 

func (wt *Wait) SetFlags(f *flag.FlagSet)

SetFlags implements subcommands.Command.SetFlags.

func (*Wait) Synopsis 

func (*Wait) Synopsis() string

Synopsis implements subcommands.Command.Synopsis.

func (*Wait) Usage 

func (*Wait) Usage() string

Usage implements subcommands.Command.Usage.

type WriteControl 

type WriteControl struct {
	// contains filtered or unexported fields
}

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) FetchSpec 

func (r *WriteControl) FetchSpec(conf *config.Config, f *flag.FlagSet) (string, *specs.Spec, error)

FetchSpec implements util.SubCommand.FetchSpec.

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

View all Source files

Directories

Path Synopsis
Package alias provides aliases for runsc commands.
 Package alias provides aliases for runsc commands.
bwrap
Package bwrap provides functions for interacting with the bwrap command.
 Package bwrap provides functions for interacting with the bwrap command.
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 sandboxsetup provides helpers for setting up gVisor sandboxes.
 Package sandboxsetup provides helpers for setting up gVisor sandboxes.
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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.