node_deployer.create_img

apply_ignition_settings(template, hostname, password, swarm_config)

Applies the specified ignition settings to the given template

Parameters:

Name	Type	Description	Default
template	dict	The template to apply the settings to	required
hostname	str	The hostname to set	required
password	str	The password to set for the root user	required
swarm_config	str	The swarm configuration to set	required

Returns:

Name	Type	Description
dict	dict	The template with the settings applied

Source code in src/node_deployer/create_img.py

def apply_ignition_settings(
    template: dict,
    hostname: str,
    password: str,
    swarm_config: dict,
) -> dict:
    """Applies the specified ignition settings to the given template

    Args:
        template (dict): The template to apply the settings to
        hostname (str): The hostname to set
        password (str): The password to set for the root user
        swarm_config (str): The swarm configuration to set

    Returns:
        dict: The template with the settings applied
    """
    ignition_config = template.copy()
    ignition_config["hostname"] = hostname
    ignition_config["login"]["users"][0]["passwd"] = password
    if password:
        ignition_config["login"]["users"][0]["hash_type"] = "bcrypt"
    elif not config.TESTING:
        raise ValueError("Password must be specified")

    # Add files that will define a service to ensure that the node joins the swarm
    with open(config.SRC_DIR / "templates/join_swarm.sh", "r") as f1, open(
        config.SRC_DIR / "templates/join_swarm.service", "r"
    ) as f2:
        swarm_script, swarm_service = f1.read(), f2.read()

    ignition_config["storage"] = ignition_config.get("storage", {})
    ignition_config["storage"]["files"] = ignition_config["storage"].get("files", [])
    ignition_config["storage"]["files"] += [
        {
            "path": "/root/join_swarm.json",
            "source_type": "data",
            "mode": 420,
            "overwrite": True,
            "data_content": json.dumps(swarm_config),
        },
        {
            "path": "/root/join_swarm.sh",
            "source_type": "data",
            "mode": 420,
            "overwrite": True,
            "data_content": swarm_script,
        },
    ]

    ignition_config["systemd"] = ignition_config.get("systemd", {})
    ignition_config["systemd"]["units"] = ignition_config["systemd"].get("units", [])
    ignition_config["systemd"]["units"] += [
        {
            "name": "join_swarm.service",
            "enabled": True,
            "contents": swarm_service,
        },
    ]

    return ignition_config

create_img(hostname='node', password=None, switch_ip=None, switch_port=4789, swarm_token=None, img_path=Path('ignition.img'), debug=False)

Creates an ignition image for a node that will automatically join a swarm

Parameters:

Name	Type	Description	Default
hostname	Annotated[ str, typer.Option	The hostname to set for the node. Defaults to "node".	'node'
password	Annotated[ str, typer.Option	The password to set for the root user on the node. Defaults to None.	None
switch_ip	Annotated[ IPAddress, typer.Option	The IP address of the switch to connect to. Defaults to None.	None
switch_port	Annotated[ int, typer.Option	The port on the switch to connect to. Defaults to 4789.	4789
swarm_token	Annotated[ str, typer.Option	The swarm token for connecting to the swarm. Defaults to None.	None
img_path	Annotated[ Path, typer.Option	The path to which the ignition image should be written. Defaults to Path("ignition.img").	Path('ignition.img')
debug	Annotated[ bool, typer.Option	Enable debug mode. Defaults to False.	False

Source code in src/node_deployer/create_img.py

@debug_guard
@cli_spinner(description="Creating ignition image", total=None)
@ensure_build_dir
def create_img(
    hostname: Annotated[
        str,
        typer.Option(
            "--hostname",
            "-h",
            help="Hostname for the new node",
            prompt=True,
        ),
    ] = "node",
    password: Annotated[
        Optional[str],
        typer.Option(
            "--password",
            "-p",
            help="Password for the root user on the new node",
            prompt=True,
            confirmation_prompt=True,
            hide_input=True,
        ),
    ] = None,
    switch_ip: Annotated[
        Optional[IPAddress],
        typer.Option(
            "--switch-ip",
            "-ip",
            help="IP address of the switch to connect to",
            prompt=True,
            parser=IPAddress,
        ),
    ] = None,
    switch_port: Annotated[
        int,
        typer.Option(
            "--switch-port",
            "-sp",
            help="Port on the switch to connect to",
            prompt=True,
            min=1,
            max=config.MAX_PORT,
        ),
    ] = 4789,
    swarm_token: Annotated[
        Optional[str],
        typer.Option(
            "--swarm-token",
            "-t",
            help="Swarm token for connecting to the swarm",
            prompt=True,
        ),
    ] = None,
    img_path: Annotated[
        Path,
        typer.Option(
            "--img-path",
            "-o",
            help="Path to which the ignition image should be written",
            dir_okay=False,
        ),
    ] = Path("ignition.img"),
    debug: Annotated[
        bool,
        typer.Option(
            "--debug",
            help="Enable debug mode",
            is_eager=True,
            is_flag=True,
            flag_value=True,
            hidden=not config.DEBUG,
        ),
    ] = False,
) -> None:
    """Creates an ignition image for a node that will automatically join a swarm

    Args:
        hostname (Annotated[ str, typer.Option, optional):
            The hostname to set for the node.
            Defaults to "node".
        password (Annotated[ str, typer.Option, optional):
            The password to set for the root user on the node.
            Defaults to None.
        switch_ip (Annotated[ IPAddress, typer.Option, optional):
            The IP address of the switch to connect to.
            Defaults to None.
        switch_port (Annotated[ int, typer.Option, optional):
            The port on the switch to connect to.
            Defaults to 4789.
        swarm_token (Annotated[ str, typer.Option, optional):
            The swarm token for connecting to the swarm.
            Defaults to None.
        img_path (Annotated[ Path, typer.Option, optional):
            The path to which the ignition image should be written.
            Defaults to Path("ignition.img").
        debug (Annotated[ bool, typer.Option, optional):
            Enable debug mode.
            Defaults to False.
    """
    # Guards against the user not specifying a password
    if password is None and not config.TESTING:
        raise typer.BadParameter("Password must be specified")
    elif password is None:
        password = ""

    # get swarm configuration as JSON
    swarm_config = {
        "SWITCH_IP_ADDRESS": str(switch_ip),
        "SWITCH_PORT": switch_port,
        "SWARM_TOKEN": swarm_token,
    }

    # Create ignition configuration
    ignition_config = apply_ignition_settings(
        load_template(),
        hostname,
        password,
        swarm_config,
    )

    # export ignition configuration
    with open(config.BUILD_DIR / "fuelignition.json", "w") as f:
        json.dump(ignition_config, f, indent=4)

    # convert ignition configuration to image
    json_to_img(
        json_path=config.BUILD_DIR / "fuelignition.json",
        img_path=img_path,
        debug=debug,
    )

load_template()

Loads the default template for the ignition configuration

Returns:

Name	Type	Description
dict	dict	The default ignition configuration

Source code in src/node_deployer/create_img.py

def load_template() -> dict:
    """Loads the default template for the ignition configuration

    Returns:
        dict: The default ignition configuration
    """
    with open(config.SRC_DIR / "templates/fuelignition.json", "r") as f:
        out = json.load(f)
    return out

---

Last update: November 7, 2023
Created: November 1, 2023