Opened 9 months ago

Closed 4 months ago

#5479 closed enhancement (complete)

HA: Developer's guide

Reported by: tomek Owned by: marcin
Priority: medium Milestone: Kea1.4-final
Component: documentation 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: 0
Total Hours: 0 Internal?: no

Description

High Availability is the most complex feature we have in Kea. Its internal operation must be properly documented, so other engineers could have a fighting chance to understand what's going on under the hood.

This is more than explaining what specific methods do. Things to consider:

  • not only what the code does, by why specific approach was chosen?
  • what are design assumptions?

Subtickets

Change History (6)

comment:1 Changed 5 months ago by tomek

  • Milestone changed from Kea1.4 to Kea1.4-final

Moved to 1.4-final.

comment:2 Changed 4 months ago by marcin

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

comment:3 Changed 4 months ago by marcin

  • Owner changed from marcin to UnAssigned
  • Status changed from accepted to reviewing

I fixed some doxygen warnings and then added a couple sections to the library specific developer's guide doc in the premium repo.

Proposed ChangeLog entry:

XX.	[doc]		marcin
	Described HA hooks library internals in the library specific
	Developer's Guide.
	(Trac #5479, git cafe)

comment:4 Changed 4 months ago by tomek

  • Owner changed from UnAssigned to tomek

comment:5 Changed 4 months ago by tomek

  • Owner changed from tomek to marcin

I finally finished the review. Apologies for it taking so long.

The text is good. Thanks for writing it up. I've fixed couple minor things.

Also wrote a section about comparison between Kea HA and ISC DHCP Failover.
After writing it, I had some doubts whether developer's guide is the best
place for it. Perhaps moving it to the User's Guide would be better?

Anyway, please pull and review. If you're ok with my changes, please
merge. If you think the comparison section is better suited in the user's
guide, feel free to move it.

comment:6 Changed 4 months ago by marcin

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

Fixed two typos and merged to master with commit e52b9d2dfaaeb7f97f1e935233315d2b923c8b15

Note: See TracTickets for help on using tickets.