Skip to main content

AnsibleTemplateRenderingService

Struct AnsibleTemplateRenderingService 

Source
pub struct AnsibleTemplateRenderingService { /* private fields */ }
Expand description

Service for rendering Ansible templates with runtime configuration

This service encapsulates the logic for rendering Ansible inventory and configuration templates. It’s designed to be shared across command handlers that need to prepare Ansible files (e.g., Provision, Register).

§Design

The service follows dependency injection principles:

  • Dependencies (template renderer) are injected at construction time
  • Runtime data (SSH credentials, IP, port) is passed to the render method

This allows the service to be configured once and reused with different runtime parameters.

Implementations§

Source§

impl AnsibleTemplateRenderingService

Source

pub fn new( ansible_template_renderer: Arc<AnsibleProjectGenerator>, clock: Arc<dyn Clock>, ) -> Self

Create a new AnsibleTemplateRenderingService

§Arguments
  • ansible_template_renderer - The renderer for Ansible templates
  • clock - The clock for generating timestamps
Source

pub fn from_paths( templates_dir: PathBuf, build_dir: PathBuf, clock: Arc<dyn Clock>, ) -> Self

Build an AnsibleTemplateRenderingService from environment paths

This is a factory method that creates the service with all necessary dependencies based on the environment’s template and build directories.

§Arguments
  • templates_dir - Directory containing the source templates
  • build_dir - Directory where rendered templates will be written
  • clock - The clock for generating timestamps
§Returns

Returns a configured AnsibleTemplateRenderingService ready for template rendering

§Example
use std::path::PathBuf;
use std::sync::Arc;
use torrust_tracker_deployer_lib::application::services::rendering::AnsibleTemplateRenderingService;
use torrust_tracker_deployer_lib::shared::clock::SystemClock;

let service = AnsibleTemplateRenderingService::from_paths(
    PathBuf::from("templates"),
    PathBuf::from("build/my-env"),
    Arc::new(SystemClock),
);
Source

pub async fn render_templates( &self, user_inputs: &UserInputs, instance_ip: IpAddr, ssh_port_override: Option<u16>, ) -> Result<(), AnsibleTemplateRenderingServiceError>

Render Ansible templates with the provided runtime configuration

This renders the Ansible inventory and configuration templates so that Ansible playbooks can be executed against the target instance.

§Arguments
  • user_inputs - User-provided environment configuration (SSH credentials, tracker config, etc.)
  • instance_ip - IP address of the provisioned instance (runtime output)
  • ssh_port_override - Optional SSH port override (takes precedence over user_inputs.ssh_port)
§Errors

Returns AnsibleTemplateRenderingServiceError::RenderingFailed if template rendering fails.

§Example
use std::net::IpAddr;

let service = AnsibleTemplateRenderingService::from_paths(...);
service.render_templates(&user_inputs, "192.168.1.100".parse().unwrap(), None).await?;

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> IntoResult<T> for T

Source§

type Err = !

Source§

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more