Struct compose_spec::service::ConfigOrSecret

pub struct ConfigOrSecret {
    pub source: Identifier,
    pub target: Option<PathBuf>,
    pub uid: Option<u32>,
    pub gid: Option<u32>,
    pub mode: Option<u32>,
    pub extensions: Extensions,
}

Long syntax config or secret configuration.

Config

Configs allow services to adapt their behavior without the need to rebuild a container image. Services can only access configs when explicitly granted by the configs field.

service config compose-spec

Secret

Secrets grant access to sensitive data defined by the top-level secrets on a per-service basis.

service secrets compose-spec

build secrets compose-spec

Fields

source: Identifier

The name of the Config / Secret as it exists on the platform.

target: Option<PathBuf>

Configs: The path and name of the file to be mounted in the service’s task containers. Defaults to /<source> if not specified.

Secrets: The name of the file to be mounted in /run/secrets/ in the service’s task containers. Defaults to source if not specified.

uid: Option<u32>

The numeric UID that owns the mounted config/secret file within the service’s task containers.

Default value when not specified is the UID from the container image’s USER.

(De)serialized from/to a string.

gid: Option<u32>

The numeric GID that owns the mounted config/secret file within the service’s task containers.

Default value when not specified is the GID from the container image’s USER.

(De)serialized from/to a string.

mode: Option<u32>

The permissions for the file that is mounted within the service’s task containers.

Default value is world-readable permissions (mode 0o444). The writable bit must be ignored if set. The executable bit may be set.

Note that, when deserializing with serde_yaml, octal numbers must start with 0o, e.g. 0o555, otherwise, they are interpreted as decimal numbers. Unfortunately, for serialization, there is no way to specify that a number should be serialized in octal form.

extensions: Extensions

Extension values, which are (de)serialized via flattening.

compose-spec

Trait Implementations

impl AsShort for ConfigOrSecret

type Short = Identifier

The short syntax type, returned from as_short().

fn as_short(&self) -> Option<&Self::Short>

Returns Some if the long syntax can be represented as the short syntax.

impl Clone for ConfigOrSecret

fn clone(&self) -> ConfigOrSecret

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigOrSecret

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigOrSecret

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S> From<ConfigOrSecret> for ShortOrLong<S, ConfigOrSecret>

fn from(value: ConfigOrSecret) -> Self

Converts to this type from the input type.

impl From<Identifier> for ConfigOrSecret

fn from(source: Identifier) -> Self

Converts to this type from the input type.

impl<S> From<ShortOrLong<S, ConfigOrSecret>> for ConfigOrSecret

where S: Into<Self>,

fn from(value: ShortOrLong<S, Self>) -> Self

Converts to this type from the input type.

impl PartialEq for ConfigOrSecret

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ConfigOrSecret

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ConfigOrSecret

impl StructuralPartialEq for ConfigOrSecret