Initial commit of dhcpd/tftpd role
Change-Id: Ia6526e593100c9bbe935347105c5b3932f5e2641
diff --git a/.cookiecutter_params.json b/.cookiecutter_params.json
new file mode 100644
index 0000000..12075ef
--- /dev/null
+++ b/.cookiecutter_params.json
@@ -0,0 +1,24 @@
+{
+ "_template": "../cookiecutters/role",
+ "author": "Open Networking Foundation",
+ "company": "Open Networking Foundation",
+ "description": "DHCP server and optional TFTP server",
+ "email": "support@opennetworking.org",
+ "issue_tracker_url": "https://jira.opennetworking.org/",
+ "license": "Apache-2.0",
+ "min_ansible_version": "2.9.5",
+ "molecule_privileged": "true",
+ "platform": "deleteme",
+ "platforms": {
+ "Ubuntu": [
+ "16.04",
+ "18.04"
+ ]
+ },
+ "role_defaults": {
+ "example_default1": "example_value1",
+ "example_default2": "example_value2"
+ },
+ "role_name": "dhcpd",
+ "year": "2020"
+}
diff --git a/.gitreview b/.gitreview
new file mode 100644
index 0000000..b51c8cf
--- /dev/null
+++ b/.gitreview
@@ -0,0 +1,5 @@
+[gerrit]
+host=gerrit.opencord.org
+port=29418
+project=ansible/role/dhcpd.git
+defaultremote=origin
diff --git a/.reuse/dep5 b/.reuse/dep5
new file mode 100644
index 0000000..36ce305
--- /dev/null
+++ b/.reuse/dep5
@@ -0,0 +1,5 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+
+Files: .cookiecutter_params.json VERSION .gitreview
+Copyright: 2020 Open Networking Foundation
+License: Apache-2.0
diff --git a/LICENSES/Apache-2.0.txt b/LICENSES/Apache-2.0.txt
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSES/Apache-2.0.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..b16ce20
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,39 @@
+# dhcpd Makefile
+#
+# SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+SHELL = bash -eu -o pipefail
+
+.DEFAULT_GOAL := help
+.PHONY: test lint yamllint ansiblelint license help
+
+test: ## run tests on the playbook with molecule
+ molecule --version
+ molecule test
+
+lint: yamllint ansiblelint ## run all lint checks
+
+# all YAML files
+YAML_FILES ?= $(shell find . -type f \( -name '*.yaml' -o -name '*.yml' \) -print )
+
+yamllint: ## lint check with yamllint
+ yamllint --version
+ yamllint \
+ -d "{extends: default, rules: {line-length: {max: 99}}}" \
+ -s $(YAML_FILES)
+
+ansiblelint: ## lint check with ansible-lint
+ ansible-lint --version
+ ansible-lint -v .
+ ansible-lint -v molecule/*/*
+
+license: ## Check license with the reuse tool
+ reuse --version
+ reuse --root . lint
+
+help: ## Print help for each target
+ @echo dhcpd test targets
+ @echo
+ @grep '^[[:alnum:]_-]*:.* ##' $(MAKEFILE_LIST) \
+ | sort | awk 'BEGIN {FS=":.* ## "}; {printf "%-25s %s\n", $$1, $$2};'
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..230a9e8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+<!--
+SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
+SPDX-License-Identifier: Apache-2.0
+--!>
+# dhcpd
+
+Installs/configure a DHCP server and TFTP server
+
+## dhcpd
+
+Documentation:
+
+- https://kb.isc.org/docs/isc-dhcp-44-manual-pages-dhcpd
+- https://kb.isc.org/docs/isc-dhcp-44-manual-pages-dhcpdconf
+- https://kb.isc.org/docs/isc-dhcp-44-manual-pages-dhcp-options
+
+## tftpd
+
+Documentation is scarce. Upstream source repo:
+
+- https://git.kernel.org/pub/scm/network/tftp/tftp-hpa.git
+
+
+## Requirements
+
+Minimum ansible version: 2.9.5
+
+
+## Example Playbook
+
+```yaml
+- hosts: all
+ vars:
+ dhcpd_interfaces:
+ - eth0
+ dhcpd_subnets:
+ - subnet: "192.168.0.1/24"
+ range: "192.168.0.128/25"
+ dns_servers:
+ - "192.168.0.1"
+ - "192.168.0.2"
+ dns_search:
+ - "example.com"
+ tftpd_server: "192.168.0.1"
+ hosts:
+ - name: "dns"
+ ip_addr: "192.168.0.2"
+ mac_addr: "a1:b2:c3:d4:e5:f6"
+
+ roles:
+ - dhcpd
+
+```
+
+## License and Author
+
+© 2020 Open Networking Foundation <support@opennetworking.org>
+
+License: Apache-2.0
diff --git a/VERSION b/VERSION
new file mode 100644
index 0000000..c0ab82c
--- /dev/null
+++ b/VERSION
@@ -0,0 +1 @@
+0.0.1-dev
diff --git a/defaults/main.yml b/defaults/main.yml
new file mode 100644
index 0000000..d0a5403
--- /dev/null
+++ b/defaults/main.yml
@@ -0,0 +1,20 @@
+---
+# dhcpd defaults/main.yml
+#
+# SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+## dhcpd config
+
+# interfaces to listen on
+dhcpd_interfaces: []
+
+# subnets to serve DHCP on
+dhcpd_subnets: []
+
+# default PXE filename
+dhcpd_pxe_filename: "undionly.kpxe"
+
+## tftpd config
+# files to copy to the TFTP server
+tftpd_files: []
diff --git a/handlers/main.yml b/handlers/main.yml
new file mode 100644
index 0000000..6fbce94
--- /dev/null
+++ b/handlers/main.yml
@@ -0,0 +1,10 @@
+---
+# dhcpd handlers/main.yml
+#
+# SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+- name: dhcpd-restart
+ service:
+ name: "{{ dhcpd_service }}"
+ state: restarted
diff --git a/meta/main.yml b/meta/main.yml
new file mode 100644
index 0000000..72453d3
--- /dev/null
+++ b/meta/main.yml
@@ -0,0 +1,27 @@
+---
+# dhcpd meta/main.yml
+#
+# SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+galaxy_info:
+ author: Open Networking Foundation
+ description: DHCP server and optional TFTP server
+ company: Open Networking Foundation
+
+ issue_tracker_url: https://jira.opennetworking.org/
+
+ license: Apache-2.0
+
+ min_ansible_version: 2.9.5
+
+ platforms:
+ - name: Ubuntu
+ versions:
+ - "16.04"
+ - "18.04"
+
+ galaxy_tags:
+ - dhcpd
+
+dependencies: []
diff --git a/molecule/default/converge.yml b/molecule/default/converge.yml
new file mode 100644
index 0000000..b95c131
--- /dev/null
+++ b/molecule/default/converge.yml
@@ -0,0 +1,12 @@
+---
+# dhcpd molecule/default/verify.yml
+#
+# SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+- name: Converge
+ hosts: all
+ tasks:
+ - name: "Include dhcpd"
+ include_role:
+ name: "dhcpd"
diff --git a/molecule/default/molecule.yml b/molecule/default/molecule.yml
new file mode 100644
index 0000000..ae3ffd0
--- /dev/null
+++ b/molecule/default/molecule.yml
@@ -0,0 +1,25 @@
+---
+# dhcpd molecule/default/molecule.yml
+#
+# SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+dependency:
+ name: galaxy
+driver:
+ name: docker
+platforms:
+ - name: "ubuntu-16.04-priv"
+ image: "quay.io/paulfantom/molecule-systemd:ubuntu-16.04"
+ privileged: true
+ volumes:
+ - "/sys/fs/cgroup:/sys/fs/cgroup:ro"
+ - name: "ubuntu-18.04-priv"
+ image: "quay.io/paulfantom/molecule-systemd:ubuntu-18.04"
+ privileged: true
+ volumes:
+ - "/sys/fs/cgroup:/sys/fs/cgroup:ro"
+provisioner:
+ name: ansible
+verifier:
+ name: ansible
diff --git a/molecule/default/verify.yml b/molecule/default/verify.yml
new file mode 100644
index 0000000..1a4bfdc
--- /dev/null
+++ b/molecule/default/verify.yml
@@ -0,0 +1,12 @@
+---
+# dhcpd molecule/default/verify.yml
+#
+# SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+- name: Verify
+ hosts: all
+ tasks:
+ - name: example assertion
+ assert:
+ that: true
diff --git a/tasks/Debian.yml b/tasks/Debian.yml
new file mode 100644
index 0000000..99692cc
--- /dev/null
+++ b/tasks/Debian.yml
@@ -0,0 +1,22 @@
+---
+# dhcpd tasks/Debian.yml
+#
+# SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+- name: Install dhcpd and tftp packages (Debian)
+ apt:
+ name:
+ - "isc-dhcp-server"
+ - "tftpd-hpa"
+ state: "present"
+ update_cache: true
+ cache_valid_time: 3600
+
+- name: Set dhcpd listening interfaces
+ lineinfile:
+ path: "/etc/default/isc-dhcp-server"
+ line: "INTERFACESv4=\"{{ dhcpd_interfaces | join(' ') }}\""
+ regex: "^INTERFACESv4=.*"
+ notify:
+ - "dhcpd-restart"
diff --git a/tasks/main.yml b/tasks/main.yml
new file mode 100644
index 0000000..a030609
--- /dev/null
+++ b/tasks/main.yml
@@ -0,0 +1,44 @@
+---
+# dhcpd tasks/main.yml
+#
+# SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+- name: include OS-specific vars
+ include_vars: "{{ ansible_os_family }}.yml"
+
+- name: include OS-specific tasks
+ include_tasks: "{{ ansible_os_family }}.yml"
+
+- name: Create dhcpd.conf from template
+ template:
+ src: dhcpd.conf.j2
+ dest: "{{ dhcpd_config_dir }}/dhcpd.conf"
+ backup: true
+ mode: "0644"
+ owner: root
+ group: root
+ # validate: 'dhcpd -t -cf %s' # Does not work...
+ notify:
+ - dhcpd-restart
+
+- name: Copy tftpd served files
+ copy:
+ src: "{{ item }}"
+ dest: "{{ tftpd_boot_dir }}/{{ item }}"
+ owner: root
+ group: "{{ tftpd_groupname }}"
+ mode: "0644"
+ with_items: "{{ tftpd_files }}"
+
+- name: Enable and start dhcpd
+ service:
+ name: "{{ dhcpd_service }}"
+ enabled: true
+ state: started
+
+- name: Enable and start tftpd
+ service:
+ name: "{{ tftpd_service }}"
+ enabled: true
+ state: started
diff --git a/templates/dhcpd.conf.j2 b/templates/dhcpd.conf.j2
new file mode 100644
index 0000000..2ed3420
--- /dev/null
+++ b/templates/dhcpd.conf.j2
@@ -0,0 +1,54 @@
+# dhcpd templates/dhcpd.conf.j2 - {{ ansible_managed }}
+{#
+SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
+SPDX-License-Identifier: Apache-2.0
+#}
+
+# global lease options
+default-lease-time {{ subnet.lease_time | default("240") }};
+max-lease-time {{ subnet.max_lease_time | default("480") }};
+
+{% for subnet in dhcpd_subnets %}
+subnet {{ subnet.subnet | ipaddr('network') }} netmask {{ subnet.subnet | ipaddr('netmask') }} {
+
+ # routing
+{% if subnet.routers is defined %}
+ option routers {{ subnet.routers }};
+{% else %}
+ option routers {{ subnet.subnet | ipaddr('next_usable') }};
+{% endif %}
+
+ # DNS/naming options
+ option domain-name-servers {{ subnet.dns_servers | join(", ") }};
+ option domain-name "{{ subnet.dns_search [0] }}";
+ option domain-search "{{ subnet.dns_search | join('", "') }}";
+
+{% if subnet.tftpd_server is defined %}
+ # tftpd options
+ filename "{{ subnet.pxe_filename | default(dhcpd_pxe_filename) }}";
+ next-server {{ subnet.tftpd_server }};
+
+{% endif %}
+{% if subnet.range is defined %}
+ range {{ subnet.range | ipaddr('next_usable') }} {{ subnet.range | ipaddr('last_usable') }};
+
+{% endif %}
+{% if subnet.hosts is defined %}
+ # hosts
+{% for host in subnet.hosts %}
+ host {{ host.name }} {
+ option host-name "{{ host.name }}";
+ fixed-address {{ host.ip_addr }};
+ hardware ethernet {{ host.mac_addr | hwaddr('linux') }};
+{% if host.pxe_filename is defined %}
+ filename "{{ host.pxe_filename }}";
+{% endif %}
+{% if host.default_url is defined %}
+ option default-url "{{ host.default_url }}";
+{% endif %}
+ }
+
+{% endfor %}
+{% endif %}
+}
+{% endfor %}
diff --git a/vars/Debian.yml b/vars/Debian.yml
new file mode 100644
index 0000000..5a1a5f8
--- /dev/null
+++ b/vars/Debian.yml
@@ -0,0 +1,15 @@
+---
+# dhcpd vars/Debian.yml
+#
+# SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+#
+# NOTE: Only put platform/OS-specific variables in this file.
+# Put all other variables in the 'defaults/main.yml' file.
+
+dhcpd_service: "isc-dhcp-server"
+dhcpd_config_dir: "/etc/dhcp"
+
+tftpd_service: "tftpd-hpa"
+tftpd_groupname: "tftp"
+tftpd_boot_dir: "/var/lib/tftpboot"