Documentation
¶
Overview ¶
Package exec provides utilities for executing Open Container Initiative runtime hooks.
Index ¶
- Constants
- func Run(ctx context.Context, hook *rspec.Hook, state []byte, stdout io.Writer, ...) (hookErr, err error)deprecated
- func RunWithOptions(ctx context.Context, options RunOptions) (hookErr, err error)
- func RuntimeConfigFilter(ctx context.Context, hooks []spec.Hook, config *spec.Spec, ...) (hookErr, err error)deprecated
- func RuntimeConfigFilterWithOptions(ctx context.Context, options RuntimeConfigFilterOptions) (hookErr, err error)
- type RunOptions
- type RuntimeConfigFilterOptions
Constants ¶
const DefaultPostKillTimeout = time.Duration(10) * time.Second
DefaultPostKillTimeout is the recommended default post-kill timeout.
Variables ¶
This section is empty.
Functions ¶
func Run
deprecated
func Run(ctx context.Context, hook *rspec.Hook, state []byte, stdout io.Writer, stderr io.Writer, postKillTimeout time.Duration) (hookErr, err error)
Run executes the hook and waits for it to complete or for the context or hook-specified timeout to expire.
Deprecated: Too many arguments, has been refactored and replaced by RunWithOptions instead
func RunWithOptions ¶ added in v0.54.0
func RunWithOptions(ctx context.Context, options RunOptions) (hookErr, err error)
RunWithOptions executes the hook and waits for it to complete or for the context or hook-specified timeout to expire.
func RuntimeConfigFilter
deprecated
func RuntimeConfigFilter(ctx context.Context, hooks []spec.Hook, config *spec.Spec, postKillTimeout time.Duration) (hookErr, err error)
RuntimeConfigFilter calls a series of hooks. But instead of passing container state on their standard input, RuntimeConfigFilter passes the proposed runtime configuration (and reads back a possibly-altered form from their standard output).
Deprecated: Too many arguments, has been refactored and replaced by RuntimeConfigFilterWithOptions instead
func RuntimeConfigFilterWithOptions ¶ added in v0.54.0
func RuntimeConfigFilterWithOptions(ctx context.Context, options RuntimeConfigFilterOptions) (hookErr, err error)
RuntimeConfigFilterWithOptions calls a series of hooks. But instead of passing container state on their standard input, RuntimeConfigFilterWithOptions passes the proposed runtime configuration (and reads back a possibly-altered form from their standard output).
Types ¶
type RunOptions ¶ added in v0.54.0
type RunOptions struct {
// The hook to run
Hook *rspec.Hook
// The workdir to change when invoking the hook
Dir string
// The container state data to pass into the hook process
State []byte
// Stdout from the hook process
Stdout io.Writer
// Stderr from the hook process
Stderr io.Writer
// Timeout for waiting process killed
PostKillTimeout time.Duration
}
type RuntimeConfigFilterOptions ¶ added in v0.54.0
type RuntimeConfigFilterOptions struct {
// The hooks to run
Hooks []spec.Hook
// The workdir to change when invoking the hook
Dir string
// The container config spec to pass into the hook processes and potentially get modified by them
Config *spec.Spec
// Timeout for waiting process killed
PostKillTimeout time.Duration
}
Source Files