tunnel

package
v5.4.0 Latest Latest
Warning

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

Go to latest
Published: Feb 11, 2025 License: Apache-2.0 Imports: 46 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ArtifactAdd added in v5.4.0

func ArtifactAdd(ctx context.Context, path, name string, opts entities.ArtifactAddOptions) error

Types

type ContainerEngine

type ContainerEngine struct {
	ClientCtx context.Context
}

Container-related runtime using an ssh-tunnel to utilize Podman service

func (*ContainerEngine) AutoUpdate

func (*ContainerEngine) Config

func (ic *ContainerEngine) Config(_ context.Context) (*config.Config, error)

func (*ContainerEngine) ContainerAttach

func (ic *ContainerEngine) ContainerAttach(ctx context.Context, nameOrID string, opts entities.AttachOptions) error

func (*ContainerEngine) ContainerCheckpoint

func (ic *ContainerEngine) ContainerCheckpoint(ctx context.Context, namesOrIds []string, opts entities.CheckpointOptions) ([]*entities.CheckpointReport, error)

func (*ContainerEngine) ContainerCleanup

func (ic *ContainerEngine) ContainerCleanup(ctx context.Context, namesOrIds []string, options entities.ContainerCleanupOptions) ([]*entities.ContainerCleanupReport, error)

func (*ContainerEngine) ContainerClone

func (*ContainerEngine) ContainerCommit

func (ic *ContainerEngine) ContainerCommit(ctx context.Context, nameOrID string, opts entities.CommitOptions) (*entities.CommitReport, error)

func (*ContainerEngine) ContainerCopyFromArchive

func (ic *ContainerEngine) ContainerCopyFromArchive(ctx context.Context, nameOrID, path string, reader io.Reader, options entities.CopyOptions) (entities.ContainerCopyFunc, error)

func (*ContainerEngine) ContainerCopyToArchive

func (ic *ContainerEngine) ContainerCopyToArchive(ctx context.Context, nameOrID string, path string, writer io.Writer) (entities.ContainerCopyFunc, error)

func (*ContainerEngine) ContainerCreate

func (*ContainerEngine) ContainerExec

func (ic *ContainerEngine) ContainerExec(ctx context.Context, nameOrID string, options entities.ExecOptions, streams define.AttachStreams) (exitCode int, retErr error)

func (*ContainerEngine) ContainerExecDetached

func (ic *ContainerEngine) ContainerExecDetached(ctx context.Context, nameOrID string, options entities.ExecOptions) (retSessionID string, retErr error)

func (*ContainerEngine) ContainerExists

func (ic *ContainerEngine) ContainerExists(ctx context.Context, nameOrID string, options entities.ContainerExistsOptions) (*entities.BoolReport, error)

func (*ContainerEngine) ContainerExport

func (ic *ContainerEngine) ContainerExport(ctx context.Context, nameOrID string, options entities.ContainerExportOptions) error

func (*ContainerEngine) ContainerInit

func (ic *ContainerEngine) ContainerInit(ctx context.Context, namesOrIds []string, options entities.ContainerInitOptions) ([]*entities.ContainerInitReport, error)

func (*ContainerEngine) ContainerInspect

func (ic *ContainerEngine) ContainerInspect(ctx context.Context, namesOrIds []string, opts entities.InspectOptions) ([]*entities.ContainerInspectReport, []error, error)

func (*ContainerEngine) ContainerKill

func (ic *ContainerEngine) ContainerKill(ctx context.Context, namesOrIds []string, opts entities.KillOptions) ([]*entities.KillReport, error)

func (*ContainerEngine) ContainerList

func (*ContainerEngine) ContainerListExternal

func (ic *ContainerEngine) ContainerListExternal(ctx context.Context) ([]entities.ListContainer, error)

func (*ContainerEngine) ContainerLogs

func (ic *ContainerEngine) ContainerLogs(_ context.Context, nameOrIDs []string, opts entities.ContainerLogsOptions) error

func (*ContainerEngine) ContainerMount

func (ic *ContainerEngine) ContainerMount(ctx context.Context, nameOrIDs []string, options entities.ContainerMountOptions) ([]*entities.ContainerMountReport, error)

func (*ContainerEngine) ContainerPause

func (ic *ContainerEngine) ContainerPause(ctx context.Context, namesOrIds []string, options entities.PauseUnPauseOptions) ([]*entities.PauseUnpauseReport, error)

func (*ContainerEngine) ContainerPort

func (ic *ContainerEngine) ContainerPort(ctx context.Context, nameOrID string, options entities.ContainerPortOptions) ([]*entities.ContainerPortReport, error)

func (*ContainerEngine) ContainerPrune

func (*ContainerEngine) ContainerRename

func (ic *ContainerEngine) ContainerRename(ctx context.Context, nameOrID string, opts entities.ContainerRenameOptions) error

ContainerRename renames the given container.

func (*ContainerEngine) ContainerRestart

func (ic *ContainerEngine) ContainerRestart(ctx context.Context, namesOrIds []string, opts entities.RestartOptions) ([]*entities.RestartReport, error)

func (*ContainerEngine) ContainerRestore

func (ic *ContainerEngine) ContainerRestore(ctx context.Context, namesOrIds []string, opts entities.RestoreOptions) ([]*entities.RestoreReport, error)

func (*ContainerEngine) ContainerRm

func (ic *ContainerEngine) ContainerRm(ctx context.Context, namesOrIds []string, opts entities.RmOptions) ([]*reports.RmReport, error)

func (*ContainerEngine) ContainerRun

func (*ContainerEngine) ContainerRunlabel

func (ic *ContainerEngine) ContainerRunlabel(ctx context.Context, label string, image string, args []string, options entities.ContainerRunlabelOptions) error

func (*ContainerEngine) ContainerStart

func (ic *ContainerEngine) ContainerStart(ctx context.Context, namesOrIds []string, options entities.ContainerStartOptions) ([]*entities.ContainerStartReport, error)

func (*ContainerEngine) ContainerStat

func (ic *ContainerEngine) ContainerStat(ctx context.Context, nameOrID string, path string) (*entities.ContainerStatReport, error)

func (*ContainerEngine) ContainerStats

func (ic *ContainerEngine) ContainerStats(ctx context.Context, namesOrIds []string, options entities.ContainerStatsOptions) (statsChan chan entities.ContainerStatsReport, err error)

func (*ContainerEngine) ContainerStop

func (ic *ContainerEngine) ContainerStop(ctx context.Context, namesOrIds []string, opts entities.StopOptions) ([]*entities.StopReport, error)

func (*ContainerEngine) ContainerTop

func (*ContainerEngine) ContainerUnmount

func (ic *ContainerEngine) ContainerUnmount(ctx context.Context, nameOrIDs []string, options entities.ContainerUnmountOptions) ([]*entities.ContainerUnmountReport, error)

func (*ContainerEngine) ContainerUnpause

func (ic *ContainerEngine) ContainerUnpause(ctx context.Context, namesOrIds []string, options entities.PauseUnPauseOptions) ([]*entities.PauseUnpauseReport, error)

func (*ContainerEngine) ContainerUpdate

func (ic *ContainerEngine) ContainerUpdate(ctx context.Context, updateOptions *entities.ContainerUpdateOptions) (string, error)

ContainerUpdate finds and updates the given container's cgroup config with the specified options

func (*ContainerEngine) ContainerWait

func (ic *ContainerEngine) ContainerWait(ctx context.Context, namesOrIds []string, opts entities.WaitOptions) ([]entities.WaitReport, error)

func (*ContainerEngine) Diff

func (ic *ContainerEngine) Diff(ctx context.Context, namesOrIDs []string, opts entities.DiffOptions) (*entities.DiffReport, error)

func (*ContainerEngine) Events

func (*ContainerEngine) GenerateKube

func (ic *ContainerEngine) GenerateKube(ctx context.Context, nameOrIDs []string, opts entities.GenerateKubeOptions) (*entities.GenerateKubeReport, error)

GenerateKube Kubernetes YAML (v1 specification) for nameOrIDs

Note: Caller is responsible for closing returned Reader

func (*ContainerEngine) GenerateSpec

func (*ContainerEngine) GenerateSystemd

func (*ContainerEngine) HealthCheckRun

func (ic *ContainerEngine) HealthCheckRun(ctx context.Context, nameOrID string, options entities.HealthCheckOptions) (*define.HealthCheckResults, error)

func (*ContainerEngine) Info

func (ic *ContainerEngine) Info(ctx context.Context) (*define.Info, error)

func (*ContainerEngine) KubeApply

func (ic *ContainerEngine) KubeApply(ctx context.Context, body io.Reader, opts entities.ApplyOptions) error

func (*ContainerEngine) Locks

func (*ContainerEngine) Migrate

func (*ContainerEngine) NetworkConnect

func (ic *ContainerEngine) NetworkConnect(ctx context.Context, networkname string, opts entities.NetworkConnectOptions) error

NetworkConnect removes a container from a given network

func (*ContainerEngine) NetworkCreate

func (ic *ContainerEngine) NetworkCreate(ctx context.Context, net types.Network, createOptions *types.NetworkCreateOptions) (*types.Network, error)

func (*ContainerEngine) NetworkDisconnect

func (ic *ContainerEngine) NetworkDisconnect(ctx context.Context, networkname string, opts entities.NetworkDisconnectOptions) error

NetworkDisconnect removes a container from a given network

func (*ContainerEngine) NetworkExists

func (ic *ContainerEngine) NetworkExists(ctx context.Context, networkname string) (*entities.BoolReport, error)

NetworkExists checks if the given network exists

func (*ContainerEngine) NetworkInspect

func (ic *ContainerEngine) NetworkInspect(ctx context.Context, namesOrIds []string, opts entities.InspectOptions) ([]entities.NetworkInspectReport, []error, error)

func (*ContainerEngine) NetworkList

func (ic *ContainerEngine) NetworkList(ctx context.Context, opts entities.NetworkListOptions) ([]types.Network, error)

func (*ContainerEngine) NetworkPrune

Network prune removes unused networks

func (*ContainerEngine) NetworkReload

func (*ContainerEngine) NetworkRm

func (ic *ContainerEngine) NetworkRm(ctx context.Context, namesOrIds []string, opts entities.NetworkRmOptions) ([]*entities.NetworkRmReport, error)

func (*ContainerEngine) NetworkUpdate

func (ic *ContainerEngine) NetworkUpdate(ctx context.Context, netName string, opts entities.NetworkUpdateOptions) error

func (*ContainerEngine) PlayKube

func (*ContainerEngine) PlayKubeDown

func (*ContainerEngine) PodClone

func (*ContainerEngine) PodCreate

func (*ContainerEngine) PodExists

func (ic *ContainerEngine) PodExists(ctx context.Context, nameOrID string) (*entities.BoolReport, error)

func (*ContainerEngine) PodInspect

func (ic *ContainerEngine) PodInspect(ctx context.Context, namesOrIDs []string, options entities.InspectOptions) ([]*entities.PodInspectReport, []error, error)

func (*ContainerEngine) PodKill

func (ic *ContainerEngine) PodKill(ctx context.Context, namesOrIds []string, opts entities.PodKillOptions) ([]*entities.PodKillReport, error)

func (*ContainerEngine) PodLogs

func (ic *ContainerEngine) PodLogs(ctx context.Context, nameOrIDs string, options entities.PodLogsOptions) error

func (*ContainerEngine) PodPause

func (ic *ContainerEngine) PodPause(ctx context.Context, namesOrIds []string, options entities.PodPauseOptions) ([]*entities.PodPauseReport, error)

func (*ContainerEngine) PodPrune

func (*ContainerEngine) PodPs

func (*ContainerEngine) PodRestart

func (ic *ContainerEngine) PodRestart(ctx context.Context, namesOrIds []string, options entities.PodRestartOptions) ([]*entities.PodRestartReport, error)

func (*ContainerEngine) PodRm

func (ic *ContainerEngine) PodRm(ctx context.Context, namesOrIds []string, opts entities.PodRmOptions) ([]*entities.PodRmReport, error)

func (*ContainerEngine) PodStart

func (ic *ContainerEngine) PodStart(ctx context.Context, namesOrIds []string, options entities.PodStartOptions) ([]*entities.PodStartReport, error)

func (*ContainerEngine) PodStats

func (ic *ContainerEngine) PodStats(ctx context.Context, namesOrIds []string, opts entities.PodStatsOptions) ([]*entities.PodStatsReport, error)

func (*ContainerEngine) PodStop

func (ic *ContainerEngine) PodStop(ctx context.Context, namesOrIds []string, opts entities.PodStopOptions) ([]*entities.PodStopReport, error)

func (*ContainerEngine) PodTop

func (*ContainerEngine) PodUnpause

func (ic *ContainerEngine) PodUnpause(ctx context.Context, namesOrIds []string, options entities.PodunpauseOptions) ([]*entities.PodUnpauseReport, error)

func (*ContainerEngine) Renumber

func (ic *ContainerEngine) Renumber(ctx context.Context) error

func (*ContainerEngine) Reset

func (ic *ContainerEngine) Reset(ctx context.Context) error

func (*ContainerEngine) SecretCreate

func (ic *ContainerEngine) SecretCreate(ctx context.Context, name string, reader io.Reader, options entities.SecretCreateOptions) (*entities.SecretCreateReport, error)

func (*ContainerEngine) SecretExists

func (ic *ContainerEngine) SecretExists(ctx context.Context, nameOrID string) (*entities.BoolReport, error)

func (*ContainerEngine) SecretInspect

func (ic *ContainerEngine) SecretInspect(ctx context.Context, nameOrIDs []string, options entities.SecretInspectOptions) ([]*entities.SecretInfoReport, []error, error)

func (*ContainerEngine) SecretList

func (*ContainerEngine) SecretRm

func (ic *ContainerEngine) SecretRm(ctx context.Context, nameOrIDs []string, options entities.SecretRmOptions) ([]*entities.SecretRmReport, error)

func (*ContainerEngine) SetupRootless

func (ic *ContainerEngine) SetupRootless(_ context.Context, noMoveProcess bool, cgroupMode string) error

func (*ContainerEngine) ShouldRestart

func (ic *ContainerEngine) ShouldRestart(_ context.Context, id string) (bool, error)

ShouldRestart reports back whether the container will restart.

func (*ContainerEngine) Shutdown

func (ic *ContainerEngine) Shutdown(_ context.Context)

Shutdown Libpod engine.

func (*ContainerEngine) SystemCheck added in v5.2.0

func (*ContainerEngine) SystemDf

func (*ContainerEngine) SystemPrune

SystemPrune prunes unused data from the system.

func (*ContainerEngine) Unshare

func (ic *ContainerEngine) Unshare(ctx context.Context, args []string, options entities.SystemUnshareOptions) error

func (*ContainerEngine) Version

func (*ContainerEngine) VolumeCreate

func (*ContainerEngine) VolumeExists

func (ic *ContainerEngine) VolumeExists(ctx context.Context, nameOrID string) (*entities.BoolReport, error)

VolumeExists checks if the given volume exists

func (*ContainerEngine) VolumeInspect

func (ic *ContainerEngine) VolumeInspect(ctx context.Context, namesOrIds []string, opts entities.InspectOptions) ([]*entities.VolumeInspectReport, []error, error)

func (*ContainerEngine) VolumeList

func (*ContainerEngine) VolumeMount

func (ic *ContainerEngine) VolumeMount(ctx context.Context, nameOrIDs []string) ([]*entities.VolumeMountReport, error)

func (*ContainerEngine) VolumeMounted

func (ic *ContainerEngine) VolumeMounted(ctx context.Context, nameOrID string) (*entities.BoolReport, error)

Volumemounted check if a given volume using plugin or filesystem is mounted or not. TODO: Not used and exposed to tunnel. Will be used by `export` command which is unavailable to `podman-remote`

func (*ContainerEngine) VolumePrune

func (*ContainerEngine) VolumeReload

func (ic *ContainerEngine) VolumeReload(ctx context.Context) (*entities.VolumeReloadReport, error)

func (*ContainerEngine) VolumeRm

func (ic *ContainerEngine) VolumeRm(ctx context.Context, namesOrIds []string, opts entities.VolumeRmOptions) ([]*entities.VolumeRmReport, error)

func (*ContainerEngine) VolumeUnmount

func (ic *ContainerEngine) VolumeUnmount(ctx context.Context, nameOrIDs []string) ([]*entities.VolumeUnmountReport, error)

type FarmNode

type FarmNode struct {
	NodeName string
	// contains filtered or unexported fields
}

type ImageEngine

type ImageEngine struct {
	ClientCtx context.Context
	FarmNode
}

Image-related runtime using an ssh-tunnel to utilize Podman service

func (*ImageEngine) ArtifactAdd added in v5.4.0

func (ir *ImageEngine) ArtifactAdd(ctx context.Context, name string, paths []string, opts *entities.ArtifactAddOptions) (*entities.ArtifactAddReport, error)

func (*ImageEngine) ArtifactInspect added in v5.4.0

func (*ImageEngine) ArtifactList added in v5.4.0

func (*ImageEngine) ArtifactPull added in v5.4.0

func (*ImageEngine) ArtifactPush added in v5.4.0

func (*ImageEngine) ArtifactRm added in v5.4.0

func (*ImageEngine) Build

func (ir *ImageEngine) Build(_ context.Context, containerFiles []string, opts entities.BuildOptions) (*entities.BuildReport, error)

func (*ImageEngine) Config

func (ir *ImageEngine) Config(_ context.Context) (*config.Config, error)

func (*ImageEngine) Exists

func (ir *ImageEngine) Exists(_ context.Context, nameOrID string) (*entities.BoolReport, error)

func (*ImageEngine) FarmNodeDriver

func (ir *ImageEngine) FarmNodeDriver(ctx context.Context) string

FarmNodeDriver returns a description of the image builder driver

func (*ImageEngine) FarmNodeInspect

func (ir *ImageEngine) FarmNodeInspect(ctx context.Context) (*entities.FarmInspectReport, error)

FarmNodeInspect returns information about the remote engines in the farm

func (*ImageEngine) FarmNodeName

func (ir *ImageEngine) FarmNodeName(ctx context.Context) string

FarmNodeName returns the remote engine's name.

func (*ImageEngine) History

func (*ImageEngine) Import

func (*ImageEngine) Inspect

func (ir *ImageEngine) Inspect(ctx context.Context, namesOrIDs []string, opts entities.InspectOptions) ([]*entities.ImageInspectReport, []error, error)

func (*ImageEngine) List

func (*ImageEngine) Load

func (*ImageEngine) ManifestAdd

func (ir *ImageEngine) ManifestAdd(_ context.Context, name string, imageNames []string, opts entities.ManifestAddOptions) (string, error)

ManifestAdd adds images to the manifest list

func (*ImageEngine) ManifestAddArtifact

func (ir *ImageEngine) ManifestAddArtifact(_ context.Context, name string, files []string, opts entities.ManifestAddArtifactOptions) (string, error)

ManifestAddArtifact creates artifact manifests and adds them to the manifest list

func (*ImageEngine) ManifestAnnotate

func (ir *ImageEngine) ManifestAnnotate(ctx context.Context, name, images string, opts entities.ManifestAnnotateOptions) (string, error)

ManifestAnnotate updates an entry of the manifest list

func (*ImageEngine) ManifestCreate

func (ir *ImageEngine) ManifestCreate(ctx context.Context, name string, images []string, opts entities.ManifestCreateOptions) (string, error)

ManifestCreate implements manifest create via ImageEngine

func (*ImageEngine) ManifestExists

func (ir *ImageEngine) ManifestExists(ctx context.Context, name string) (*entities.BoolReport, error)

ManifestExists checks if a manifest list with the given name exists

func (*ImageEngine) ManifestInspect

ManifestInspect returns contents of manifest list with given name

func (*ImageEngine) ManifestListClear

func (ir *ImageEngine) ManifestListClear(ctx context.Context, name string) (string, error)

ManifestListClear clears out all instances from a manifest list

func (*ImageEngine) ManifestPush

func (ir *ImageEngine) ManifestPush(ctx context.Context, name, destination string, opts entities.ImagePushOptions) (string, error)

ManifestPush pushes a manifest list or image index to the destination

func (*ImageEngine) ManifestRemoveDigest

func (ir *ImageEngine) ManifestRemoveDigest(ctx context.Context, name string, image string) (string, error)

ManifestRemoveDigest removes the digest from manifest list

func (*ImageEngine) ManifestRm

func (ir *ImageEngine) ManifestRm(ctx context.Context, names []string, opts entities.ImageRemoveOptions) (report *entities.ImageRemoveReport, rmErrors []error)

ManifestRm removes the specified manifest list from storage

func (*ImageEngine) Mount

func (ir *ImageEngine) Mount(ctx context.Context, images []string, options entities.ImageMountOptions) ([]*entities.ImageMountReport, error)

func (*ImageEngine) Prune

func (*ImageEngine) Pull

func (*ImageEngine) Push

func (ir *ImageEngine) Push(ctx context.Context, source string, destination string, opts entities.ImagePushOptions) (*entities.ImagePushReport, error)

func (*ImageEngine) Remove

func (ir *ImageEngine) Remove(ctx context.Context, imagesArg []string, opts entities.ImageRemoveOptions) (*entities.ImageRemoveReport, []error)

func (*ImageEngine) Save

func (ir *ImageEngine) Save(ctx context.Context, nameOrID string, tags []string, opts entities.ImageSaveOptions) error

func (*ImageEngine) Scp

func (*ImageEngine) Search

func (*ImageEngine) SetTrust

func (ir *ImageEngine) SetTrust(ctx context.Context, args []string, options entities.SetTrustOptions) error

func (*ImageEngine) ShowTrust

func (ir *ImageEngine) ShowTrust(ctx context.Context, args []string, options entities.ShowTrustOptions) (*entities.ShowTrustReport, error)

func (*ImageEngine) Shutdown

func (ir *ImageEngine) Shutdown(_ context.Context)

Shutdown Libpod engine

func (*ImageEngine) Sign

func (ir *ImageEngine) Sign(ctx context.Context, names []string, options entities.SignOptions) (*entities.SignReport, error)

func (*ImageEngine) Tag

func (ir *ImageEngine) Tag(ctx context.Context, nameOrID string, tags []string, opt entities.ImageTagOptions) error

func (*ImageEngine) Tree

func (*ImageEngine) Unmount

func (*ImageEngine) Untag

func (ir *ImageEngine) Untag(ctx context.Context, nameOrID string, tags []string, opt entities.ImageUntagOptions) error

type SystemEngine

type SystemEngine struct {
	ClientCtx context.Context
}

Container-related runtime using an ssh-tunnel to utilize Podman service

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL