package entities import ( "errors" "strings" "github.com/containers/podman/v5/libpod/define" "github.com/containers/podman/v5/pkg/domain/entities/types" "github.com/containers/podman/v5/pkg/specgen" "github.com/containers/podman/v5/pkg/util" "github.com/opencontainers/runtime-spec/specs-go" commonFlag "go.podman.io/common/pkg/flag" ) type PodKillOptions struct { All bool Latest bool Signal string } type PodKillReport = types.PodKillReport type ListPodsReport = types.ListPodsReport type ListPodContainer = types.ListPodContainer type PodPauseOptions struct { All bool Latest bool } type PodPauseReport = types.PodPauseReport type PodunpauseOptions struct { All bool Latest bool } type PodUnpauseReport = types.PodUnpauseReport type PodStopOptions struct { All bool Ignore bool Latest bool Timeout int } type PodStopReport = types.PodStopReport type PodRestartOptions struct { All bool Latest bool } type PodRestartReport = types.PodRestartReport type PodStartOptions struct { All bool Latest bool } type PodStartReport = types.PodStartReport type PodRmOptions struct { All bool Force bool Ignore bool Latest bool Timeout *uint } type PodRmReport = types.PodRmReport type PodSpec = types.PodSpec // PodCreateOptions provides all possible options for creating a pod and its infra container. // The JSON tags below are made to match the respective field in ContainerCreateOptions for the purpose of mapping. // swagger:model PodCreateOptions type PodCreateOptions struct { CgroupParent string `json:"cgroup_parent,omitempty"` CreateCommand []string `json:"create_command,omitempty"` Devices []string `json:"devices,omitempty"` DeviceReadBPs []string `json:"device_read_bps,omitempty"` ExitPolicy string `json:"exit_policy,omitempty"` Hostname string `json:"hostname,omitempty"` Infra bool `json:"infra,omitempty"` InfraImage string `json:"infra_image,omitempty"` InfraName string `json:"container_name,omitempty"` InfraCommand *string `json:"container_command,omitempty"` InfraConmonPidFile string `json:"container_conmon_pidfile,omitempty"` Ipc string `json:"ipc,omitempty"` Labels map[string]string `json:"labels,omitempty"` Name string `json:"name,omitempty"` Net *NetOptions `json:"net,omitempty"` Share []string `json:"share,omitempty"` ShareParent *bool `json:"share_parent,omitempty"` Restart string `json:"restart,omitempty"` Pid string `json:"pid,omitempty"` Cpus float64 `json:"cpus,omitempty"` CpusetCpus string `json:"cpuset_cpus,omitempty"` Userns specgen.Namespace `json:"-"` Volume []string `json:"volume,omitempty"` VolumesFrom []string `json:"volumes_from,omitempty"` SecurityOpt []string `json:"security_opt,omitempty"` Sysctl []string `json:"sysctl,omitempty"` Uts string `json:"uts,omitempty"` } // PodLogsOptions describes the options to extract pod logs. type PodLogsOptions struct { // Other fields are exactly same as ContainerLogOpts ContainerLogsOptions // If specified will only fetch the logs of specified container ContainerName string // Show different colors in the logs. Color bool } // PodCloneOptions contains options for cloning an existing pod type PodCloneOptions struct { ID string Destroy bool CreateOpts PodCreateOptions InfraOptions ContainerCreateOptions PerContainerOptions ContainerCreateOptions Start bool } type ContainerMode string const ( InfraMode = ContainerMode("infra") CloneMode = ContainerMode("clone") UpdateMode = ContainerMode("update") CreateMode = ContainerMode("create") ) type ContainerCreateOptions struct { Annotation []string Attach []string Authfile string BlkIOWeight string BlkIOWeightDevice []string CapAdd []string CapDrop []string CgroupNS string CgroupsMode string CgroupParent string `json:"cgroup_parent,omitempty"` CIDFile string ConmonPIDFile string `json:"container_conmon_pidfile,omitempty"` CPUPeriod uint64 CPUQuota int64 CPURTPeriod uint64 CPURTRuntime int64 CPUShares uint64 CPUS float64 `json:"cpus,omitempty"` CPUSetCPUs string `json:"cpuset_cpus,omitempty"` CPUSetMems string Devices []string `json:"devices,omitempty"` DeviceCgroupRule []string DeviceReadBPs []string `json:"device_read_bps,omitempty"` DeviceReadIOPs []string DeviceWriteBPs []string DeviceWriteIOPs []string Entrypoint *string `json:"container_command,omitempty"` Env []string EnvHost bool EnvFile []string Expose []string GIDMap []string GPUs []string GroupAdd []string HealthCmd string HealthInterval string HealthRetries uint HealthLogDestination string HealthMaxLogCount uint HealthMaxLogSize uint HealthStartPeriod string HealthTimeout string HealthOnFailure string Hostname string `json:"hostname,omitempty"` HTTPProxy bool HostUsers []string ImageVolume string Init bool InitContainerType string InitPath string IntelRdtClosID string Interactive bool IPC string Label []string LabelFile []string LogDriver string LogOptions []string Memory string MemoryReservation string MemorySwap string MemorySwappiness int64 Name string `json:"container_name"` NoHealthCheck bool OOMKillDisable bool OOMScoreAdj *int Arch string OS string Variant string PID string `json:"pid,omitempty"` PIDsLimit *int64 Platform string Pod string PodIDFile string Personality string PreserveFDs uint PreserveFD []uint Privileged bool PublishAll bool Pull string Quiet bool ReadOnly bool ReadWriteTmpFS bool Restart string Replace bool Requires []string Retry *uint `json:"retry,omitempty"` RetryDelay string `json:"retry_delay,omitempty"` Rm bool RootFS bool Secrets []string SecurityOpt []string `json:"security_opt,omitempty"` SdNotifyMode string ShmSize string ShmSizeSystemd string SignaturePolicy string StartupHCCmd string StartupHCInterval string StartupHCRetries uint StartupHCSuccesses uint StartupHCTimeout string StopSignal string StopTimeout uint StorageOpts []string SubGIDName string SubUIDName string Sysctl []string `json:"sysctl,omitempty"` Systemd string Timeout uint TLSVerify commonFlag.OptionalBool TmpFS []string TTY bool Timezone string Umask string EnvMerge []string UnsetEnv []string UnsetEnvAll bool UIDMap []string Ulimit []string User string UserNS string `json:"-"` UTS string Mount []string Volume []string `json:"volume,omitempty"` VolumesFrom []string `json:"volumes_from,omitempty"` Workdir string SeccompPolicy string PidFile string ChrootDirs []string IsInfra bool IsClone bool DecryptionKeys []string CertDir string Creds string Net *NetOptions `json:"net,omitempty"` CgroupConf []string GroupEntry string PasswdEntry string } func NewInfraContainerCreateOptions() ContainerCreateOptions { options := ContainerCreateOptions{ IsInfra: true, ImageVolume: "anonymous", MemorySwappiness: -1, HealthLogDestination: define.DefaultHealthCheckLocalDestination, HealthMaxLogCount: define.DefaultHealthMaxLogCount, HealthMaxLogSize: define.DefaultHealthMaxLogSize, } return options } type PodCreateReport = types.PodCreateReport type PodCloneReport = types.PodCloneReport func (p *PodCreateOptions) CPULimits() *specs.LinuxCPU { cpu := &specs.LinuxCPU{ Cpus: p.CpusetCpus, } if p.Cpus != 0 { period, quota := util.CoresToPeriodAndQuota(p.Cpus) cpu.Period = &period cpu.Quota = "a } return cpu } func ToPodSpecGen(s specgen.PodSpecGenerator, p *PodCreateOptions) (*specgen.PodSpecGenerator, error) { // Basic Config s.Name = p.Name s.InfraName = p.InfraName out, err := specgen.ParseNamespace(p.Pid) if err != nil { return nil, err } s.Pid = out out, err = specgen.ParseNamespace(p.Ipc) if err != nil { return nil, err } s.Ipc = out out, err = specgen.ParseNamespace(p.Uts) if err != nil { return nil, err } s.UtsNs = out s.Hostname = p.Hostname s.ExitPolicy = p.ExitPolicy s.Labels = p.Labels s.Devices = p.Devices s.SecurityOpt = p.SecurityOpt s.NoInfra = !p.Infra if p.InfraCommand != nil && len(*p.InfraCommand) > 0 { s.InfraCommand = strings.Split(*p.InfraCommand, " ") } if len(p.InfraConmonPidFile) > 0 { s.InfraConmonPidFile = p.InfraConmonPidFile } s.InfraImage = p.InfraImage s.SharedNamespaces = p.Share s.ShareParent = p.ShareParent s.PodCreateCommand = p.CreateCommand s.VolumesFrom = p.VolumesFrom if p.Restart != "" { policy, retries, err := util.ParseRestartPolicy(p.Restart) if err != nil { return nil, err } s.RestartPolicy = policy s.RestartRetries = &retries } // Networking config if p.Net != nil { s.NetNS = p.Net.Network s.PortMappings = p.Net.PublishPorts s.Networks = p.Net.Networks s.NetworkOptions = p.Net.NetworkOptions if p.Net.UseImageResolvConf { s.NoManageResolvConf = true } s.DNSServer = p.Net.DNSServers s.DNSSearch = p.Net.DNSSearch s.DNSOption = p.Net.DNSOptions s.NoManageHosts = p.Net.NoHosts s.NoManageHostname = p.Net.NoHostname s.HostAdd = p.Net.AddHosts s.HostsFile = p.Net.HostsFile } // Cgroup s.CgroupParent = p.CgroupParent // Resource config if s.ResourceLimits == nil { s.ResourceLimits = &specs.LinuxResources{} } s.ResourceLimits.CPU = p.CPULimits() s.Userns = p.Userns sysctl := map[string]string{} if ctl := p.Sysctl; len(ctl) > 0 { sysctl, err = util.ValidateSysctls(ctl) if err != nil { return nil, err } } s.Sysctl = sysctl return &s, nil } type PodPruneOptions struct { Force bool `json:"force" schema:"force"` } type PodPruneReport = types.PodPruneReport type PodTopOptions struct { // CLI flags. ListDescriptors bool Latest bool // Options for the API. Descriptors []string NameOrID string } type PodPSOptions struct { CtrNames bool CtrIds bool CtrStatus bool Filters map[string][]string Format string Latest bool Namespace bool Quiet bool Sort string } type PodInspectReport = types.PodInspectReport // PodStatsOptions are options for the pod stats command. type PodStatsOptions struct { // All - provide stats for all running pods. All bool // Latest - provide stats for the latest pod. Latest bool } // PodStatsReport includes pod-resource statistics data. type PodStatsReport = types.PodStatsReport // ValidatePodStatsOptions validates the specified slice and options. Allows // for sharing code in the front- and the back-end. func ValidatePodStatsOptions(args []string, options *PodStatsOptions) error { num := 0 if len(args) > 0 { num++ } if options.All { num++ } if options.Latest { num++ } switch num { case 0: // Podman v1 compat: if nothing's specified get all running // pods. options.All = true return nil case 1: return nil default: return errors.New("--all, --latest and arguments cannot be used together") } } // PodLogsOptionsToContainerLogsOptions converts PodLogOptions to ContainerLogOptions func PodLogsOptionsToContainerLogsOptions(options PodLogsOptions) ContainerLogsOptions { // PodLogsOptions are similar but contains few extra fields like ctrName // So cast other values as is so we can reuse the code containerLogsOpts := ContainerLogsOptions{ Details: options.Details, Latest: options.Latest, Follow: options.Follow, Names: options.Names, Since: options.Since, Until: options.Until, Tail: options.Tail, Timestamps: options.Timestamps, Colors: options.Colors, StdoutWriter: options.StdoutWriter, StderrWriter: options.StderrWriter, } return containerLogsOpts }