Opened 3 years ago

Closed 2 years ago

Last modified 2 years ago

#5350 closed defect (complete)

IPv4 user-context example in the admin guide is wrong

Reported by: tmark Owned by: tomek
Priority: medium Milestone: Kea1.3 beta
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: 1 Add Hours to Ticket: 1
Total Hours: 7 Internal?: no

Description

The screen shot in the admin guide for 8.10. User context in IPv4 pools is wrong. It shows user-context as an element of the subnet NOT the pool. Not only does this not parse but a user found it. Tsk tsk on us.

"Dhcp4": {
    "subnet4": [
        {
            "subnet": "192.0.2.0/24",
            "pools": [ { "pool": "192.0.2.10 - 192.0.2.20" } ],
            "user-context": { "colour": "red" }
        },
        ...
    ],
    ...
}

Subtickets

Change History (8)

comment:1 Changed 2 years ago by tomek

  • Milestone changed from Kea-proposed to Kea1.3

comment:2 Changed 2 years ago by tomek

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

comment:3 Changed 2 years ago by tomek

  • Add Hours to Ticket changed from 0 to 6
  • Owner changed from tomek to Unassigned
  • Status changed from assigned to reviewing
  • Total Hours changed from 0 to 6

Ok, done. It took me a few hours, but this is now fixed the proper way. Instead of just fixing the docs, I changed the code to actually handle the case the example tries to use. Contexts are now supported in pools and subnets.

Proposed ChangeLog?:

12XX.	[func]		tomek
	User contexts are now supported for subnets. This adds a new
	functionality, but also makes the existing documentation example
	correct.
	(Trac #5350, git tbd)

There are 3 commits on trac5350. It is recommended to review only the first two, as the third one is only parser generation. This will be discarded and regenerated again once this is merged.

comment:4 Changed 2 years ago by tomek

This change addresses part of the request raised in #5351.

comment:5 Changed 2 years ago by fdupont

  • Owner changed from Unassigned to fdupont

comment:6 Changed 2 years ago by fdupont

  • Owner changed from fdupont to tomek

Fixed some spelling errors so pull.

Examples and docs say any valid JSON when the parser wants a map. Please fix!

Reading the code it seems nice. I'll try to build it on my box and by Jenkins.

comment:7 Changed 2 years ago by tomek

  • 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

The code has been merged. Thanks for the review. Closing ticket.

comment:8 Changed 2 years ago by vicky

  • Milestone changed from Kea1.3 to Kea1.3 beta

Milestone renamed

Note: See TracTickets for help on using tickets.