node_deployer.autoignition

build_fuelignition()

Builds the fuel-ignition docker image

Returns:

Type	Description
Image	docker.models.images.Image: The built docker image

Source code in src/node_deployer/autoignition.py

def build_fuelignition() -> docker.models.images.Image:  # type: ignore
    """Builds the fuel-ignition docker image

    Returns:
        docker.models.images.Image: The built docker image
    """
    # Make sure the local fuel-ignition repo is up to date
    if (not config.FUELIGNITION_BUILD_DIR.exists()) or (
        len(tuple(config.FUELIGNITION_BUILD_DIR.iterdir())) == 0
    ):
        repo = git.Repo.clone_from(
            "https://github.com/openSUSE/fuel-ignition.git",
            config.FUELIGNITION_BUILD_DIR,
            branch="main",
        )
    else:
        repo = git.Repo(config.FUELIGNITION_BUILD_DIR)
    repo.remotes.origin.update()
    repo.remotes.origin.pull()
    # Then, build the docker image using the Dockerfile in the repo
    # * For the container to build, we need to use a patched Dockerfile
    # * The patch manually creates a "fuelignition" usergroup
    # * From reading up, this change to how docker creates usergroups
    # * appears to have been introduced in engine version 9.3.0 and above?
    # * For now, we're applying the patch @>=9.3.0 and can change later if needed
    engine_version = tuple(
        map(
            int,
            next(
                filter(lambda x: x.get("Name") == "Engine", config.CLIENT.version()["Components"])
            )["Version"].split("."),
        )
    )
    root_container = (engine_version[0] > 9) or (engine_version[0] == 9 and engine_version[1] >= 3)
    dockerfile = "Dockerfile"
    if root_container:
        dockerfile = config.DOCKERFILE_DIR / "fuel-ignition.dockerfile"
    image, _ = config.CLIENT.images.build(
        path=str(config.FUELIGNITION_BUILD_DIR),
        dockerfile=str(dockerfile),
        tag="fuel-ignition",
        network_mode="host",
        buildargs={"CONTAINER_USERID": "1000"},
        pull=True,
        quiet=True,
        rm=config.CLEANUP_IMAGES,
    )
    return image

convert_json_via_fuelignition(container, driver, fuelignition_json, img_path)

Converts a fuel-ignition json file to an ignition disk image file

Parameters:

Name	Type	Description	Default
container	Container	The selenium container	required
driver	Remote	The selenium webdriver instance	required
fuelignition_json	Path	The path to the fuel-ignition json file	required
img_path	Path	The path to the output ignition disk image file	required

Source code in src/node_deployer/autoignition.py

def convert_json_via_fuelignition(
    container: docker.models.containers.Container,  # type: ignore
    driver: webdriver.Remote,
    fuelignition_json: Path,
    img_path: Path,
) -> None:
    """Converts a fuel-ignition json file to an ignition disk image file

    Args:
        container (docker.models.containers.Container): The selenium container
        driver (webdriver.Remote): The selenium webdriver instance
        fuelignition_json (Path): The path to the fuel-ignition json file
        img_path (Path): The path to the output ignition disk image file
    """
    driver.get(config.FUELIGNITION_URL)
    # Navigate to "Load Settings from" and upload the json
    load_from = driver.find_element(By.NAME, "load_from")
    load_from.send_keys(str(config.CWD_MOUNTDIR / fuelignition_json))
    # Walk through page structure to find, scroll to and click "Convert and Download"
    export = driver.find_element(By.ID, "export")
    export_divs = export.find_elements(By.TAG_NAME, "div")
    convert_div = export_divs[9]
    convert_button = convert_div.find_element(By.TAG_NAME, "button")
    # Ensure "Downloads" is empty if it exists
    container.exec_run("[ -d /home/seluser/Downloads/* ] && rm /home/seluser/Downloads/*")
    # A hacky way of scrolling to the element, but is only way i can find right now
    convert_button.location_once_scrolled_into_view
    time.sleep(1)
    w = WebDriverWait(driver, 10)
    w.until_not(EC.invisibility_of_element(convert_button))
    w.until(EC.element_to_be_clickable(convert_button))
    convert_button.click()
    # Now, wait for the file to be downloaded
    while container.exec_run("ls /home/seluser/Downloads/").exit_code != 0:
        time.sleep(0.1)
    while ".img.part" in container.exec_run("ls /home/seluser/Downloads/").output.decode():
        time.sleep(0.1)
    image_file = container.exec_run("ls /home/seluser/Downloads/").output.decode().split()[0]
    # Finally, fetch the image file from the container
    client_image_path = f"/home/seluser/Downloads/{image_file}"
    host_image_path = config.PROJECT_ROOT / img_path
    if host_image_path.exists():
        host_image_path.unlink()
    filestream = container.get_archive(client_image_path)[0]
    # unpack the tarfile in memory
    bytestream = io.BytesIO(b"".join(chunk for chunk in filestream))
    bytestream.seek(0)
    tar = tarfile.open(fileobj=bytestream)
    container_image = tar.extractfile(tar.getmembers()[0].name)
    if container_image is None:
        raise Exception("Failed to extract image from tarfile")
    with open(host_image_path, "wb+") as f:
        f.write(container_image.read())

create_driver(port)

Creates a selenium webdriver instance

Parameters:

Name	Type	Description	Default
port	int	The port to connect to	required

Returns:

Type	Description
Remote	webdriver.Remote: The created webdriver instance

Source code in src/node_deployer/autoignition.py

def create_driver(port: int) -> webdriver.Remote:
    """Creates a selenium webdriver instance

    Args:
        port (int): The port to connect to

    Returns:
        webdriver.Remote: The created webdriver instance
    """
    driver = webdriver.Remote(
        f"http://127.0.0.1:{port}",
        options=webdriver.FirefoxOptions(),
    )
    driver.implicitly_wait(10)
    return driver

json_to_img(json_path=Path('fuelignition.json'), img_path=Path('ignition.img'), debug=False)

Converts a fuel-ignition json file to an ignition disk image file

Parameters:

Name	Type	Description	Default
json_path	Annotated[ Path, typer.Option	The path to the fuel-ignition json file. Defaults to Path("fuelignition.json").	Path('fuelignition.json')
img_path	Annotated[ Path, typer.Option	The path to the output ignition disk image file. Defaults to Path("ignition.img").	Path('ignition.img')
debug	Annotated[ bool, typer.Option	Enable debug mode. Defaults to False.	False

Raises:

Type	Description
e	Any exception raised during execution

Source code in src/node_deployer/autoignition.py

@debug_guard
@cli_spinner(description="Converting json to img", total=None)
@ensure_build_dir
def json_to_img(
    json_path: Annotated[
        Path,
        typer.Option(
            "--json-path",
            "-i",
            help="The fuel-ignition json for configuring the disk image",
            prompt=True,
            exists=True,
            dir_okay=False,
        ),
    ] = Path("fuelignition.json"),
    img_path: Annotated[
        Path,
        typer.Option(
            "--img-path",
            "-o",
            help="The file to output the disk image to",
            prompt=True,
            dir_okay=False,
            writable=True,
            readable=False,
        ),
    ] = Path("ignition.img"),
    debug: Annotated[
        bool,
        typer.Option(
            "--debug",
            help="Enable debug mode",
            is_eager=True,
            is_flag=True,
            flag_value=True,
            expose_value=config.DEBUG,
            hidden=not config.DEBUG,
        ),
    ] = False,
) -> None:
    """Converts a fuel-ignition json file to an ignition disk image file

    Args:
        json_path (Annotated[ Path, typer.Option, optional):
            The path to the fuel-ignition json file.
            Defaults to Path("fuelignition.json").
        img_path (Annotated[ Path, typer.Option, optional):
            The path to the output ignition disk image file.
            Defaults to Path("ignition.img").
        debug (Annotated[ bool, typer.Option, optional):
            Enable debug mode.
            Defaults to False.

    Raises:
        e: Any exception raised during execution
    """
    selenium_container = None
    fuelignition_container = None
    fuelignition_image = None
    try:
        driver_port = next_free_tcp_port(4444)
        # Initialise containers
        selenium_container = config.CLIENT.containers.run(
            "selenium/standalone-firefox:latest",
            detach=True,
            remove=True,
            network_mode="bridge",
            ports={4444: driver_port},
            mounts=[
                config.CWD_MOUNT,
            ],
        )
        while config.SELENIUM_INIT_MESSAGE not in selenium_container.logs().decode():
            time.sleep(0.1)
        fuelignition_image = build_fuelignition()
        fuelignition_container = config.CLIENT.containers.run(
            fuelignition_image,
            detach=True,
            remove=True,
            network_mode=f"container:{selenium_container.id}",
        )
        # Wait for the container to finish starting up
        while not fnmatch(
            fuelignition_container.logs().decode().strip().split("\n")[-1].strip(),
            config.FUELIGNITION_INIT_MESSAGE,
        ):
            time.sleep(0.1)
        # Now, create the webdriver and convert the json to an img
        driver = create_driver(driver_port)
        convert_json_via_fuelignition(selenium_container, driver, json_path, img_path)
        driver.quit()
    except Exception as e:
        raise e
    finally:
        if selenium_container is not None:
            selenium_image = selenium_container.image
            selenium_container.kill()
            if config.CLEANUP_IMAGES:
                selenium_image.remove(force=True)
        if fuelignition_container is not None:
            fuelignition_container.kill()
        if fuelignition_image is not None:
            if config.CLEANUP_IMAGES:
                fuelignition_image.remove(force=True)

---

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