Bug#985616: Document change to unbound ".d" config file fragment behavior

2021-03-23 Thread Justin B Rye
Paul Gevers wrote:
>>   
>> Config file fragment handling in unbound
>> 
>>   The DNS resolver unbound
>>   has changed the way it handles configuration file fragments. If
>>   you are relying on an include: directive to
>>   merge several fragments into a valid configuration, you should
>>   read >   url="https://sources.debian.org/src/unbound/1.13.1-1/debian/NEWS/;>the
> 
> To be slightly more robust, should we replace 1.13.1-1 with bullseye?
> https://sources.debian.org/src/unbound/bullseye/debian/NEWS/ seems to
> work as intended.

Good idea!
-- 
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package



Bug#985616: Document change to unbound ".d" config file fragment behavior

2021-03-23 Thread Paul Gevers
Hi,

On 22-03-2021 17:34, Justin B Rye wrote:
> Andrei POPESCU wrote:
>> The NEWS file is also available online:
>>
>> https://sources.debian.org/src/unbound/1.13.1-1/debian/NEWS/
> 
> That's a better idea than the alternative I was considering, which was
> to point at this bug report.  So we could cut it all the way down to
> something like:
> 
>   
> Config file fragment handling in unbound
> 
>   The DNS resolver unbound
>   has changed the way it handles configuration file fragments. If
>   you are relying on an include: directive to
>   merge several fragments into a valid configuration, you should
>   readurl="https://sources.debian.org/src/unbound/1.13.1-1/debian/NEWS/;>the

To be slightly more robust, should we replace 1.13.1-1 with bullseye?
https://sources.debian.org/src/unbound/bullseye/debian/NEWS/ seems to
work as intended.

>   NEWS file.
> 
>   

Paul



OpenPGP_signature
Description: OpenPGP digital signature


Bug#985616: Document change to unbound ".d" config file fragment behavior

2021-03-22 Thread Andrei POPESCU
On Lu, 22 mar 21, 16:34:00, Justin B Rye wrote:
> Andrei POPESCU wrote:
> > The NEWS file is also available online:
> > 
> > https://sources.debian.org/src/unbound/1.13.1-1/debian/NEWS/
> 
> That's a better idea than the alternative I was considering, which was
> to point at this bug report.  So we could cut it all the way down to
> something like:
> 
>   
> Config file fragment handling in unbound
> 
>   The DNS resolver unbound
>   has changed the way it handles configuration file fragments. If
>   you are relying on an include: directive to
>   merge several fragments into a valid configuration, you should
>   readurl="https://sources.debian.org/src/unbound/1.13.1-1/debian/NEWS/;>the
>   NEWS file.
> 
>   

LGTM FWIW.

Kind regards,
Andrei
-- 
http://wiki.debian.org/FAQsFromDebianUser


signature.asc
Description: PGP signature


Bug#985616: Document change to unbound ".d" config file fragment behavior

2021-03-22 Thread Justin B Rye
Andrei POPESCU wrote:
> The NEWS file is also available online:
> 
> https://sources.debian.org/src/unbound/1.13.1-1/debian/NEWS/

That's a better idea than the alternative I was considering, which was
to point at this bug report.  So we could cut it all the way down to
something like:

  
Config file fragment handling in unbound

  The DNS resolver unbound
  has changed the way it handles configuration file fragments. If
  you are relying on an include: directive to
  merge several fragments into a valid configuration, you should
  read https://sources.debian.org/src/unbound/1.13.1-1/debian/NEWS/;>the
  NEWS file.

  

-- 
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package



Bug#985616: Document change to unbound ".d" config file fragment behavior

2021-03-22 Thread Andrei POPESCU
On Lu, 22 mar 21, 14:33:25, Justin B Rye wrote:
> Andrei POPESCU wrote:
> > 
> > How about squeezing even further and pointing to the NEWS file instead 
> > (for those that have unbound installed, but not apt-listchanges). 
> 
> The problem is, that way the information they need to implement a fix
> only arrives on their system as part of the process that breaks their
> resolver.  That's less of a disaster than if the solution was only
> available online, but it still sounds annoying.

The NEWS file is also available online:

https://sources.debian.org/src/unbound/1.13.1-1/debian/NEWS/

Kind regards,
Andrei
-- 
http://wiki.debian.org/FAQsFromDebianUser


signature.asc
Description: PGP signature


Bug#985616: Document change to unbound ".d" config file fragment behavior

2021-03-22 Thread Justin B Rye
Andrei POPESCU wrote:
> On Du, 21 mar 21, 13:01:07, Justin B Rye wrote:
>> Robert Edmonds wrote:
>>> During the bullseye release cycle the default /etc/unbound/unbound.conf
>>> file was changed to use the newly introduced "include-toplevel:"
>>> directive rather than the "include:" directive. This should probably be
>>> mentioned in the bullseye release notes because it will break
>>> configurations where the user added a clauseless config file fragment to
>>> /etc/unbound/unbound.conf.d/.
>>> 
>>> The text from /usr/share/doc/unbound/NEWS.Debian.gz about this change is
>>> quoted below.
>> 
>> For the Release Notes we ought to add some material: people reading
>> the NEWS file can be assumed to have chosen to install unbound, but
>> this version needs to start by making it clear what unbound is (and
>> that if you haven't heard of it you don't need to read the technical
>> details).  Then after that we could squeeze things a bit:
> 
> [snip two paragraphs]
> 
>> Is that compressed too far?  I was hoping to fit the word "robustness"
>> somewhere.  Maybe a mention of unbound-checkconf?
> 
> How about squeezing even further and pointing to the NEWS file instead 
> (for those that have unbound installed, but not apt-listchanges). 

The problem is, that way the information they need to implement a fix
only arrives on their system as part of the process that breaks their
resolver.  That's less of a disaster than if the solution was only
available online, but it still sounds annoying.

(Putting it on a Wiki page that they can read before the upgrade would
work, though.)
-- 
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package



Bug#985616: Document change to unbound ".d" config file fragment behavior

2021-03-22 Thread Andrei POPESCU
On Du, 21 mar 21, 13:01:07, Justin B Rye wrote:
> Robert Edmonds wrote:
> > During the bullseye release cycle the default /etc/unbound/unbound.conf
> > file was changed to use the newly introduced "include-toplevel:"
> > directive rather than the "include:" directive. This should probably be
> > mentioned in the bullseye release notes because it will break
> > configurations where the user added a clauseless config file fragment to
> > /etc/unbound/unbound.conf.d/.
> > 
> > The text from /usr/share/doc/unbound/NEWS.Debian.gz about this change is
> > quoted below.
> 
> For the Release Notes we ought to add some material: people reading
> the NEWS file can be assumed to have chosen to install unbound, but
> this version needs to start by making it clear what unbound is (and
> that if you haven't heard of it you don't need to read the technical
> details).  Then after that we could squeeze things a bit:

[snip two paragraphs]

> Is that compressed too far?  I was hoping to fit the word "robustness"
> somewhere.  Maybe a mention of unbound-checkconf?

How about squeezing even further and pointing to the NEWS file instead 
(for those that have unbound installed, but not apt-listchanges). 

Kind regards,
Andrei
-- 
http://wiki.debian.org/FAQsFromDebianUser


signature.asc
Description: PGP signature


Bug#985616: Document change to unbound ".d" config file fragment behavior

2021-03-21 Thread Justin B Rye
Robert Edmonds wrote:
> During the bullseye release cycle the default /etc/unbound/unbound.conf
> file was changed to use the newly introduced "include-toplevel:"
> directive rather than the "include:" directive. This should probably be
> mentioned in the bullseye release notes because it will break
> configurations where the user added a clauseless config file fragment to
> /etc/unbound/unbound.conf.d/.
> 
> The text from /usr/share/doc/unbound/NEWS.Debian.gz about this change is
> quoted below.

For the Release Notes we ought to add some material: people reading
the NEWS file can be assumed to have chosen to install unbound, but
this version needs to start by making it clear what unbound is (and
that if you haven't heard of it you don't need to read the technical
details).  Then after that we could squeeze things a bit:

  
Config file fragment handling in unbound

 The DNS resolver unbound
 has changed the way it includes configuration file fragments.
 Instead of using an include: directive to read
 in files in /etc/unbound/unbound.conf.d/*.conf,
 the default configuration file for Debian bullseye uses
 include-toplevel:, which has extra requirements.


 Instead of allowing fragments that need to be concatenated to form
 valid configuration clauses, include-toplevel:
 requires each one to begin its own clause (e.g.,
 server:). If your system uses included fragments
 you should ensure they will still be valid; if this is not possible
 the previous behavior can be restored by editing
 /etc/unbound/unbound.conf and switching the
 include-toplevel: directive back to
 include:.

   

Is that compressed too far?  I was hoping to fit the word "robustness"
somewhere.  Maybe a mention of unbound-checkconf?
-- 
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package



Bug#985616: Document change to unbound ".d" config file fragment behavior

2021-03-20 Thread Robert Edmonds
Package: release-notes
Severity: normal

Hi,

During the bullseye release cycle the default /etc/unbound/unbound.conf
file was changed to use the newly introduced "include-toplevel:"
directive rather than the "include:" directive. This should probably be
mentioned in the bullseye release notes because it will break
configurations where the user added a clauseless config file fragment to
/etc/unbound/unbound.conf.d/.

The text from /usr/share/doc/unbound/NEWS.Debian.gz about this change is
quoted below.

Thanks!


unbound (1.11.0-1) unstable; urgency=medium

  The default Debian config file shipped in the unbound package has changed
  from using the "include:" directive to using the "include-toplevel:"
  directive in order to include the config file fragments in
  /etc/unbound/unbound.conf.d/*.conf into the unbound configuration.

  The "include-toplevel:" directive has been newly introduced in unbound
  1.11.0 and it requires that any included config file fragment begin its own
  clause (e.g., "server:").

  The existing "include:" directive that was used in previous Debian releases
  of the unbound package only performed textual inclusion, and it was possible
  to construct a set of config file fragments that depended on the presence or
  ordering of specific config file fragments in order to parse correctly. For
  instance, a config file fragment could have specified an option that can
  only appear in the "server:" clause, and rely on a previously included
  config file fragment to begin that clause. This behavior is no longer
  allowed by the use of the "include-toplevel:" directive because it is not
  robust against config file fragments being added, removed, or reordered.

  If you are upgrading the unbound package and you have installed any config
  file fragments into /etc/unbound/unbound.conf.d/ you should check that each
  config file fragment begins its own clause (e.g., "server:") and update each
  config file fragment as necessary to be compatible with the behavior of the
  "include-toplevel:" directive.

  If needed, the previous behavior can be restored by changing the following
  line in /etc/unbound/unbound.conf:

  include-toplevel: "/etc/unbound/unbound.conf.d/*.conf"

  to its previous setting:

  include: "/etc/unbound/unbound.conf.d/*.conf"

 -- Robert Edmonds   Sun, 09 Aug 2020 19:39:01 -0400


-- 
Robert Edmonds
edmo...@debian.org