TFTP feature

Author: stejskalleos

.github/workflows/test.yml

@@ -159,6 +159,7 @@ jobs:
             --add-feature google \
             --add-feature remote-execution \
             --add-feature bmc \
+            --add-feature tftp \
             ${{ matrix.iop == 'enabled' && '--add-feature iop' || '' }}
       - name: Run health check
         run: |

docs/user/parameters.md

@@ -111,6 +111,11 @@ There are multiple use cases from the users perspective that dictate what parame
 | --------- | ----------- | ---------------------------- |
 | `--bmc-ipmi-implementation` | IPMI implementation to use for BMC | `--foreman-proxy-bmc-default-provider` |
 | `--bmc-redfish-verify-ssl` | Verify SSL certificates for Redfish BMC connections | `--foreman-proxy-bmc-redfish-verify-ssl` |
+| `--add-feature tftp` | Enable TFTP feature | `--foreman-proxy-tftp` |
+| `--tftp-servername` | | `--foreman-proxy-tftp-servername` |
+| `--tftp-root` | Directory for TFTP | `--foreman-proxy-tftp-root` |
+| `--tftp-connect-timeout` | Connection timeout in seconds needed to download tftp artifacts, like initrd and vmlinuz. | |
+| `--tftp-verify-server-cert` | Verify server certificate when downloading tftp artifacts. When false, the argument `--no-check-certificate` will be used. | |
 
 ### Undetermined
 
@@ -143,10 +148,7 @@ There are multiple use cases from the users perspective that dictate what parame
 | `--foreman-proxy-plugin-dns-route53-aws-access-key` | | foreman_proxy::plugin::dns_route53 | aws_access_key |
 | `--foreman-proxy-plugin-dns-route53-aws-secret-key` | | foreman_proxy::plugin::dns_route53 | aws_secret_key |
 | `--foreman-proxy-httpboot` | | foreman_proxy | httpboot |
-| `--foreman-proxy-tftp` | | foreman_proxy | tftp |
-| `--foreman-proxy-tftp-servername` | | foreman_proxy | tftp_servername |
 | `--foreman-proxy-tftp-managed` | | foreman_proxy | tftp_managed |
-| `--foreman-proxy-tftp-root` | | foreman_proxy | tftp_root |
 | `--foreman-proxy-plugin-dhcp-remote-isc-dhcp-config` | | foreman_proxy::plugin::dhcp_remote_isc | config |
 | `--foreman-proxy-plugin-dhcp-remote-isc-dhcp-leases` | | foreman_proxy::plugin::dhcp_remote_isc | dhcp_config |
 | `--foreman-proxy-plugin-dhcp-remote-isc-key-name` | | foreman_proxy::plugin::dhcp_remote_isc | key_name |

src/features.yaml

@@ -58,3 +58,7 @@ bmc:
   description: Power management for bare metal hosts (IPMI, Redfish)
   foreman_proxy:
     plugin_name: bmc
+tftp:
+  description: Enable TFTP feature on Foreman Proxy
+  foreman_proxy:
+    plugin_name: tftp

src/playbooks/deploy/metadata.obsah.yaml

@@ -56,6 +56,20 @@ variables:
     parameter: --bmc-redfish-verify-ssl
     help: Verify SSL certificates for Redfish BMC connections.
     type: Boolean
+  foreman_proxy_tftp_root:
+    parameter: --tftp-root
+    help: Directory to serve TFTP files from.
+    type: AbsolutePath
+  foreman_proxy_tftp_servername:
+    parameter: --tftp-servername
+    help: Server name to use for TFTP.
+  foreman_proxy_tftp_connect_timeout:
+    parameter: --tftp-connect-timeout
+    help: Connection timeout in seconds needed to download tftp artifacts, like initrd and vmlinuz.
+  foreman_proxy_tftp_verify_server_cert:
+    parameter: --tftp-verify-server-cert
+    help: Verify server certificate when downloading tftp artifacts. When false, the argument `--no-check-certificate` will be used.
+    type: Boolean
 
 constraints:
   required_together:

src/roles/foreman_proxy/defaults/main.yaml

@@ -23,3 +23,9 @@ foreman_proxy_foreman_server_url: "https://{{ ansible_facts['fqdn'] }}"
 # BMC settings
 foreman_proxy_bmc_ipmi_implementation: ipmitool
 foreman_proxy_bmc_redfish_verify_ssl: true
+
+# TFTP settings
+foreman_proxy_tftp_root: /var/lib/tftpboot
+foreman_proxy_tftp_servername: "{{ ansible_facts['fqdn'] }}"
+foreman_proxy_tftp_connect_timeout: 10
+foreman_proxy_tftp_verify_server_cert: false

src/roles/foreman_proxy/tasks/feature/tftp.yaml

@@ -0,0 +1,11 @@
+---
+- name: Create TFTP root directory
+  ansible.builtin.file:
+    path: "{{ foreman_proxy_tftp_root }}"
+    state: directory
+    mode: '0750'
+    owner: root
+    group: root
+  notify:
+    - Restart Foreman Proxy
+    - Refresh Foreman Proxy

src/roles/foreman_proxy/templates/settings.d/tftp.yml.j2

@@ -0,0 +1,6 @@
+---
+:enabled: {{ feature_enabled }}
+:tftproot: {{ foreman_proxy_tftp_root }}
+:tftp_servername: {{ foreman_proxy_tftp_servername }}
+:tftp_connect_timeout: {{ foreman_proxy_tftp_connect_timeout }}
+:verify_server_cert: {{ foreman_proxy_tftp_verify_server_cert }}