Skip to content

Quote leading-zero PLMN values and fix unparseable YAML examples - #94

Merged
gab-arrobo merged 5 commits into
opennetworkinglab:mainfrom
bgrewell:docs-plmn-quoting-followup
Sep 10, 2026
Merged

gab-arrobo merged 5 commits into
opennetworkinglab:mainfrom
bgrewell:docs-plmn-quoting-followup

Conversation

@bgrewell

@bgrewell bgrewell commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #92, addressing the review feedback left there.

Quoting in example YAML

#92 updated the PLMN examples to 001/01 but left the new leading-zero values unquoted in the .. code-block:: snippets. As displayed, plmnId: 00101 parses as octal 65, and mcc: 001 / mnc: 01 both collapse to 1, so a reader copying these examples into their own values file silently provisions the wrong PLMN.

This only ever affected the rendered examples. The actual override files in aether-onramp already quote these correctly (sdcore-5g-values.yaml, gnbsim-default.yaml); the docs are being brought in line with them.

Spotted while in there

Kept as separate commits so they can be dropped or split if preferred.

  • Stale startImsi. The profile2 example still showed 001010100007487. That value was retired upstream by Align IMSI floor (ueID-start) to 7500 across different files aether-onramp#219 ("Align IMSI floor (ueID-start) to 7500") and never reflected here, so it predates Align docs with the standardized 5G PLMN and consolidated core values #92 -- that PR only swapped the 20893 prefix onto an already-stale suffix. It falls outside both provisioned subscriber ranges (7500-7509, 7510-7599), so the example as printed would fail authentication if used as-is. Now 001010100007510, matching profile2 in gnbsim-default.yaml.
  • Examples that don't survive a paste. The profile2 block (start.rst) and the device-groups block (gnb.rst) had mapping keys mis-nested under their list items, raising ScannerError / ParserError. Three files also had literal tabs before inline comments, which YAML forbids outright; the corresponding files in aether-onramp use spaces. Comment columns are preserved and no values change. This commit also restores dnn and sNssai, which are part of profile2 upstream but were dropped here with no elision marker.
  • gNBsim profile list. gnbsim-default.yaml defines eight profileTypes; the list named seven and omitted nwreqpdusessrelease. Also two prose typos: pdusettest -> pdusessest, PLMD -> PLMN.

Scope

Documentation only, no behavioural change.

operations/subscriber.rst gets the two-line plmnId quoting fix and nothing else. That page is ROC-scoped and now carries the archived-for-historical-reference warning, so its other pre-existing issues are left alone; the quoting bug is fixed only because #92 introduced it.

The 4G/CBRS examples (315010...) are untouched -- onramp#219 did not affect them, and they were already correctly quoted.

Verification

I don't have the Sphinx toolchain available locally, so I have not run make test; CI will be the first real check. All changes are inside existing code-block bodies with no directive or role changes. I did verify that every YAML example block in the repo now parses, apart from the two intentional ... elisions (network.rst, subscriber.rst), and that no tabs, trailing whitespace, or lines over 119 columns are introduced.

PR opennetworkinglab#92 updated the PLMN examples in the docs to 001/01 but left the new
leading-zero values unquoted in the code-block snippets. As displayed,
plmnId: 00101 parses as octal 65, and mcc: 001 / mnc: 01 both collapse
to 1, so a reader copying these examples into their own values file
silently provisions the wrong PLMN.

This affects the rendered examples only. The actual override files in
aether-onramp already quote these correctly (sdcore-5g-values.yaml,
gnbsim-default.yaml); the docs are being brought in line with them.

Addresses the review feedback left on opennetworkinglab#92.

Signed-off-by: Benjamin Grewell <benjamin.grewell@intel.com>
The profile2 example still showed startImsi 001010100007487. That value
was retired upstream by aether-onramp#219 ("Align IMSI floor (ueID-start)
to 7500"), which was never reflected here, so it predates opennetworkinglab#92 -- that PR
only swapped the 20893 prefix onto an already-stale suffix.

001010100007487 falls outside both provisioned subscriber ranges
(7500-7509 and 7510-7599) in sdcore-5g-values.yaml, so the example as
printed would fail authentication if used as-is. Update it to
001010100007510, matching profile2 in gnbsim-default.yaml.

Signed-off-by: Benjamin Grewell <benjamin.grewell@intel.com>
Several example blocks could not be pasted into a values file as-is:

- onramp/start.rst: the profile2 mapping keys were not nested under the
  list item, so the block raised a ScannerError. Also restores dnn and
  sNssai, which are part of profile2 in gnbsim-default.yaml but were
  omitted here without an elision marker.
- onramp/gnb.rst: the device-groups block mis-indented imsis under the
  list item, raising a ParserError.
- onramp/{gnbsim,network,blueprints}.rst: literal tabs before inline
  comments. YAML forbids tabs, so these blocks failed to parse. The
  corresponding files in aether-onramp use spaces.

Comment columns are preserved. No values are changed.

Signed-off-by: Benjamin Grewell <benjamin.grewell@intel.com>
gnbsim-default.yaml defines eight profileTypes; the list here named
seven and omitted nwreqpdusessrelease. Also fixes two typos in the
surrounding prose: pdusettest -> pdusessest, and PLMD -> PLMN.

Signed-off-by: Benjamin Grewell <benjamin.grewell@intel.com>
Copilot AI lite review requested due to automatic review settings September 9, 2026 23:18
@bgrewell
bgrewell requested review from a team as code owners September 9, 2026 23:18

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The device-groups YAML example in onramp/gnb.rst remains unparseable due to incorrect indentation of the imsis list items.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Documentation-only follow-up that makes embedded YAML examples safe to copy/paste by quoting leading-zero PLMN/IMSI fields and correcting several YAML formatting issues and typos introduced or left behind in prior updates.

Changes:

  • Quote leading-zero PLMN/IMSI values in rendered YAML examples to prevent octal/number coercion.
  • Fix YAML example formatting (indentation, tabs) so examples parse when pasted.
  • Update gNBsim profile documentation (missing profile + prose typos) and align profile2 fields with upstream.
File summaries
File Description
operations/subscriber.rst Quotes plmnId: "00101" in subscriber example YAML to avoid numeric/octal coercion.
onramp/start.rst Fixes profile2 YAML example: correct indentation, quote leading-zero fields, restore dnn/sNssai, update startImsi.
onramp/network.rst Replaces tab-indented inline comments with spaces inside YAML example blocks (YAML-valid).
onramp/gnbsim.rst Updates gNBsim profile list to eight entries and fixes pdusessest / PLMN typos.
onramp/gnb.rst Adjusts device-groups YAML example formatting (but currently introduces a remaining YAML indentation error for imsis).
onramp/blueprints.rst Replaces tab-indented inline comments with spaces in multiple YAML example blocks (YAML-valid).
Review details
  • Files reviewed: 3/6 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread onramp/gnb.rst Outdated
Indent the imsis sequence under its key, matching device-groups in
sdcore-5g-values.yaml. Both forms parse identically -- a block sequence
may sit at the same indentation as its parent mapping key -- but this
keeps the example consistent with the file it is documenting.

Signed-off-by: Benjamin Grewell <benjamin.grewell@intel.com>
@gab-arrobo
gab-arrobo merged commit 7fb3851 into opennetworkinglab:main Sep 10, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants