Opened 4 years ago

Closed 3 years ago

#4282 closed enhancement (complete)

Update Kea User's Guide with host storage in PostgreSQL

Reported by: tomek Owned by: marcin
Priority: medium Milestone: Kea1.1
Component: host-reservations Version: git
Keywords: Cc:
CVSS Scoring: Parent Tickets:
Sensitive: no Defect Severity: N/A
Sub-Project: DHCP Feature Depending on Ticket:
Estimated Difficulty: 0 Add Hours to Ticket: 1
Total Hours: 7 Internal?: no

Description

Once all tickets mentioned in HostReservationDesign related to PostgreSQL are implemented (#4275, #4276, #4277, #4278, #4279, #4280), the solution should be documented in the User's Guide.

Subtickets

Change History (7)

comment:1 Changed 3 years ago by tomek

We need something similar to http://kea.isc.org/wiki/HostReservationsHowTo. Please also keep in mind to update the table in Section 4.3 of the User's Guide.

comment:2 Changed 3 years ago by tmark

See #4546, make sure admin doc cites proper schema version etc...

comment:3 Changed 3 years ago by marcin

  • Owner set to marcin
  • Status changed from new to accepted

comment:4 Changed 3 years ago by marcin

  • Add Hours to Ticket changed from 0 to 6
  • Owner changed from marcin to UnAssigned
  • Status changed from accepted to reviewing
  • Total Hours changed from 0 to 6

I have updated user's guide. I also updated this document on the wiki: http://kea.isc.org/wiki/HostReservationsHowTo and added pointer to it in the user's guide for PostgreSQL specific statements to insert reservations.

Proposed ChangeLog entry:

11XX.	[doc]		marcin
	Use of PostgreSQL as a storage for host reservations is now
	documented in the Kea Administrator Reference Manual.
	(Trac #4282, git abcd)

comment:5 Changed 3 years ago by sar

  • Owner changed from UnAssigned to sar

comment:6 Changed 3 years ago by sar

  • Owner changed from sar to marcin

I have made some changes for grammar and typos. Please do a pull and verify them.

I did not attempt to verify the use of the commands.

I don't think I need to re-review any changes (but can if you would like me to).

doc/guilde/admin.xml

In the first paragraph for the PostgresSQL section around line 413 it sill mentions that the capability to store host reservations is planned, this should probably be removed.

doc/guide/dhcp4-srv.xml

In the section on IPv4 Hosts Database Configuration
1) shouldn't that be either DHCPv4 Hosts or simply Hosts?
2) In the second paragraph, when setting up the name of the database it has
this is the name used when the lease database was created
Should this text mention that it could be the lease database or another one specifically for the hosts? Or simply do what the v6 version did and just say "database" instead of "lease database"

doc/guide/dhcpv6-serv.xml

In the section on IPv6 Hosts Database Configuration
1) shouldn't that be either DHCPv6 Hosts or simply Hosts?

comment:7 Changed 3 years ago by marcin

  • Add Hours to Ticket changed from 6 to 1
  • Resolution set to complete
  • Status changed from reviewing to closed
  • Total Hours changed from 6 to 7

Applied suggested changes and merged with commit 73d7b173583fded8f566958a2fdc7e1a0070eb39.

Note: See TracTickets for help on using tickets.