Documentation
¶
Index ¶
- Constants
- type IgniteRuntime
- func (*IgniteRuntime) CheckConnection(_ context.Context) error
- func (c *IgniteRuntime) Config() clabruntime.RuntimeConfig
- func (*IgniteRuntime) CreateContainer(_ context.Context, node *clabtypes.NodeConfig) (string, error)
- func (c *IgniteRuntime) CreateNet(ctx context.Context) error
- func (c *IgniteRuntime) DeleteContainer(ctx context.Context, containerID string) error
- func (c *IgniteRuntime) DeleteNet(ctx context.Context) error
- func (*IgniteRuntime) Exec(_ context.Context, _ string, _ *clabexec.ExecCmd) (*clabexec.ExecResult, error)
- func (*IgniteRuntime) ExecNotWait(_ context.Context, _ string, _ *clabexec.ExecCmd) error
- func (c *IgniteRuntime) GetContainer(_ context.Context, containerID string) (*clabruntime.GenericContainer, error)
- func (*IgniteRuntime) GetContainerStatus(_ context.Context, containerID string) clabruntime.ContainerStatus
- func (*IgniteRuntime) GetCooCBindMounts() clabtypes.Binds
- func (*IgniteRuntime) GetHostsPath(context.Context, string) (string, error)
- func (c *IgniteRuntime) GetNSPath(ctx context.Context, vmName string) (string, error)
- func (*IgniteRuntime) GetName() string
- func (*IgniteRuntime) GetRuntimeSocket() (string, error)
- func (c *IgniteRuntime) Init(opts ...clabruntime.RuntimeOption) error
- func (*IgniteRuntime) InspectImage(ctx context.Context, imageName string) (*clabruntime.ImageInspect, error)
- func (*IgniteRuntime) IsHealthy(_ context.Context, _ string) (bool, error)
- func (c *IgniteRuntime) ListContainers(_ context.Context, gfilters []*clabtypes.GenericFilter) ([]clabruntime.GenericContainer, error)
- func (c *IgniteRuntime) Mgmt() *clabtypes.MgmtNet
- func (*IgniteRuntime) PauseContainer(_ context.Context, cID string) error
- func (*IgniteRuntime) PullImage(_ context.Context, imageName string, _ clabtypes.PullPolicyValue) error
- func (c *IgniteRuntime) StartContainer(ctx context.Context, _ string, node clabruntime.Node) (any, error)
- func (*IgniteRuntime) StopContainer(_ context.Context, _ string) error
- func (*IgniteRuntime) StreamEvents(context.Context, clabruntime.EventStreamOptions) (<-chan clabruntime.ContainerEvent, <-chan error, error)
- func (*IgniteRuntime) StreamLogs(ctx context.Context, containerName string) (io.ReadCloser, error)
- func (*IgniteRuntime) UnpauseContainer(_ context.Context, cID string) error
- func (c *IgniteRuntime) WithConfig(cfg *clabruntime.RuntimeConfig)
- func (c *IgniteRuntime) WithKeepMgmtNet()
- func (c *IgniteRuntime) WithMgmtNet(n *clabtypes.MgmtNet)
- func (*IgniteRuntime) WriteToStdinNoWait(_ context.Context, cID string, data []byte) error
Constants ¶
View Source
const (
RuntimeName = "ignite"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type IgniteRuntime ¶
type IgniteRuntime struct {
// contains filtered or unexported fields
}
func (*IgniteRuntime) CheckConnection ¶ added in v0.63.0
func (*IgniteRuntime) CheckConnection(_ context.Context) error
func (*IgniteRuntime) Config ¶
func (c *IgniteRuntime) Config() clabruntime.RuntimeConfig
func (*IgniteRuntime) CreateContainer ¶
func (*IgniteRuntime) CreateContainer( _ context.Context, node *clabtypes.NodeConfig, ) (string, error)
func (*IgniteRuntime) DeleteContainer ¶
func (c *IgniteRuntime) DeleteContainer(ctx context.Context, containerID string) error
func (*IgniteRuntime) Exec ¶
func (*IgniteRuntime) Exec( _ context.Context, _ string, _ *clabexec.ExecCmd, ) (*clabexec.ExecResult, error)
func (*IgniteRuntime) ExecNotWait ¶
func (*IgniteRuntime) GetContainer ¶
func (c *IgniteRuntime) GetContainer( _ context.Context, containerID string, ) (*clabruntime.GenericContainer, error)
func (*IgniteRuntime) GetContainerStatus ¶ added in v0.32.0
func (*IgniteRuntime) GetContainerStatus( _ context.Context, containerID string, ) clabruntime.ContainerStatus
GetContainerStatus retrieves the ContainerStatus of the named container.
func (*IgniteRuntime) GetCooCBindMounts ¶ added in v0.69.0
func (*IgniteRuntime) GetCooCBindMounts() clabtypes.Binds
func (*IgniteRuntime) GetHostsPath ¶ added in v0.27.0
GetHostsPath returns fs path to a file which is mounted as /etc/hosts into a given container no-op for ignite.
func (*IgniteRuntime) GetName ¶
func (*IgniteRuntime) GetName() string
func (*IgniteRuntime) GetRuntimeSocket ¶ added in v0.69.0
func (*IgniteRuntime) GetRuntimeSocket() (string, error)
func (*IgniteRuntime) Init ¶
func (c *IgniteRuntime) Init(opts ...clabruntime.RuntimeOption) error
func (*IgniteRuntime) InspectImage ¶ added in v0.72.0
func (*IgniteRuntime) InspectImage( ctx context.Context, imageName string, ) (*clabruntime.ImageInspect, error)
func (*IgniteRuntime) IsHealthy ¶ added in v0.51.0
IsHealthy returns true is the container is reported as being healthy, false otherwise.
func (*IgniteRuntime) ListContainers ¶
func (c *IgniteRuntime) ListContainers( _ context.Context, gfilters []*clabtypes.GenericFilter, ) ([]clabruntime.GenericContainer, error)
func (*IgniteRuntime) Mgmt ¶
func (c *IgniteRuntime) Mgmt() *clabtypes.MgmtNet
func (*IgniteRuntime) PauseContainer ¶ added in v0.26.0
func (*IgniteRuntime) PauseContainer(_ context.Context, cID string) error
func (*IgniteRuntime) PullImage ¶ added in v0.36.0
func (*IgniteRuntime) PullImage( _ context.Context, imageName string, _ clabtypes.PullPolicyValue, ) error
PullImage pulls the provided image name if it does not exist. Ignite does ignore the pullPolicy though.
func (*IgniteRuntime) StartContainer ¶
func (c *IgniteRuntime) StartContainer( ctx context.Context, _ string, node clabruntime.Node, ) (any, error)
StartContainer starts a container with the provided node configuration. skipcq: GO-R1005
func (*IgniteRuntime) StopContainer ¶
func (*IgniteRuntime) StopContainer(_ context.Context, _ string) error
func (*IgniteRuntime) StreamEvents ¶ added in v0.72.0
func (*IgniteRuntime) StreamEvents( context.Context, clabruntime.EventStreamOptions, ) (<-chan clabruntime.ContainerEvent, <-chan error, error)
func (*IgniteRuntime) StreamLogs ¶ added in v0.71.0
func (*IgniteRuntime) StreamLogs(ctx context.Context, containerName string) (io.ReadCloser, error)
func (*IgniteRuntime) UnpauseContainer ¶ added in v0.26.0
func (*IgniteRuntime) UnpauseContainer(_ context.Context, cID string) error
func (*IgniteRuntime) WithConfig ¶
func (c *IgniteRuntime) WithConfig(cfg *clabruntime.RuntimeConfig)
func (*IgniteRuntime) WithKeepMgmtNet ¶
func (c *IgniteRuntime) WithKeepMgmtNet()
func (*IgniteRuntime) WithMgmtNet ¶
func (c *IgniteRuntime) WithMgmtNet(n *clabtypes.MgmtNet)
func (*IgniteRuntime) WriteToStdinNoWait ¶ added in v0.61.0
Click to show internal directories.
Click to hide internal directories.