From: Aleš Mrázek Date: Tue, 18 Jul 2023 08:17:03 +0000 (+0200) Subject: manager: use .yaml suffix for config files X-Git-Tag: v6.0.2~29^2~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1b9c68a7fe2e365fb37998d90b6b08aaae9dc564;p=thirdparty%2Fknot-resolver.git manager: use .yaml suffix for config files --- diff --git a/Dockerfile b/Dockerfile index b89140575..f0ac6ba24 100644 --- a/Dockerfile +++ b/Dockerfile @@ -43,7 +43,7 @@ RUN apt-get install -y /pkg/*/*.deb && \ rm -rf /var/lib/apt/lists/* && \ mkdir /config -COPY manager/etc/knot-resolver/config.docker.yml /config/config.yml +COPY manager/etc/knot-resolver/config.docker.yaml /config/config.yaml LABEL cz.knot-resolver.vendor="CZ.NIC" LABEL maintainer="knot-resolver-users@lists.nic.cz" @@ -52,4 +52,4 @@ LABEL maintainer="knot-resolver-users@lists.nic.cz" EXPOSE 53/UDP 53/TCP 443/TCP 853/TCP 5000/TCP ENTRYPOINT ["/usr/bin/knot-resolver"] -CMD ["-c", "/config/config.yml"] +CMD ["-c", "/config/config.yaml"] diff --git a/distro/pkg/deb/knot-resolver-manager.install b/distro/pkg/deb/knot-resolver-manager.install index 3ec23ee12..91068501b 100644 --- a/distro/pkg/deb/knot-resolver-manager.install +++ b/distro/pkg/deb/knot-resolver-manager.install @@ -1,4 +1,4 @@ -etc/knot-resolver/config.yml +etc/knot-resolver/config.yaml usr/lib/systemd/system/knot-resolver.service usr/share/bash-completion/completions/kresctl usr/share/fish/completions/kresctl.fish diff --git a/distro/pkg/deb/rules b/distro/pkg/deb/rules index 6f0526818..b707c4a35 100755 --- a/distro/pkg/deb/rules +++ b/distro/pkg/deb/rules @@ -42,7 +42,7 @@ override_dh_auto_build: override_dh_auto_install: DESTDIR="${PWD}/debian/tmp" ninja -v -C build_deb install dh_auto_install --buildsystem=pybuild --sourcedirectory manager - install -m 644 -D manager/etc/knot-resolver/config.yml debian/tmp/etc/knot-resolver/config.yml + install -m 644 -D manager/etc/knot-resolver/config.yaml debian/tmp/etc/knot-resolver/config.yaml install -m 644 -D manager/shell-completion/client.bash debian/tmp/usr/share/bash-completion/completions/kresctl install -m 644 -D manager/shell-completion/client.fish debian/tmp/usr/share/fish/completions/kresctl.fish diff --git a/distro/pkg/rpm/knot-resolver.spec b/distro/pkg/rpm/knot-resolver.spec index 1c92b4811..548ae65b8 100644 --- a/distro/pkg/rpm/knot-resolver.spec +++ b/distro/pkg/rpm/knot-resolver.spec @@ -228,7 +228,7 @@ mv %{buildroot}/%{_datadir}/doc/%{name}/* %{buildroot}/%{_pkgdocdir}/ # install knot-resolver-manager pushd manager %py3_install -install -m 644 -D etc/knot-resolver/config.yml %{buildroot}%{_sysconfdir}/knot-resolver/config.yml +install -m 644 -D etc/knot-resolver/config.yaml %{buildroot}%{_sysconfdir}/knot-resolver/config.yaml install -m 644 -D shell-completion/client.bash %{buildroot}%{_datarootdir}/bash-completion/completions/kresctl install -m 644 -D shell-completion/client.fish %{buildroot}%{_datarootdir}/fish/completions/kresctl.fish @@ -330,7 +330,7 @@ getent passwd knot-resolver >/dev/null || useradd -r -g knot-resolver -d %{_sysc %files -n knot-resolver-manager %{python3_sitearch}/knot_resolver_manager* -%{_sysconfdir}/knot-resolver/config.yml +%{_sysconfdir}/knot-resolver/config.yaml %{_unitdir}/knot-resolver.service %{_bindir}/kresctl %{_bindir}/knot-resolver diff --git a/manager/etc/knot-resolver/config.dev.yml b/manager/etc/knot-resolver/config.dev.yaml similarity index 100% rename from manager/etc/knot-resolver/config.dev.yml rename to manager/etc/knot-resolver/config.dev.yaml diff --git a/manager/etc/knot-resolver/config.docker.yml b/manager/etc/knot-resolver/config.docker.yaml similarity index 100% rename from manager/etc/knot-resolver/config.docker.yml rename to manager/etc/knot-resolver/config.docker.yaml diff --git a/manager/etc/knot-resolver/config.example.internal.yaml b/manager/etc/knot-resolver/config.example.internal.yaml new file mode 100644 index 000000000..859de8f51 --- /dev/null +++ b/manager/etc/knot-resolver/config.example.internal.yaml @@ -0,0 +1,63 @@ +rundir: ./runtime +workers: 1 +management: + interface: 127.0.0.1@5000 +cache: + storage: ./cache +logging: + level: notice + groups: + - manager + - supervisord +network: + listen: + - interface: 127.0.0.1@5353 +views: + - subnets: [127.0.0.0/24] + tags: [t01, t02, t03] + options: + dns64: false + - subnets: [0.0.0.0/0, "::/0"] + answer: refused + - subnets: [10.0.10.0/24] + answer: allow +local-data: + ttl: 60m + nodata: false + root-fallback-addresses: + j.root-servers.net.: ["2001:503:c27::2:30", "192.58.128.30"] + l.root-servers.net.: '199.7.83.42' + m.root-servers.net.: '202.12.27.33' + # root-fallback-addresses-files: root.custom + addresses: + foo.bar: 127.0.0.1 + # addresses-files: hosts.custom + records: | + example.net. TXT "foo bar" + A 192.168.2.3 + A 192.168.2.4 + local.example.org AAAA ::1 + subtrees: + - type: empty + tags: [ t2 ] + roots: [ example1.org ] + - type: nxdomain + roots: [ sub4.example.org ] + rpz: + - file: runtime/blocklist.rpz + tags: [t01, t02] +forward: + - subtree: '.' + options: + dnssec: true + authoritative: false + servers: + - address: [2001:148f:fffe::1, 185.43.135.1] + transport: tls + hostname: odvr.nic.cz + - address: [ 192.0.2.1, 192.0.2.2 ] + pin-sha256: ['YQ==', 'Wg=='] + - subtree: 1.168.192.in-addr.arpa + options: + dnssec: false + servers: [ 192.0.2.1@5353 ] diff --git a/manager/etc/knot-resolver/config.yml b/manager/etc/knot-resolver/config.yaml similarity index 100% rename from manager/etc/knot-resolver/config.yml rename to manager/etc/knot-resolver/config.yaml diff --git a/manager/knot_resolver_manager/constants.py b/manager/knot_resolver_manager/constants.py index f9f73449b..a502267b9 100644 --- a/manager/knot_resolver_manager/constants.py +++ b/manager/knot_resolver_manager/constants.py @@ -10,7 +10,7 @@ if TYPE_CHECKING: from knot_resolver_manager.kresd_controller.interface import KresID STARTUP_LOG_LEVEL = logging.DEBUG -DEFAULT_MANAGER_CONFIG_FILE = Path("/etc/knot-resolver/config.yml") +DEFAULT_MANAGER_CONFIG_FILE = Path("/etc/knot-resolver/config.yaml") MANAGER_FIX_ATTEMPT_MAX_COUNTER = 2 FIX_COUNTER_DECREASE_INTERVAL_SEC = 30 * 60 PID_FILE_NAME = "manager.pid" diff --git a/manager/meson.build b/manager/meson.build index c80301dce..476532e5b 100644 --- a/manager/meson.build +++ b/manager/meson.build @@ -31,7 +31,7 @@ if build_manager # YAML config configuration file install_data( - sources: 'etc/knot-resolver/config.yml', + sources: 'etc/knot-resolver/config.yaml', install_dir: etc_dir, ) endif \ No newline at end of file diff --git a/manager/scripts/run b/manager/scripts/run index d9c7d28f2..043738aad 100755 --- a/manager/scripts/run +++ b/manager/scripts/run @@ -26,4 +26,4 @@ echo echo Knot Manager API is accessible on http://localhost:5000 echo ------------------------------------------------------- -python3 -m knot_resolver_manager -c etc/knot-resolver/config.dev.yml $@ +python3 -m knot_resolver_manager -c etc/knot-resolver/config.dev.yaml $@ diff --git a/manager/tests/integration/runner.py b/manager/tests/integration/runner.py index f4ea0f26b..000d7ae81 100644 --- a/manager/tests/integration/runner.py +++ b/manager/tests/integration/runner.py @@ -17,7 +17,7 @@ logger = logging.getLogger(__name__) def test_wrapper(test: Test) -> bool: - p = start_manager_in_background(Path("tests/integration/config.yml")) + p = start_manager_in_background(Path("tests/integration/config.yaml")) client = KnotManagerClient(BASE_URL) client.wait_for_initialization() @@ -64,7 +64,7 @@ def crash_resistance(client: KnotManagerClient): assert cnt == 2, f"Expected 2 kresd instances, found {cnt}" # start the server again - p = start_manager_in_background(Path("test/integration/config.yml")) + p = start_manager_in_background(Path("test/integration/config.yaml")) try: client.wait_for_initialization() except TimeoutError as e: diff --git a/systemd/knot-resolver.service.in b/systemd/knot-resolver.service.in index a68867005..5ed4fb73c 100644 --- a/systemd/knot-resolver.service.in +++ b/systemd/knot-resolver.service.in @@ -9,7 +9,7 @@ Wants=nss-lookup.target [Service] Type=notify TimeoutStartSec=10s -ExecStart=@bin_dir@/knot-resolver --config=@etc_dir@/config.yml +ExecStart=@bin_dir@/knot-resolver --config=@etc_dir@/config.yaml ExecReload=@bin_dir@/kresctl --socket @run_dir@/manager.sock reload KillSignal=SIGINT WorkingDirectory=@systemd_work_dir@