Struct podman_api::models::ContainerBasicConfig

pub struct ContainerBasicConfig {

    pub annotations: Option<HashMap<String, String, RandomState>>,
    pub command: Option<Vec<String, Global>>,
    pub conmon_pid_file: Option<String>,
    pub container_create_command: Option<Vec<String, Global>>,
    pub dependency_containers: Option<Vec<String, Global>>,
    pub entrypoint: Option<Vec<String, Global>>,
    pub env: Option<HashMap<String, String, RandomState>>,
    pub env_host: Option<bool>,
    pub hostname: Option<String>,
    pub httpproxy: Option<bool>,
    pub init_container_type: Option<String>,
    pub labels: Option<HashMap<String, String, RandomState>>,
    pub log_configuration: Option<LogConfig>,
    pub name: Option<String>,
    pub namespace: Option<String>,
    pub oci_runtime: Option<String>,
    pub personality: Option<LinuxPersonality>,
    pub pidns: Option<Namespace>,
    pub pod: Option<String>,
    pub raw_image_name: Option<String>,
    pub remove: Option<bool>,
    pub restart_policy: Option<String>,
    pub restart_tries: Option<i64>,
    pub sdnotify_mode: Option<String>,
    pub secret_env: Option<HashMap<String, String, RandomState>>,
    pub stdin: Option<bool>,
    pub stop_signal: Option<i64>,
    pub stop_timeout: Option<i64>,
    pub sysctl: Option<HashMap<String, String, RandomState>>,
    pub systemd: Option<String>,
    pub terminal: Option<bool>,
    pub timeout: Option<i64>,
    pub timezone: Option<String>,
    pub utsns: Option<Namespace>,
}

Fields

annotations: Option<HashMap<String, String, RandomState>>

Annotations are key-value options passed into the container runtime that can be used to trigger special behavior. Optional.

command: Option<Vec<String, Global>>

Command is the container’s command. If not given and Image is specified, this will be populated by the image’s configuration. Optional.

conmon_pid_file: Option<String>

ConmonPidFile is a path at which a PID file for Conmon will be placed. If not given, a default location will be used. Optional.

container_create_command: Option<Vec<String, Global>>

ContainerCreateCommand is the command that was used to create this container. This will be shown in the output of Inspect() on the container, and may also be used by some tools that wish to recreate the container (e.g. podman generate systemd --new). Optional.

dependency_containers: Option<Vec<String, Global>>

DependencyContainers is an array of containers this container depends on. Dependency containers must be started before this container. Dependencies can be specified by name or full/partial ID. Optional.

entrypoint: Option<Vec<String, Global>>

Entrypoint is the container’s entrypoint. If not given and Image is specified, this will be populated by the image’s configuration. Optional.

env: Option<HashMap<String, String, RandomState>>

Env is a set of environment variables that will be set in the container. Optional.

env_host: Option<bool>

EnvHost indicates that the host environment should be added to container Optional.

hostname: Option<String>

Hostname is the container’s hostname. If not set, the hostname will not be modified (if UtsNS is not private) or will be set to the container ID (if UtsNS is private). Conflicts with UtsNS if UtsNS is not set to private. Optional.

httpproxy: Option<bool>

EnvHTTPProxy indicates that the http host proxy environment variables should be added to container Optional.

init_container_type: Option<String>

InitContainerType describes if this container is an init container and if so, what type: always or once

labels: Option<HashMap<String, String, RandomState>>

Labels are key-value pairs that are used to add metadata to containers. Optional.

log_configuration: Option<LogConfig>

name: Option<String>

Name is the name the container will be given. If no name is provided, one will be randomly generated. Optional.

namespace: Option<String>

Namespace is the libpod namespace the container will be placed in. Optional.

oci_runtime: Option<String>

OCIRuntime is the name of the OCI runtime that will be used to create the container. If not specified, the default will be used. Optional.

personality: Option<LinuxPersonality>

pidns: Option<Namespace>

pod: Option<String>

Pod is the ID of the pod the container will join. Optional.

raw_image_name: Option<String>

RawImageName is the user-specified and unprocessed input referring to a local or a remote image.

remove: Option<bool>

Remove indicates if the container should be removed once it has been started and exits

restart_policy: Option<String>

RestartPolicy is the container’s restart policy - an action which will be taken when the container exits. If not given, the default policy, which does nothing, will be used. Optional.

restart_tries: Option<i64>

RestartRetries is the number of attempts that will be made to restart the container. Only available when RestartPolicy is set to "on-failure". Optional.

sdnotify_mode: Option<String>

Determine how to handle the NOTIFY_SOCKET - do we participate or pass it through "container" - let the OCI runtime deal with it, advertise conmon’s MAINPID "conmon-only" - advertise conmon’s MAINPID, send READY when started, don’t pass to OCI "ignore" - unset NOTIFY_SOCKET

secret_env: Option<HashMap<String, String, RandomState>>

EnvSecrets are secrets that will be set as environment variables Optional.

stdin: Option<bool>

Stdin is whether the container will keep its STDIN open.

stop_signal: Option<i64>

stop_timeout: Option<i64>

StopTimeout is a timeout between the container’s stop signal being sent and SIGKILL being sent. If not provided, the default will be used. If 0 is used, stop signal will not be sent, and SIGKILL will be sent instead. Optional.

sysctl: Option<HashMap<String, String, RandomState>>

Sysctl sets kernel parameters for the container

systemd: Option<String>

Systemd is whether the container will be started in systemd mode. Valid options are "true", "false", and "always". "true" enables this mode only if the binary run in the container is sbin/init or systemd. "always" unconditionally enables systemd mode. "false" unconditionally disables systemd mode. If enabled, mounts and stop signal will be modified. If set to "always" or set to "true" and conditionally triggered, conflicts with StopSignal. If not specified, "false" will be assumed. Optional.

terminal: Option<bool>

Terminal is whether the container will create a PTY. Optional.

timeout: Option<i64>

Timeout is a maximum time in seconds the container will run before main process is sent SIGKILL. If 0 is used, signal will not be sent. Container can run indefinitely Optional.

timezone: Option<String>

Timezone is the timezone inside the container. Local means it has the same timezone as the host machine Optional.

utsns: Option<Namespace>

Trait Implementations

impl Clone for ContainerBasicConfig

fn clone(&self) -> ContainerBasicConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ContainerBasicConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ContainerBasicConfig

fn deserialize<__D>(
    __deserializer: __D
) -> Result<ContainerBasicConfig, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<ContainerBasicConfig> for ContainerBasicConfig

fn eq(&self, other: &ContainerBasicConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ContainerBasicConfig) -> bool

This method tests for !=.

impl Serialize for ContainerBasicConfig

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ContainerBasicConfig