Can't get user_overrides.yml with custom_generate_menus to work on Docker

[bartvdbraak]

So let me be clear, I am aware that I must be doing something wrong and I've been through a bunch of documentation to try and fix it. I'd like to ask the community cause maybe I'm unnecessarily overcomplicating things.

What I wanna achieve is:

• Run netboot.xyz via Docker (and Docker Compose)
• Use custom site_name, boot_domain and live_endpoint
• Setup custom menus

How I tried to do it was:

1. Create build directory with contents from upstream repo, my own custom directory and a user_overrides.yml
2. Create Docker Compose configuration with Build context pointing to build directory and bind mounting it as /buildout

However, when trying to do this, I get a container image that quits immediately without running what I am expecting it to:

root@bootserver:/netbootxyz# docker ps
CONTAINER ID   IMAGE                     COMMAND                  CREATED             STATUS                                  PORTS                                                                          NAMES
a500c080fce8   netbootxyz-netbootxyz     "/dumper.sh"             3 seconds ago       Restarting (0) Less than a second ago                                                                                  netbootxyz

Any idea where I went wrong?

---

My Ansible role is made up of:

├── defaults
│   └── main.yml
├── files
│   └── custom
│       ├── custom.ipxe
│       ├── linux.ipxe
│       ├── menu.ipxe
│       ├── rockylinux.ipxe
│       ├── ubuntu.ipxe
│       └── windows.ipxe
├── tasks
│   └── main.yml
└── templates
    ├── docker-compose.yml.j2
    └── user_overrides.yml.j2

defaults/main.yml:

---
# netbootxyz_image: ghcr.io/netbootxyz/netbootxyz:0.7.6-nbxyz10@sha256:8d0fa09dd59e334829432c326449ec28cd81b053d1170dc37870dfe3561caafd
netbootxyz_traefik_image: traefik:3.6.1@sha256:2ba9a6e99daf342de4268279e3f90cdfc1f9d33349b04384be145247a1ef3871
netbootxyz_samba_image: dockurr/samba:4.23.5@sha256:7ff8e8babef75beb8c36b1a64d479d13bbe7a739aae603e2361d7afe0adba298
# netbootxyz_domain: example.com
netbootxyz_root_dir: /netbootxyz
netbootxyz_repo_dir: "{{ netbootxyz_root_dir }}/repo"
netbootxyz_build_dir: "{{ netbootxyz_root_dir }}/build"
netbootxyz_repo_url: https://github.com/netbootxyz/netboot.xyz.git
netbootxyz_repo_version: 3.0.0
netbootxyz_uid: 1000
netbootxyz_gid: 1000
netbootxyz_samba_dir: "{{ netbootxyz_root_dir }}/windows"
netbootxyz_samba_share: Windows
netbootxyz_samba_username: example
# netbootxyz_samba_password:
netbootxyz_samba_uid: 1000
netbootxyz_samba_gid: 1000

tasks/main.yml:

---
- name: Ensure directories exists
  ansible.builtin.file:
    path: "{{ item.path }}"
    state: directory
    owner: "{{ item.uid }}"
    group: "{{ item.gid }}"
    mode: "0750"
  with_items:
    - path: "{{ netbootxyz_root_dir }}"
      uid: "{{ ansible_facts['user_id'] }}"
      gid: "{{ ansible_facts['user_gid'] }}"
    - path: "{{ netbootxyz_build_dir }}"
      uid: "{{ netbootxyz_uid }}"
      gid: "{{ netbootxyz_gid }}"
    - path: "{{ netbootxyz_repo_dir }}"
      uid: "{{ netbootxyz_uid }}"
      gid: "{{ netbootxyz_gid }}"
    - path: "{{ netbootxyz_samba_dir }}"
      uid: "{{ netbootxyz_samba_uid }}"
      gid: "{{ netbootxyz_samba_gid }}"

- name: Template user overrides in build directory
  ansible.builtin.template:
    src: "user_overrides.yml.j2"
    dest: "{{ netbootxyz_build_dir }}/user_overrides.yml"
    mode: "0644"
    owner: "{{ netbootxyz_uid }}"
    group: "{{ netbootxyz_gid }}"

- name: Add custom menus to build directory
  ansible.builtin.copy:
    src: "custom/"
    dest: "{{ netbootxyz_build_dir }}/custom"
    mode: "0644"
    owner: "{{ netbootxyz_uid }}"
    group: "{{ netbootxyz_gid }}"

- name: Clone netboot.xyz
  ansible.builtin.git:
    repo: "{{ netbootxyz_repo_url }}"
    dest: "{{ netbootxyz_repo_dir }}"
    version: "{{ netbootxyz_repo_version }}"
    update: true

- name: Rsync to build directory
  ansible.posix.synchronize:
    src: "{{ netbootxyz_repo_dir }}/"
    dest: "{{ netbootxyz_build_dir }}"
    rsync_opts:
      - "--exclude=custom/"
      - "--exclude=user_overrides.yml"
      - "--exclude=.git/"
    recursive: true
    delete: false
  delegate_to: "{{ inventory_hostname }}"

- name: Template Docker Compose file for Netboot.xyz
  ansible.builtin.template:
    src: docker-compose.yml.j2
    dest: "{{ netbootxyz_root_dir }}/docker-compose.yml"
    owner: "{{ ansible_facts['user_id'] }}"
    group: "{{ ansible_facts['user_gid'] }}"
    mode: "0750"

- name: Docker Compose up for Netboot.xyz
  community.docker.docker_compose_v2:
    project_src: "{{ netbootxyz_root_dir }}"
    build: always
    remove_orphans: true

templates/docker-compose.yml.j2:

---
services:
  traefik:
    image: {{ netbootxyz_traefik_image }}
    container_name: traefik
    restart: unless-stopped
    ports:
      - 80:80
      - 443:443
    command:
      - '--ping'
      - '--log.level=INFO'
      - '--providers.docker=true'
      - '--providers.docker.exposedbydefault=false'
      - '--entrypoints.web.address=:80'
    healthcheck:
      test: traefik healthcheck --ping
    volumes:
      - '/var/run/docker.sock:/var/run/docker.sock:ro'

  netbootxyz:
    build: {{ netbootxyz_build_dir }}
    container_name: netbootxyz
    environment:
      - NGINX_PORT=80
      - WEB_APP_PORT=3000
    volumes:
      - {{ netbootxyz_build_dir }}:/buildout
      - ./config:/config
      - ./assets:/assets
    ports:
      - 69:69/udp
      - 8080:80
    restart: unless-stopped
    labels:
      - 'traefik.enable=true'
      - 'traefik.http.routers.boot.rule=Host(`{{ netbootxyz_domain }}`)'
      - 'traefik.http.routers.boot.entrypoints=web'
      - 'traefik.http.services.boot.loadbalancer.server.port=3000'
      - 'traefik.http.middlewares.boot-auth.basicauth.users={{ netbootxyz_auth }}' # echo $(htpasswd -nB user) | sed -e s/\\$/\\$\\$/g
      - 'traefik.http.routers.boot.middlewares=boot-auth'

  samba:
    image: {{ netbootxyz_samba_image }}
    container_name: samba
    environment:
      NAME: "{{ netbootxyz_samba_share }}"
      USER: "{{ netbootxyz_samba_username }}"
      PASS: "{{ netbootxyz_samba_password }}"
      UID: "{{ netbootxyz_samba_uid }}"
      GID: "{{ netbootxyz_samba_gid }}"
    ports:
      - 445:445
    volumes:
      - {{ netbootxyz_samba_dir }}:/storage
    restart: unless-stopped

templates/user_overrides.yml.j2

---
# https://github.com/netbootxyz/netboot.xyz/blob/master/roles/netbootxyz/defaults/main.yml
generate_menus: true
generate_disks: true
generate_checksums: true
generate_local_vars: true
make_num_jobs: 4

site_name: {{ netbootxyz_domain }}
boot_domain: boot.{{ netbootxyz_domain }}
live_endpoint: https://boot-assets.{{ netbootxyz_domain }}

custom_generate_menus: true
custom_templates_dir: "/ansible/custom"