1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
use crate::{api::Filter, models};
impl_opts_builder!(url =>
/// Adjust the list of returned pods with this options.
PodList
);
#[derive(Debug)]
/// Used to filter listed pods by one of the variants.
pub enum PodListFilter {
/// A pods's ID
Id(crate::Id),
/// Pod key label.
LabelKey(String),
/// Pod key-value label.
LabelKeyVal(String, String),
/// A pods's name
Name(String),
/// List pods created before this timestamp. The <timestamp> can be Unix timestamps,
/// date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m) computed
/// relative to the daemon machine’s time.
Until(String),
/// Name or full ID of network.
Network(String),
Status(models::PodStatus),
/// Container name within the pod.
ContainerName(String),
/// Container name within the pod.
ContainerId(crate::Id),
/// Container status within the pod.
ContainerStatus(models::ContainerStatus),
/// Number of containers within the pod.
ContainerNumber(usize),
}
impl Filter for PodListFilter {
fn query_key_val(&self) -> (&'static str, String) {
use PodListFilter::*;
match &self {
Id(id) => ("id", id.to_string()),
LabelKey(key) => ("label", key.clone()),
LabelKeyVal(key, val) => ("label", format!("{}={}", key, val)),
Name(name) => ("name", name.clone()),
Until(until) => ("until", until.clone()),
Network(net) => ("network", net.clone()),
Status(status) => ("status", status.as_ref().to_string()),
ContainerName(name) => ("ctr-names", name.clone()),
ContainerId(id) => ("ctr-ids", id.to_string()),
ContainerStatus(status) => ("ctr-status", status.as_ref().to_string()),
ContainerNumber(n) => ("ctr-number", n.to_string()),
}
}
}
impl PodListOptsBuilder {
impl_filter_func!(PodListFilter);
}
impl_opts_builder!(url =>
/// Adjust how processes inside a pod are listed.
PodTop
);
impl PodTopOpts {
pub(crate) fn stream(&self) -> Self {
let mut new = self.clone();
new.params.insert("stream", true.to_string());
new
}
}
impl PodTopOptsBuilder {
impl_url_field!(
/// If streaming, delay in seconds between updates.
delay: usize => "delay"
);
impl_url_str_field!(
/// Arguments to pass to ps such as aux. Requires ps(1) to be installed in the container if
/// no ps(1) compatible AIX descriptors are used.
ps_args => "ps_args"
);
}
impl_opts_builder!(url =>
/// Adjust how stats of a process are listed.
PodStats
);
impl PodStatsOptsBuilder {
impl_url_bool_field!(
/// Provide statistics for all running pods.
all => "all"
);
impl_url_vec_field!(
/// Names or IDs of pods.
names_or_ids => "namesOrIds"
);
}
impl_opts_builder!(json =>
/// Adjust the way a pod is created.
PodCreate
);
impl PodCreateOptsBuilder {
impl_str_field!(
/// The parent for the CGroup that the pod will create. This pod cgroup will, in turn, be
/// the default cgroup parent for all containers in the pod.
cgroup_parent => "cgroup_parent"
);
impl_vec_field!(
/// List of CNI networks to join the container to. If this list is empty, the default CNI
/// network will be joined instead. If at least one entry is present, we will not join the
/// default network (unless it is part of this list). Only available if NetNS is set to
/// bridge. Optional. Deprecated: as of podman 4.0 use "Networks" instead.
cni_networks => "cni_networks"
);
impl_field!(
/// CPU period of the cpuset, determined by --cpus
cpu_period: u64 => "cpu_period"
);
impl_field!(
/// CPU quota of the cpuset, determined by --cpus
cpu_quota: i64 => "cpu_quota"
);
impl_vec_field!(
/// Set of DNS options that will be used in the infra container's resolv.conf, which
/// will, by default, be shared with all containers in the pod. Conflicts with
/// [`no_infra`](PodCreateOptsBuilder::no_infra) == true.
dns_option => "dns_option"
);
impl_vec_field!(
/// Set of DNS search domains that will be used in the infra container's resolv.conf,
/// which will, by default, be shared with all containers in the pod. If not provided, DNS
/// search domains from the host's resolv.conf will be used. Conflicts with
/// [`no_infra`](PodCreateOptsBuilder::no_infra) == true.
dns_search => "dns_search"
);
// TODO: dns_server
impl_vec_field!(
/// Set of hosts that will be added to the infra container's etc/hosts that will, by
/// default, be shared with all containers in the pod. Conflicts with
/// [`no_infra`](PodCreateOptsBuilder::no_infra) == true and
/// [`no_manage_hosts`](PodCreateOptsBuilder::no_manage_hosts).
add_hosts => "hostadd"
);
impl_str_field!(
/// The pod's hostname. If not set, the name of the pod will be used (if a name was not
/// provided here, the name auto-generated for the pod will be used). This will be used by
/// the infra container and all containers in the pod as long as the UTS namespace is
/// shared.
hostname => "hostname"
);
// TODO: image_volumes
impl_vec_field!(
/// Sets the command that will be used to start the infra container. If not set, the
/// default set in the Libpod configuration file will be used. Conflicts with
/// [`no_infra`](PodCreateOptsBuilder::no_infra) == true.
infra_command => "infra_command"
);
impl_str_field!(
/// Custom path to store the infra container's conmon PID.
infra_common_pid_file => "infra_common_pid_file"
);
impl_str_field!(
/// The image that will be used for the infra container. If not set, the default set
/// in the Libpod configuration file will be used. Conflicts with
/// [`no_infra`](PodCreateOptsBuilder::no_infra) == true.
infra_image => "infra_image"
);
impl_str_field!(
/// The name that will be used for the infra container. If not set, the default set in the
/// Libpod configuration file will be used. Conflicts with
/// [`no_infra`](PodCreateOptsBuilder::no_infra) == true.
infra_name => "infra_name"
);
impl_map_field!(json
/// Key-value pairs that are used to add metadata to a pod.
labels => "labels"
);
// TODO: mounts
impl_str_field!(
/// The name of the pod. If not provided, a name will be generated when the pod is created.
name => "name"
);
impl_field!(
netns: models::Namespace => "netns"
);
impl_map_field!(json
/// Additional options for each network.
network_options => "network_options"
);
// TODO: network
impl_field!(
/// tells the pod not to create an infra container. If this is done, many
/// networking-related options will become unavailable. Conflicts with any
/// network or infra related settings.
no_infra: bool => "no_infra"
);
impl_field!(
/// Indicates that /etc/hosts should not be managed by the pod. Instead, each container
/// will create a separate /etc/hosts as they would if not in a pod. Conflicts with
/// [`add_hosts`](PodCreateOptsBuilder::add_hosts).
no_manage_hosts: bool => "no_manage_hosts"
);
impl_field!(
/// Indicates that /etc/resolv.conf should not be managed by the pod. Instead, each
/// container will create and manage a separate resolv.conf as if they had not joined a
/// pod. Conflicts with [`dns_server`](PodCreateOptsBuilder::dns_server),
/// [`dns_search`](PodCreateOptsBuilder::dns_search),
/// [`dns_option`](PodCreateOptsBuilder::dns_option),
/// [`no_infra`](PodCreateOptsBuilder::no_infra).
no_manage_resolv_conf: bool => "no_manage_resolv_conf"
);
// TODO: overlay_volumes
impl_field!(
pidns: models::Namespace => "pidns"
);
impl_vec_field!(
/// The command used to create this pod. This will be shown in the output of Inspect() on
/// the pode and may also be used by some tools that wish to recreate the pod (e.g. podman
/// generate systemd --new).
pod_create_command => "pod_create_command"
);
impl_vec_field!(
/// User specified Devices to be added to the Pod.
pod_devices => "pod_devices"
);
// TODO: portmappings
impl_field!(
/// Container runtime resource constraints.
resource_limits: models::LinuxResources => "resource_limits"
);
impl_vec_field!(
/// Instructs the pod to share a set of namespaces. Shared namespaces will be joined (by
/// default) by every container which joins the pod. If not set and NoInfra is false, the
/// pod will set a default set of namespaces to share. Conflicts with
/// [`no_infra`](PodCreateOptsBuilder::no_infra) == true.
shared_namespaces => "shared_namespaces"
);
// TODO: throttleReadBpsDevice
impl_field!(
userns: models::Namespace => "userns"
);
// TODO: volumes
impl_vec_field!(
/// Set of containers whose volumes will be added to this pod. The name or ID of the
/// container must be provided, and may optionally be followed by a : and then one or more
/// comma-separated options. Valid options are 'ro', 'rw', and 'z'. Options will be used
/// for all volumes sourced from the container.
volumes_from => "volumes_from"
);
}