Prompt change to reduce hallucinations of static net config

[keitwb]

It should use the generate_nmstate_yaml call if it supports the given config instead of trying to figure it out on its own.

Summary by CodeRabbit

• Documentation
  • Clarified Static Network Configuration guidance: when supported by the generate_nmstate_yaml tool, regenerate the YAML using that tool for consistency.
  • Improved instructions to help users produce accurate network configuration files.
• Style
  • Adjusted indentation of a bullet point to enhance readability without changing behavior.

[coderabbitai]

Walkthrough

The pull request updates template.yaml by adjusting indentation for an existing bullet and adding a new bullet instructing regeneration of NMState YAML via generate_nmstate_yaml when supported.

Changes

Cohort / File(s)	Summary
Template text adjustments template.yaml	Indentation tweak to an existing bullet about default interface names; added bullet under Static Network Configuration directing users to regenerate YAML with generate_nmstate_yaml when applicable.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• changing the prompt so the host_booted_but_not_discovered test would be more consistent #223 — Also edits template.yaml guidance around NMState tool usage, aligning or contrasting instruction specificity.

Suggested reviewers

• carbonin

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title succinctly captures the main change of adjusting the prompt to reduce hallucinations in static network configuration generation. It references the prompt modification directly and highlights the goal of limiting AI inference. The wording is concise and specific, avoiding vague terms or unnecessary detail. It accurately reflects the PR’s objective of using the generate_nmstate_yaml tool for supported configurations.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

template.yaml (2)

252-252: Don’t assume interface names; ask or discover instead.

Defaulting to eth0/eth1 conflicts with the earlier “Don’t make assumptions” rule and with predictable interface names (enp/ens). Prefer confirming with the user or using discovered host inventory/mac-to-interface mapping via tools.

-          * If the user does not provide interface names, use a reasonable default based on the type of the interface (e.g. for ethernet use eth0, eth1, etc).
+          * If the user does not provide interface names, do not guess. Ask the user, or use discovered host inventory (e.g., MAC-to-interface mapping) to determine the correct interface names before generating YAML.

---

255-257: Good: prefer generate_nmstate_yaml when possible. Add brief fallback guidance.

This aligns with reducing hallucinations. Consider clarifying how to detect “supported” and the fallback path if the tool rejects inputs (e.g., NotSupported/validation error).

           * If the config is supported by the generate_nmstate_yaml tool, use that to regenerate the yaml.
+          * Attempt the tool call first; if it indicates the request is unsupported or returns a validation error, fall back to carefully editing the nmstate YAML yourself, then validate with the tool before showing it to the user.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f5e2ca5 and 6259c58.

📒 Files selected for processing (1)

• template.yaml (1 hunks)

[openshift-ci]

@keitwb: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/eval-test	6259c58	link	false	/test eval-test

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: carbonin, keitwb

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [carbonin]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[carbonin]

/retest