Skip to main content

Module types

Module types 

Source
Expand description

Docker Compose file type definitions.

Re-exports§

pub use build::*;
pub use deploy::*;
pub use develop::*;
pub use env::*;
pub use lifecycle::*;
pub use network::*;
pub use ports::*;
pub use primitives::*;
pub use resources::*;
pub use service::*;
pub use volume::*;

Modules§

build
Build, include, and extends configuration types.
deploy
Deployment configuration types for the deploy: service key.
develop
Development watch configuration types for the develop: service key.
env
Environment variable and env-file types for the environment: and env_file: service fields.
lifecycle
Lifecycle and dependency types: depends_on:, healthcheck:, restart:, and lifecycle hooks.
network
Network configuration types for both top-level networks and per-service attachments.
ports
Port mapping types used in the ports: service field.
primitives
Primitive compose field types shared across multiple service keys.
resources
Resource limit and device types shared across service and deploy configuration.
service
Service struct — the central type representing a single compose service.
volume
Volume, secret, and config mount types.

Structs§

ComposeFile
Root deserialization target for a docker-compose.yml file.
ConfigConfig
Top-level configs: entry — defines a named config available to services.
SecretConfig
Top-level secrets: entry — defines a named secret available to services.