Documentation
¶
Index ¶
- type Client
- func (c *Client) AutoUpdate(ctx context.Context, opts podmantypes.AutoUpdateOptions) (podmantypes.AutoUpdateResult, error)
- func (c *Client) ContainerList(ctx context.Context, labels, pods []string) ([]podmantypes.Container, error)
- func (c *Client) Info(ctx context.Context) (podmantypes.Info, error)
- func (c *Client) KubeDown(ctx context.Context, req podmantypes.KubeDownRequest) (podmantypes.KubeDownReport, error)
- func (c *Client) KubeGenerate(ctx context.Context, req podmantypes.KubeGenerateRequest) (string, error)
- func (c *Client) KubePlay(ctx context.Context, req podmantypes.KubePlayRequest) (podmantypes.KubePlayReport, error)
- func (c *Client) PodAction(ctx context.Context, nameOrID string, action PodAction, opts PodActionOptions) error
- func (c *Client) PodCreate(ctx context.Context, spec PodSpec) (string, error)
- func (c *Client) PodInspect(ctx context.Context, nameOrID string) (podmantypes.PodInspect, error)
- func (c *Client) PodList(ctx context.Context, filters map[string][]string) ([]podmantypes.Pod, error)
- func (c *Client) PodPrune(ctx context.Context) ([]podmantypes.PodPruneReport, error)
- func (c *Client) PodRemove(ctx context.Context, nameOrID string, force bool) error
- func (c *Client) PodStats(ctx context.Context, namesOrIDs []string) ([]podmantypes.PodStats, error)
- func (c *Client) PodTop(ctx context.Context, nameOrID, psArgs string) (podmantypes.PodTop, error)
- func (c *Client) QuadletFile(ctx context.Context, name string) (string, error)
- func (c *Client) QuadletInstall(ctx context.Context, opts QuadletInstallOptions) (podmantypes.QuadletInstallReport, error)
- func (c *Client) QuadletList(ctx context.Context, filters map[string][]string) ([]podmantypes.Quadlet, error)
- func (c *Client) QuadletRemove(ctx context.Context, name string, opts QuadletRemoveOptions) (podmantypes.QuadletRemoveReport, error)
- func (c *Client) SecretCreate(ctx context.Context, req podmantypes.SecretCreateRequest, replace bool) (string, error)
- func (c *Client) SecretInspect(ctx context.Context, nameOrID string) (podmantypes.Secret, error)
- func (c *Client) SecretList(ctx context.Context, filters map[string][]string) ([]podmantypes.Secret, error)
- func (c *Client) SecretRemove(ctx context.Context, nameOrID string) error
- func (c *Client) Version(ctx context.Context) (podmantypes.Version, error)
- type Features
- type PodAction
- type PodActionOptions
- type PodBlockIO
- type PodCPULimits
- type PodIDMap
- type PodIDMappings
- type PodMemoryLimits
- type PodMount
- type PodNamedVolume
- type PodNamespace
- type PodNetworkOptions
- type PodPortMapping
- type PodResources
- type PodSpec
- type PodThrottleDevice
- type PodWeightDevice
- type QuadletInstallOptions
- type QuadletRemoveOptions
- type Runtime
- type Systemd
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) AutoUpdate ¶
func (c *Client) AutoUpdate(ctx context.Context, opts podmantypes.AutoUpdateOptions) (podmantypes.AutoUpdateResult, error)
func (*Client) ContainerList ¶
func (*Client) KubeDown ¶
func (c *Client) KubeDown(ctx context.Context, req podmantypes.KubeDownRequest) (podmantypes.KubeDownReport, error)
func (*Client) KubeGenerate ¶
func (c *Client) KubeGenerate(ctx context.Context, req podmantypes.KubeGenerateRequest) (string, error)
func (*Client) KubePlay ¶
func (c *Client) KubePlay(ctx context.Context, req podmantypes.KubePlayRequest) (podmantypes.KubePlayReport, error)
func (*Client) PodInspect ¶
func (c *Client) PodInspect(ctx context.Context, nameOrID string) (podmantypes.PodInspect, error)
func (*Client) PodPrune ¶
func (c *Client) PodPrune(ctx context.Context) ([]podmantypes.PodPruneReport, error)
func (*Client) QuadletFile ¶
func (*Client) QuadletInstall ¶
func (c *Client) QuadletInstall(ctx context.Context, opts QuadletInstallOptions) (podmantypes.QuadletInstallReport, error)
func (*Client) QuadletList ¶
func (*Client) QuadletRemove ¶
func (c *Client) QuadletRemove(ctx context.Context, name string, opts QuadletRemoveOptions) (podmantypes.QuadletRemoveReport, error)
func (*Client) SecretCreate ¶
func (c *Client) SecretCreate(ctx context.Context, req podmantypes.SecretCreateRequest, replace bool) (string, error)
func (*Client) SecretInspect ¶
func (*Client) SecretList ¶
func (*Client) SecretRemove ¶
type Features ¶
type Features struct {
QuadletsSupported bool
QuadletAppsSupported bool
AutoUpdateMode podmantypes.AutoUpdateMode
}
func DetectFeatures ¶
type PodActionOptions ¶
type PodBlockIO ¶
type PodBlockIO struct {
Weight *uint16 `json:"weight,omitempty"`
WeightDevice []PodWeightDevice `json:"weightDevice,omitempty"`
ThrottleReadBpsDevice []PodThrottleDevice `json:"throttleReadBpsDevice,omitempty"`
ThrottleWriteBpsDevice []PodThrottleDevice `json:"throttleWriteBpsDevice,omitempty"`
}
type PodCPULimits ¶
type PodIDMappings ¶
type PodMemoryLimits ¶
type PodNamedVolume ¶
type PodNamespace ¶
type PodNetworkOptions ¶
type PodPortMapping ¶
type PodResources ¶
type PodResources struct {
Memory *PodMemoryLimits `json:"memory,omitempty"`
CPU *PodCPULimits `json:"cpu,omitempty"`
BlockIO *PodBlockIO `json:"blockIO,omitempty"`
}
type PodSpec ¶
type PodSpec struct {
Name string `json:"name"`
Hostname string `json:"hostname,omitempty"`
ExitPolicy string `json:"exit_policy,omitempty"`
Labels map[string]string `json:"labels,omitempty"`
NoInfra bool `json:"no_infra,omitempty"`
InfraConmonPidFile string `json:"infra_conmon_pid_file,omitempty"`
InfraCommand []string `json:"infra_command,omitempty"`
InfraImage string `json:"infra_image,omitempty"`
InfraName string `json:"infra_name,omitempty"`
Ipc *PodNamespace `json:"ipcns,omitempty"`
RestartPolicy string `json:"restart_policy,omitempty"`
RestartRetries *uint `json:"restart_tries,omitempty"`
Pid *PodNamespace `json:"pidns,omitempty"`
Userns *PodNamespace `json:"userns,omitempty"`
Uts *PodNamespace `json:"utsns,omitempty"`
Devices []string `json:"pod_devices,omitempty"`
Sysctl map[string]string `json:"sysctl,omitempty"`
NetNS *PodNamespace `json:"netns,omitempty"`
PortMappings []PodPortMapping `json:"portmappings,omitempty"`
Networks map[string]PodNetworkOptions `json:"Networks,omitempty"`
NoManageResolvConf bool `json:"no_manage_resolv_conf,omitempty"`
DNSServer []string `json:"dns_server,omitempty"`
DNSSearch []string `json:"dns_search,omitempty"`
DNSOption []string `json:"dns_option,omitempty"`
NoManageHostname bool `json:"no_manage_hostname,omitempty"`
NoManageHosts bool `json:"no_manage_hosts,omitempty"`
HostAdd []string `json:"hostadd,omitempty"`
HostsFile string `json:"hostsFile,omitempty"`
NetworkOptions map[string][]string `json:"network_options,omitempty"`
CgroupParent string `json:"cgroup_parent,omitempty"`
ResourceLimits *PodResources `json:"resource_limits,omitempty"`
Mounts []PodMount `json:"mounts,omitempty"`
Volumes []PodNamedVolume `json:"volumes,omitempty"`
VolumesFrom []string `json:"volumes_from,omitempty"`
ShmSize *int64 `json:"shm_size,omitempty"`
ShmSizeSystemd *int64 `json:"shm_size_systemd,omitempty"`
SecurityOpt []string `json:"security_opt,omitempty"`
IDMappings *PodIDMappings `json:"idmappings,omitempty"`
}
type PodThrottleDevice ¶
type PodWeightDevice ¶
type QuadletInstallOptions ¶
type QuadletInstallOptions struct {
File podmantypes.QuadletFile
ExtraFiles []podmantypes.QuadletFile
Replace bool
Application string
AppsSupported bool
}
type QuadletRemoveOptions ¶
type Runtime ¶
type Runtime struct {
Client *Client
Version podmantypes.Version
Rootless bool
Systemd Systemd
}
type Systemd ¶
type Systemd interface {
Availability(ctx context.Context) podmantypes.SystemdAvailability
Start(ctx context.Context, unit string) error
Stop(ctx context.Context, unit string) error
Restart(ctx context.Context, unit string) error
UnitStatus(ctx context.Context, unit string) (podmantypes.UnitStatus, error)
}
Click to show internal directories.
Click to hide internal directories.