api

package

Go to main page

Versions in this module

v0

v0.6.2

Dec 16, 2024

Changes in this version

type API

+ func (c *API) CreateHttpClient(timeout time.Duration, baseUrl string, streaming bool) *http.Client

+ func (c *API) GetAPIVersion() string

+ func (c *API) GetCgroupMgr() string

+ func (c *API) IsAppArmorEnabled() bool

+ func (c *API) IsCgroupV2() bool

+ func (c *API) IsDefaultClient() bool

+ func (c *API) IsRootless() bool

+ func (c *API) SetAPIVersion(v string)

+ func (c *API) SetAppArmor(appArmorEnabled bool)

+ func (c *API) SetCgroupMgr(mgr string)

+ func (c *API) SetCgroupV2(isV2 bool)

+ func (c *API) SetClientAsDefault(d bool)

+ func (c *API) SetRootless(isRootless bool)

type ClientConfig

+ DefaultPodman bool

type ContainerBasicConfig

+ LabelsNested bool

type ContainerSecurityConfig

+ Mask []string

+ Unmask []string

v0.6.1

Jul 15, 2024

v0.6.0

Jul 12, 2024

v0.5.2

Feb 5, 2024

v0.5.1

Aug 14, 2023

Changes in this version

+ type Error struct

+ Cause string

+ Message string

+ Response int

v0.5.0

Jul 19, 2023

v0.4.2

Mar 24, 2023

Changes in this version

type ContainerSecurityConfig

+ UserNS Namespace

v0.4.1

Nov 15, 2022

Changes in this version

type API

+ func (c *API) Ping(ctx context.Context) (string, error)

type InspectContainerHostConfig

+ SelinuxOpts []string

v0.4.0

Jul 15, 2022

Changes in this version

+ var ImageNotFound = errors.New("No such Image")

type API

+ func (c *API) ContainerLogs(ctx context.Context, name string, since time.Time, stdout io.Writer, ...) error

+ func (c *API) GetStream(ctx context.Context, path string) (*http.Response, error)

v0.3.0

Jun 22, 2021

Changes in this version

+ func DemuxFrame(r io.Reader, buffer []byte, length int) (frame []byte, err error)

+ func DemuxHeader(r io.Reader, buffer []byte) (fd, sz int, err error)

+ func NewAuthHeader(auth ImageAuthConfig) (string, error)

type API

+ func (c *API) ExecCreate(ctx context.Context, name string, config ExecConfig) (string, error)

+ func (c *API) ExecInspect(ctx context.Context, sessionId string) (InspectExecSession, error)

+ func (c *API) ExecResize(ctx context.Context, execId string, height int, width int) error

+ func (c *API) ExecStart(ctx context.Context, sessionID string, options ExecStartRequest) error

+ func (c *API) ImageInspectID(ctx context.Context, image string) (string, error)

+ func (c *API) ImageLoad(ctx context.Context, path string) (string, error)

+ func (c *API) PostWithHeaders(ctx context.Context, path string, body io.Reader, headers map[string]string) (*http.Response, error)

+ type ExecConfig struct

+ AttachStderr bool

+ AttachStdin bool

+ AttachStdout bool

+ Command []string

+ DetachKeys string

+ Environment map[string]string

+ Privileged bool

+ Tty bool

+ User string

+ WorkDir string

+ type ExecSessionResponse struct

+ ID string

+ type ExecStartRequest struct

+ AttachError bool

+ AttachInput bool

+ AttachOutput bool

+ ResizeCh <-chan drivers.TerminalSize

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ Tty bool

type HostInfo

+ Security SecurityInfo

+ type ImageAuthConfig struct

+ Password string

+ Username string

+ type ImagePullReport struct

+ Error string

+ ID string

+ Images []string

+ Stream string

+ type SecurityInfo struct

+ AppArmorEnabled bool

+ DefaultCapabilities string

+ Rootless bool

+ SECCOMPEnabled bool

+ SELinuxEnabled bool

v0.2.0

Dec 18, 2020

Changes in this version

+ var ContainerNotFound = errors.New("No such Container")

+ var ContainerWrongState = errors.New("Container has wrong state")

+ type API struct

+ func NewClient(logger hclog.Logger, config ClientConfig) *API

+ func (c *API) ContainerCreate(ctx context.Context, create SpecGenerator) (ContainerCreateResponse, error)

+ func (c *API) ContainerDelete(ctx context.Context, name string, force bool, deleteVolumes bool) error

+ func (c *API) ContainerInspect(ctx context.Context, name string) (InspectContainerData, error)

+ func (c *API) ContainerKill(ctx context.Context, name string, signal string) error

+ func (c *API) ContainerStart(ctx context.Context, name string) error

+ func (c *API) ContainerStats(ctx context.Context, name string) (Stats, error)

+ func (c *API) ContainerStop(ctx context.Context, name string, timeout int) error

+ func (c *API) ContainerWait(ctx context.Context, name string, condition string) error

+ func (c *API) Delete(ctx context.Context, path string) (*http.Response, error)

+ func (c *API) Do(req *http.Request) (*http.Response, error)

+ func (c *API) Get(ctx context.Context, path string) (*http.Response, error)

+ func (c *API) ImageExists(ctx context.Context, nameWithTag string) (bool, error)

+ func (c *API) ImagePull(ctx context.Context, nameWithTag string) error

+ func (c *API) Post(ctx context.Context, path string, body io.Reader) (*http.Response, error)

+ func (c *API) SystemInfo(ctx context.Context) (Info, error)

+ type BlkioStatEntry struct

+ Major uint64

+ Minor uint64

+ Op string

+ Value uint64

+ type BlkioStats struct

+ IoMergedRecursive []BlkioStatEntry

+ IoQueuedRecursive []BlkioStatEntry

+ IoServiceBytesRecursive []BlkioStatEntry

+ IoServiceTimeRecursive []BlkioStatEntry

+ IoServicedRecursive []BlkioStatEntry

+ IoTimeRecursive []BlkioStatEntry

+ IoWaitTimeRecursive []BlkioStatEntry

+ SectorsRecursive []BlkioStatEntry

+ type CPUStats struct

+ CPU float64

+ CPUUsage CPUUsage

+ OnlineCPUs uint32

+ SystemUsage uint64

+ ThrottlingData ThrottlingData

+ type CPUUsage struct

+ PercpuUsage []uint64

+ TotalUsage uint64

+ UsageInKernelmode uint64

+ UsageInUsermode uint64

+ type ClientConfig struct

+ HttpTimeout time.Duration

+ SocketPath string

+ func DefaultClientConfig() ClientConfig

+ type ConmonInfo struct

+ Package string

+ Path string

+ Version string

+ type ContainerBasicConfig struct

+ Annotations map[string]string

+ Command []string

+ ConmonPidFile string

+ ContainerCreateCommand []string

+ Entrypoint []string

+ Env map[string]string

+ Hostname string

+ Labels map[string]string

+ LogConfiguration *LogConfig

+ Name string

+ Namespace string

+ OCIRuntime string

+ PidNS Namespace

+ Pod string

+ PreserveFDs uint

+ Remove bool

+ RestartPolicy string

+ RestartRetries *uint

+ SdNotifyMode string

+ Stdin bool

+ StopSignal *syscall.Signal

+ StopTimeout *uint

+ Sysctl map[string]string

+ Systemd string

+ Terminal bool

+ Timezone string

+ UtsNS Namespace

+ type ContainerCgroupConfig struct

+ CgroupNS Namespace

+ CgroupParent string

+ CgroupsMode string

+ type ContainerCreateRequest struct

+ Command []string

+ Entrypoint []string

+ Env map[string]string

+ Name string

+ WorkDir string

+ type ContainerCreateResponse struct

+ Id string

+ Warnings []string

+ type ContainerHealthCheckConfig struct

+ type ContainerNetworkConfig struct

+ CNINetworks []string

+ DNSOptions []string

+ DNSSearch []string

+ DNSServers []net.IP

+ Expose map[uint16]string

+ HostAdd []string

+ NetNS Namespace

+ NetworkOptions map[string][]string

+ PortMappings []PortMapping

+ PublishExposedPorts bool

+ StaticIP *net.IP

+ StaticIPv6 *net.IP

+ StaticMAC *net.HardwareAddr

+ UseImageHosts bool

+ UseImageResolvConf bool

+ type ContainerResourceConfig struct

+ OOMScoreAdj *int

+ ResourceLimits *spec.LinuxResources

+ Rlimits []spec.POSIXRlimit

+ ThrottleReadBpsDevice map[string]spec.LinuxThrottleDevice

+ ThrottleReadIOPSDevice map[string]spec.LinuxThrottleDevice

+ ThrottleWriteBpsDevice map[string]spec.LinuxThrottleDevice

+ ThrottleWriteIOPSDevice map[string]spec.LinuxThrottleDevice

+ WeightDevice map[string]spec.LinuxWeightDevice

+ type ContainerSecurityConfig struct

+ ApparmorProfile string

+ CapAdd []string

+ CapDrop []string

+ Groups []string

+ NoNewPrivileges bool

+ Privileged bool

+ ProcOpts []string

+ ReadOnlyFilesystem bool

+ SeccompPolicy string

+ SeccompProfilePath string

+ SelinuxOpts []string

+ Umask string

+ User string

+ type ContainerStorageConfig struct

+ Devices []spec.LinuxDevice

+ Image string

+ ImageVolumeMode string

+ Init bool

+ InitPath string

+ IpcNS Namespace

+ Mounts []spec.Mount

+ OverlayVolumes []*OverlayVolume

+ Rootfs string

+ RootfsPropagation string

+ ShmSize *int64

+ Volumes []*NamedVolume

+ VolumesFrom []string

+ WorkDir string

+ type ContainerStore struct

+ Number int

+ Paused int

+ Running int

+ Stopped int

+ type DistributionInfo struct

+ Distribution string

+ Version string

+ type HealthCheckLog struct

+ End string

+ ExitCode int

+ Output string

+ Start string

+ type HealthCheckResults struct

+ FailingStreak int

+ Log []HealthCheckLog

+ Status string

+ type HostInfo struct

+ Arch string

+ BuildahVersion string

+ CGroupsVersion string

+ CPUs int

+ CgroupManager string

+ Conmon *ConmonInfo

+ Distribution DistributionInfo

+ EventLogger string

+ Hostname string

+ Kernel string

+ Linkmode string

+ MemFree int64

+ MemTotal int64

+ OCIRuntime *OCIRuntimeInfo

+ OS string

+ RemoteSocket *RemoteSocket

+ Rootless bool

+ RuntimeInfo map[string]interface{}

+ Slirp4NetNS SlirpInfo

+ SwapFree int64

+ SwapTotal int64

+ Uptime string

+ type ImageStore struct

+ Number int

+ type Info struct

+ Host *HostInfo

+ Registries map[string]interface{}

+ Store *StoreInfo

+ Version Version

+ type InspectAdditionalNetwork struct

+ DriverOpts map[string]string

+ IPAMConfig map[string]string

+ Links []string

+ NetworkID string

+ type InspectBasicNetworkConfig struct

+ AdditionalMacAddresses []string

+ EndpointID string

+ Gateway string

+ GlobalIPv6Address string

+ GlobalIPv6PrefixLen int

+ IPAddress string

+ IPPrefixLen int

+ IPv6Gateway string

+ MacAddress string

+ SecondaryIPAddresses []string

+ SecondaryIPv6Addresses []string

+ type InspectBlkioThrottleDevice struct

+ Path string

+ Rate uint64

+ type InspectBlkioWeightDevice struct

+ Path string

+ Weight uint16

+ type InspectContainerConfig struct

+ Annotations map[string]string

+ AttachStderr bool

+ AttachStdin bool

+ AttachStdout bool

+ Cmd []string

+ CreateCommand []string

+ DomainName string

+ Entrypoint string

+ Env []string

+ Hostname string

+ Image string

+ Labels map[string]string

+ OnBuild *string

+ OpenStdin bool

+ StdinOnce bool

+ StopSignal uint

+ SystemdMode bool

+ Timezone string

+ Tty bool

+ Umask string

+ User string

+ Volumes map[string]struct{}

+ WorkingDir string

+ type InspectContainerData struct

+ AppArmorProfile string

+ Args []string

+ BoundingCaps []string

+ Config *InspectContainerConfig

+ ConmonPidFile string

+ Dependencies []string

+ Driver string

+ EffectiveCaps []string

+ ExecIDs []string

+ ExitCommand []string

+ HostConfig *InspectContainerHostConfig

+ HostnamePath string

+ HostsPath string

+ ID string

+ Image string

+ ImageName string

+ IsInfra bool

+ LogPath string

+ LogTag string

+ MountLabel string

+ Mounts []InspectMount

+ Name string

+ Namespace string

+ NetworkSettings *InspectNetworkSettings

+ OCIConfigPath string

+ OCIRuntime string

+ Path string

+ Pod string

+ ProcessLabel string

+ ResolvConfPath string

+ RestartCount int32

+ Rootfs string

+ SizeRootFs int64

+ SizeRw *int64

+ State *InspectContainerState

+ StaticDir string

+ type InspectContainerHostConfig struct

+ AutoRemove bool

+ Binds []string

+ BlkioDeviceReadBps []InspectBlkioThrottleDevice

+ BlkioDeviceReadIOps []InspectBlkioThrottleDevice

+ BlkioDeviceWriteBps []InspectBlkioThrottleDevice

+ BlkioDeviceWriteIOps []InspectBlkioThrottleDevice

+ BlkioWeight uint16

+ BlkioWeightDevice []InspectBlkioWeightDevice

+ CapAdd []string

+ CapDrop []string

+ Cgroup string

+ CgroupMode string

+ CgroupParent string

+ Cgroups string

+ ConsoleSize []uint

+ ContainerIDFile string

+ CpuCount uint64

+ CpuPercent uint64

+ CpuPeriod uint64

+ CpuQuota int64

+ CpuRealtimePeriod uint64

+ CpuRealtimeRuntime int64

+ CpuShares uint64

+ CpusetCpus string

+ CpusetMems string

+ Devices []InspectDevice

+ DiskQuota uint64

+ Dns []string

+ DnsOptions []string

+ DnsSearch []string

+ ExtraHosts []string

+ GroupAdd []string

+ IOMaximumBandwidth uint64

+ IOMaximumIOps uint64

+ Init bool

+ IpcMode string

+ Isolation string

+ KernelMemory int64

+ Links []string

+ LogConfig *InspectLogConfig

+ Memory int64

+ MemoryReservation int64

+ MemorySwap int64

+ MemorySwappiness int64

+ NanoCpus int64

+ NetworkMode string

+ OomKillDisable bool

+ OomScoreAdj int

+ PidMode string

+ PidsLimit int64

+ PortBindings map[string][]InspectHostPort

+ Privileged bool

+ PublishAllPorts bool

+ ReadonlyRootfs bool

+ RestartPolicy *InspectRestartPolicy

+ Runtime string

+ SecurityOpt []string

+ ShmSize int64

+ Tmpfs map[string]string

+ UTSMode string

+ Ulimits []InspectUlimit

+ UsernsMode string

+ VolumeDriver string

+ VolumesFrom []string

+ type InspectContainerState struct

+ ConmonPid int

+ Dead bool

+ Error string

+ ExitCode int32

+ FinishedAt time.Time

+ Healthcheck HealthCheckResults

+ OOMKilled bool

+ OciVersion string

+ Paused bool

+ Pid int

+ Restarting bool

+ Running bool

+ StartedAt time.Time

+ Status string

+ type InspectDevice struct

+ CgroupPermissions string

+ PathInContainer string

+ PathOnHost string

+ type InspectExecProcess struct

+ Arguments []string

+ Entrypoint []string

+ Privileged bool

+ Tty bool

+ User string

+ type InspectExecSession struct

+ CanRemove bool

+ ContainerID string

+ DetachKeys string

+ ExitCode int

+ ID string

+ OpenStderr bool

+ OpenStdin bool

+ OpenStdout bool

+ Pid int

+ ProcessConfig *InspectExecProcess

+ Running bool

+ type InspectHostPort struct

+ HostIP string

+ HostPort string

+ type InspectLogConfig struct

+ Config map[string]string

+ Type string

+ type InspectMount struct

+ Destination string

+ Driver string

+ Mode string

+ Name string

+ Options []string

+ Propagation string

+ RW bool

+ Source string

+ Type string

+ type InspectNetworkSettings struct

+ Bridge string

+ HairpinMode bool

+ LinkLocalIPv6Address string

+ LinkLocalIPv6PrefixLen int

+ Networks map[string]*InspectAdditionalNetwork

+ Ports map[string][]InspectHostPort

+ SandboxID string

+ SandboxKey string

+ type InspectRestartPolicy struct

+ MaximumRetryCount uint

+ Name string

+ type InspectUlimit struct

+ Hard uint64

+ Name string

+ Soft uint64

+ type LogConfig struct

+ Driver string

+ Options map[string]string

+ Path string

+ type MemoryStats struct

+ Commit uint64

+ CommitPeak uint64

+ Failcnt uint64

+ Limit uint64

+ MaxUsage uint64

+ PrivateWorkingSet uint64

+ Stats map[string]uint64

+ Usage uint64

+ type NamedVolume struct

+ Dest string

+ Name string

+ Options []string

+ type Namespace struct

+ NSMode NamespaceMode

+ Value string

+ type NamespaceMode string

+ const Auto

+ const Bridge

+ const Default

+ const DefaultKernelNamespaces

+ const FromContainer

+ const FromPod

+ const Host

+ const KeepID

+ const NoNetwork

+ const Path

+ const Private

+ const Slirp

+ type OCIRuntimeInfo struct

+ Name string

+ Package string

+ Path string

+ Version string

+ type OverlayVolume struct

+ Destination string

+ Source string

+ type PidsStats struct

+ Current uint64

+ Limit uint64

+ type PortMapping struct

+ ContainerPort uint16

+ HostIP string

+ HostPort uint16

+ Protocol string

+ Range uint16

+ type RemoteSocket struct

+ Exists bool

+ Path string

+ type SlirpInfo struct

+ Executable string

+ Package string

+ Version string

+ type SpecGenerator struct

+ type Stats struct

+ BlkioStats BlkioStats

+ CPUStats CPUStats

+ MemoryStats MemoryStats

+ PidsStats PidsStats

+ PreCPUStats CPUStats

+ PreRead time.Time

+ Read time.Time

+ type StoreInfo struct

+ ConfigFile string

+ ContainerStore ContainerStore

+ GraphDriverName string

+ GraphOptions map[string]interface{}

+ GraphRoot string

+ GraphStatus map[string]string

+ ImageStore ImageStore

+ RunRoot string

+ VolumePath string

+ type ThrottlingData struct

+ Periods uint64

+ ThrottledPeriods uint64

+ ThrottledTime uint64

+ type Version struct

+ APIVersion string

+ Built int64

+ BuiltTime string

+ GitCommit string

+ GoVersion string

+ OsArch string

+ Version string

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