Enum Network 

pub enum Network {
    Database,
    Metrics,
    Visualization,
    Proxy,
}

Docker Compose networks used for service isolation

Each network serves a specific security purpose:

• Database: Isolates database access to only the tracker
• Metrics: Allows Prometheus to scrape tracker metrics
• Visualization: Allows Grafana to query Prometheus
• Proxy: Allows Caddy to reverse proxy to backend services

Serialization

When serialized, the network outputs its name string (e.g., "metrics_network"), making it directly usable in Tera templates:

networks:
  - {{ network }}  # Renders as "metrics_network"

Variants

Database

Network for database access (Tracker ↔ MySQL)

Only the tracker and MySQL are connected to this network, ensuring database isolation from other services.

Metrics

Network for metrics scraping (Tracker ↔ Prometheus)

Allows Prometheus to scrape metrics from the tracker while keeping Prometheus isolated from other traffic.

Visualization

Network for visualization queries (Prometheus ↔ Grafana)

Allows Grafana to query Prometheus for dashboard data.

Proxy

Network for TLS proxy (Caddy ↔ backend services)

Allows Caddy to reverse proxy to services that need TLS termination (tracker API, Grafana, etc.).

Implementations

impl Network

pub fn name(&self) -> &'static str

Returns the network name as used in docker-compose.yml

Examples

use torrust_tracker_deployer_lib::domain::topology::Network;

assert_eq!(Network::Database.name(), "database_network");
assert_eq!(Network::Metrics.name(), "metrics_network");
assert_eq!(Network::Visualization.name(), "visualization_network");
assert_eq!(Network::Proxy.name(), "proxy_network");

pub fn driver(&self) -> &'static str

Returns the network driver

Currently all networks use the bridge driver.

Examples

use torrust_tracker_deployer_lib::domain::topology::Network;

assert_eq!(Network::Database.driver(), "bridge");

pub fn description(&self) -> &'static str

Returns a short description of the network’s purpose

This description is rendered as a comment in docker-compose.yml to help system administrators understand each network’s role.

Examples

use torrust_tracker_deployer_lib::domain::topology::Network;

assert_eq!(Network::Database.description(), "Database isolation: Tracker ↔ MySQL");
assert_eq!(Network::Metrics.description(), "Metrics scraping: Tracker ↔ Prometheus");

pub fn all() -> &'static [Network]

Returns all network variants

Useful for iteration when generating the global networks section in docker-compose.yml.

Examples

use torrust_tracker_deployer_lib::domain::topology::Network;

let all = Network::all();
assert_eq!(all.len(), 4);

Trait Implementations

impl Clone for Network

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Network

impl Debug for Network

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

Formats the value using the given formatter.

impl Display for Network

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

Formats the value using the given formatter.

impl Eq for Network

impl From<Network> for NetworkDefinition

fn from(network: Network) -> Self

Converts to this type from the input type.

impl Hash for Network

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Network

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Network

Custom serialization to output the network name string

This allows the Network enum to be used directly in Tera templates without needing wrapper types or custom serialization logic.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Network