Opened 7 years ago

Closed 7 years ago

#3020 closed defect (fixed)

document b10-auth static.zone

Reported by: jreed Owned by: muks
Priority: medium Milestone: Sprint-20130806
Component: documentation Version:
Keywords: Cc:
CVSS Scoring: Parent Tickets:
Sensitive: no Defect Severity: N/A
Sub-Project: DNS Feature Depending on Ticket:
Estimated Difficulty: 3 Add Hours to Ticket: 0
Total Hours: 0 Internal?: no

Description

Document in the guide about using static.zone.

Subtickets

Change History (13)

comment:1 Changed 7 years ago by muks

  • Estimated Difficulty changed from 0 to 3

comment:2 Changed 7 years ago by muks

  • Milestone changed from New Tasks to Sprint-20130723

comment:3 Changed 7 years ago by muks

  • Owner set to muks
  • Status changed from new to assigned

Picking.

comment:4 Changed 7 years ago by muks

  • Owner changed from muks to UnAssigned
  • Status changed from assigned to reviewing

Up for review. Please also check commit 946804f3beabb2367474b15bcb173c1fc53265d6 that fixed some broken text.

comment:5 follow-ups: Changed 7 years ago by jreed

It looks like the installed share/bind10/config_plugins/datasrc.spec defaults to enabling the static.zone. We need to explain why to re-configure it and how to disable.

I think the docs need to state what the static.zone is:

BIND 10 provides a zone file for the CH (Chaos) class for providing information about the server
via the AUTHORS.BIND and VERSION.BIND TXT records.

I assume later could be used for other builtin CH. So I even think the name "static.zone" is wrong.

The examples are strange with:

config add data_sources/classes CH
config commit
config add data_sources/classes/CH

If that above is correct, then it is quite confusing. Why does one have a space and one has a slash?

By the way, the static.zone file has a confusing comment suggestion to run in bindctl: loadzone CH BIND (which does not work).

The dig examples assume localhost. Maybe mention that. And the prompt may be confusing since matches the prompt from previous example (Unix shell versus bindctl).

I pushed one minor fix: 7915732b2210e5540a74041eb759b13af0f6c405

comment:6 in reply to: ↑ 5 Changed 7 years ago by vorner

Hello

Not taking the review now, just a small comment.

Replying to jreed:

The examples are strange with:

config add data_sources/classes CH
config commit
config add data_sources/classes/CH

If that above is correct, then it is quite confusing. Why does one have a space and one has a slash?

I don't know why the commit in the middle, it should work without it.

But once it is with space, because it is adding of item named „CH“ into the named set „data_sources/classes“. The other is adding an empty list item into the list „data_sounces/classes/CH“. The second is short for commit add data_sources/classes/CH {} (or whatever the default happens to be).

comment:7 in reply to: ↑ 5 ; follow-up: Changed 7 years ago by muks

  • Owner changed from UnAssigned to jreed

Hi Jeremy

Replying to jreed:

It looks like the installed share/bind10/config_plugins/datasrc.spec
defaults to enabling the static.zone. We need to explain why to
re-configure it and how to disable.

I think the section before the newly added static data source section
and the newly added section describe it enough now.

I think the docs need to state what the static.zone is:

BIND 10 provides a zone file for the CH (Chaos) class for providing
information about the server via the AUTHORS.BIND and VERSION.BIND TXT
records.

This has been added now.

I assume later could be used for other builtin CH. So I even think
the name "static.zone" is wrong.

We can rename this file if necessary.

The examples are strange with:

config add data_sources/classes CH
config commit
config add data_sources/classes/CH

If that above is correct, then it is quite confusing. Why does one have a space and one has a slash?

Michal has explained this in the last comment.

By the way, the static.zone file has a confusing comment suggestion to
run in bindctl: loadzone CH BIND (which does not work).

This heading comment has been updated.

The dig examples assume localhost. Maybe mention that. And the prompt
may be confusing since matches the prompt from previous example (Unix
shell versus bindctl).

This has been described now in the adjacent doc.

I pushed one minor fix: 7915732b2210e5540a74041eb759b13af0f6c405

This look good.

comment:8 in reply to: ↑ 7 Changed 7 years ago by jreed

Replying to muks:

I assume later could be used for other builtin CH. So I even think
the name "static.zone" is wrong.

We can rename this file if necessary.

I created a new ticket for this: #3072

comment:9 Changed 7 years ago by jreed

The trac3020 branch is fine to merge. Thank you.

(It is a little strange to introduce the builtin CH after earlier examples briefly mention it for disabling it, but it is fine.)

comment:10 Changed 7 years ago by jreed

  • Owner changed from jreed to UnAssigned

comment:11 Changed 7 years ago by vorner

  • Owner changed from UnAssigned to vorner

comment:12 Changed 7 years ago by vorner

  • Owner changed from vorner to muks

Ah, it was already reviewed. Why is it unassigned, then?

comment:13 Changed 7 years ago by muks

  • Resolution set to fixed
  • Status changed from reviewing to closed

Merged to master branch in commit 8ddaa8da24109d602cb7aced60e57f8422d0c529:

* 979f298 [3020] Update instructions to test the auth server directly
* 39a853b [3020] Fix comments at the start of static.zone file
* 456a437 [3020] Update text that we assume the resolver is running on localhost
* 5c56a76 [3020] Add text about re-enabling the static.zone file
* e21cb1d [3020] Add a description for the static zone
* 7915732 [3020] typo fix
* 770c052 [3020] Describe in the BIND 10 guide how to add and use a static data source
* f4dcd7d [3020] Add config commit
* a1df84a [3020] Format commands properly
* 946804f [3020] Fix text that was broken and lost from commit f3b0c13a

Resolving as fixed. Thank you for the reviews Jeremy and Michal.

Note: See TracTickets for help on using tickets.