[Nexthop][fboss2-dev] fboss2 config/delete protocol bgp neighbor commands#1391
Open
hillol-nexthop wants to merge 7 commits into
Open
[Nexthop][fboss2-dev] fboss2 config/delete protocol bgp neighbor commands#1391hillol-nexthop wants to merge 7 commits into
hillol-nexthop wants to merge 7 commits into
Conversation
Make the fboss2 ConfigSession and `config session` lifecycle BGP-aware. This is
the base for the `config protocol bgp` commands, which stack on top.
- ConfigSession owns the BGP config as a typed bgp::thrift::BgpConfig, exactly
the way it owns cfg::AgentConfig for the agent. getBgpConfig()/saveBgpConfig()
expose the WHOLE typed config and stage it to ~/.fboss2/bgp_config.json.
ConfigSession is BGP-aware but agnostic about the config's internal structure:
it has no notion of "global" vs "peer" vs "peer-group" -- a command mutates
whichever typed fields it needs, mirroring how interface commands mutate
getAgentConfig().sw()->ports(). Because the whole config round-trips through
the typed struct, no surgical merge / preserve-list is needed.
- commit() promotes bgp_config.json to /etc/coop/bgpcpp/bgpcpp.conf, restarts
bgp_pp, and versions it in the same /etc/coop git repo as agent.conf.
- config session clear/diff/rebase/rollback are BGP-aware: clear removes a
staged BGP session, diff shows staged BGP changes, rebase 3-way-merges
bgpcpp.conf, rollback restores bgpcpp.conf + restarts bgp_pp (using metadata
history so BGP-only commits are reachable).
- FbossServiceUtil + cli_metadata gain the bgp_pp (BGP_PP) service/action; the
config lib gains the bgp_config cpp2 dependency.
- Unit tests in CmdConfigSession{,Diff}Test cover the typed round-trip, commit,
rebase, and rollback behavior.
Test Plan:
- bazel test //fboss/cli/fboss2/test/config:cmd_config_test //fboss/cli/fboss2/test:cmd_test
- fboss2_integration_test on a DUT (ConfigConcurrentSessionsTest.ConflictAndRebase,
ConfigSessionClearTest, ConfigInterfaceMtuTest, ConfigInterfaceDescriptionTest): 5/5 pass
The BGP++ daemon ships as bgpd.service (via the bgpd RPM) on devices and in the fboss-sim runtime image; bgp_pp only ever worked via a manually created alias unit. Rename the unit that ConfigSession/FbossServiceUtil restarts on commit, and the related comments and unit-test expectations.
hillol-nexthop
force-pushed
the
bgpneighbor
branch
2 times, most recently
from
July 17, 2026 06:21
348f91c to
b3655bb
Compare
…ged bgpcpp/ subdir `config session commit` writes the bgpd config to /etc/coop/bgpcpp/bgpcpp.conf (kBgpGitRelPath) and expects the daemon to read exactly that path, which forces a per-device systemd drop-in overriding bgpd's --config. Mirror the agent.conf scheme instead: on every BGP commit, keep the daemon-facing path /etc/coop/bgpcpp.conf a symlink into the CLI-managed bgpcpp/ subdir (exactly as agent.conf symlinks to cli/agent.conf). bgpd keeps its provisioned `--config /etc/coop/bgpcpp.conf` and follows the symlink, so no drop-in is needed and the arrangement is self-healing across re-provision. The symlink is git-tracked alongside the config so rollback restores it. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add `fboss2-dev config protocol bgp global <attr> <value>` on top of the BGP-aware ConfigSession (base PR). Edits the typed bgp::thrift::BgpConfig via ConfigSession::getBgpConfig()/saveBgpConfig() -- the whole-config, scope-agnostic typed API (no global/peer/peer-group special-casing in ConfigSession). - Collapse the 10 per-attribute global command classes into one dispatcher; reject cluster-id (no BgpConfig field) instead of writing dead config; bound switch-limit / max_golden_vips so out-of-range values aren't truncated. - Integration tests: ConfigBgpGlobalTest (each attr set+commit, verified in the promoted /etc/coop/bgpcpp/bgpcpp.conf) and ConfigBgpSessionTest (clear/diff/commit/rollback + a no-op-restart regression), sharing ConfigBgpTestBase. Test Plan: - bazel test //fboss/cli/fboss2/test/config:cmd_config_test - bazel build //fboss/cli/fboss2/test/integration_test:fboss2_integration_test - fboss2_integration_test on a DUT with bgp_pp active: ConfigBgpSessionTest 6/6 pass (clear, diff, commit-restarts-bgp_pp, rollback-restores-config, and the unchanged-config does-not-restart case); agent-session regression (ConfigInterfaceMtuTest) passes.
- Extract the value parsers (parseBool/parseInt/parseNonNegInt32, handler Result) into a shared BgpCliValueParsers.h so sibling BGP dispatchers can reuse them, and add a bounded parseAsn4Byte: local-asn/confed-asn accepted any uint64 and silently persisted out-of-range ASNs (>= 2^32 wrap the i64 field negative). - positionals_at_end() on the global command: CLI11's parent-chain subcommand fallthrough steals value tokens that match a sibling command name (e.g. a policy named "peer-group") and misparses the command. - Integration test base: probe the bgpd unit, and pass -c safe.directory=/etc/coop on the raw git invocations (gitHead / bgpTrackedAtRevision), mirroring the CLI's Git class -- /etc/coop is owned by another user (e.g. coop) on provisioned devices, which git otherwise rejects as dubious ownership and the helpers silently return empty results.
The commit-path global-attribute tests asserted on the promoted /etc/coop/bgpcpp/bgpcpp.conf, which only proves what the CLI wrote to disk. Route ConfigBgpTestBase::setAndCommit() through a new readRunningBgpConfigViaRpc() -- TBgpService::getRunningConfig against the local bgpd -- so every positive ConfigBgpGlobalTest asserts its attribute in the daemon's own view of its config, proving bgpd parsed and adopted the promoted file after the commit-triggered restart. The helper retries briefly on connection errors: systemd reports bgpd active as soon as the process starts, but its thrift server binds the port a few seconds later, so an RPC issued right after a restart races that window. Test Plan: - bazel build //fboss/cli/fboss2/test/integration_test:fboss2_integration_test - fboss2_integration_test on a DUT with bgpd active: ConfigBgpGlobalTest 7/7 pass (each attribute set+commit verified in bgpd's getRunningConfig view, plus the invalid-bool and negative-graceful-restart-time reject paths).
…or` commands Adds `fboss2-dev config protocol bgp neighbor <ip> [<attribute> <value> ...]` as a single dispatcher (mirroring the `global` command): the neighbor address is the first positional token, one- or two-token attributes are matched longest-prefix-first against a dispatch table, and handlers mutate the typed bgp::thrift::BgpPeer via ConfigSession::getBgpConfig()/saveBgpConfig(). - Bare `neighbor <ip>` creates the peer; attribute sets find-or-create it, keyed by the folly::IPAddress-normalized peer_addr (prefix notation for passive sessions is accepted). - New peers are seeded with parseable any-addresses for local_addr / next_hop4 / next_hop6: bgpd constructs folly::IPAddress from these non-optional fields at config load and aborts on the empty strings a freshly created peer would otherwise serialize (reproduced on an NH-4010-F device). - add-path send/receive merge into the single AddPath enum (RECEIVE/SEND/ BOTH); clearing the last direction unsets the field. - Rejected instead of persisting dead config: connect-mode BOTH (thrift only models is_passive), peer-port / bind-addr port (no per-peer port field), afi ipv4/ipv6-labeled-unicast (no thrift field). - Value validation: 4-byte ASN range, IP family for next-hop4/next-hop6, bind-addr address parse, thrift-enum membership for advertise-lbw / receive-lbw, non-negative timers and route limits. A rejected value never lands on disk. - Deletes the 26 per-attribute `peer` command classes plus the now-dead per-peer folly::dynamic BgpConfigSession API they used; parity attributes those commands supported (next-hop4/6, next-hop-self, peer-id, type, link-bandwidth, advertise/receive-lbw, timers withdraw-unprog-delay, pre/post warning limits) are carried over in the dispatcher. - `delete protocol bgp neighbor <ip>` removes the matching peer from the staged config via shared BgpPeerAddr.h normalize/find helpers; deleting an unknown neighbor errors without persisting anything. - bgp_json_to_cli.py peer generators emit the new grammar (shlex-escaped, including the neighbor address); explicit zero timers/limits are no longer dropped and symbolic add_path enum names are handled. - Integration tests verify committed neighbor config through the bgpd TBgpService::getRunningConfig RPC (with a brief connection retry: systemd reports the unit active before the thrift server binds its port), proving the daemon parsed and adopted the promoted config rather than only checking the file the CLI wrote.
hillol-nexthop
force-pushed
the
bgpneighbor
branch
from
July 17, 2026 14:07
b3655bb to
66df523
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
fboss2-dev config protocol bgp neighbor <ip-address> [<attribute> <value> ...]as a single dispatcher mirroring theglobalcommand: the neighbor address is the first positional token, one- or two-token attributes (timers hold-time,add-path send, ...) are matched longest-prefix-first, and handlers mutate the typedbgp::thrift::BgpPeerviaConfigSession::getBgpConfig()/saveBgpConfig(). Also addsfboss2-dev delete protocol bgp neighbor <ip-address>. The 26 old per-attributepeercommand classes and the now-dead per-peerfolly::dynamic BgpConfigSessionAPI are deleted.BgpPeerfieldremote-asn/local-asnremote_as_4_byte/local_as_4_byte(4-byte-bounded)description,peer-tag,peer-group,peer-id,typedescription,peer_tag,peer_group_name,peer_id,typeingress-policy/egress-policyingress_policy_name/egress_policy_namerr-client,confed-peer,redistribute-peer,enhanced-route-refresh,next-hop-selfconnect-mode <PASSIVE|ACTIVE>is_passiveafi disable-ipv4-afi/disable-ipv6-afi/ipv4-over-ipv6-nhdisable_ipv4_afi/disable_ipv6_afi/v4_over_v6_nexthopadd-path send|receive <bool>AddPathenum (RECEIVE/SEND/BOTH)bind-addr address,next-hop4,next-hop6local_addr,next_hop4,next_hop6(IP/family-validated)graceful-restart restart-time/stateful-habgp_peer_timers.graceful_restart_seconds/enable_stateful_hatimers hold-time/keepalive/out-delay/withdraw-unprog-delaybgp_peer_timers.*max-route pre-filter/post-filter/{pre,post}-warning-threshold/{pre,post}-warning-onlypre_filter/post_filterRouteLimit fieldslink-bandwidth,advertise-lbw,receive-lbwlink_bandwidth_bps,advertise_link_bandwidth,receive_link_bandwidth(enum-membership-validated)Bare
neighbor <ip>creates the peer; attribute sets find-or-create it, keyed by thefolly::IPAddress-normalizedpeer_addr(prefix notation for passive sessions accepted).delete protocol bgp neighbor <ip>removes the matching peer via the same shared normalize/find helpers (BgpPeerAddr.h); deleting an unknown neighbor errors without persisting anything.Behavior notes
local_addr/next_hop4/next_hop6=0.0.0.0/::): bgpd constructsfolly::IPAddressfrom these non-optional fields at config load and aborts on the empty strings a fresh peer would otherwise serialize (IPAddressFormatExceptioninConfig::createCommonPeerGroupConfig, reproduced on an NH-4010-F device — the daemon crash-looped into systemd's start limit). The pre-existing sparse-JSON path had the same latent bug.cluster-idin the global PR):connect-mode BOTH(thrift only modelsis_passive),peer-port/bind-addr port(no per-peer port field; the daemon uses the globallisten_port),afi ipv4/ipv6-labeled-unicast(no thrift field). A rejected value never lands on disk.neighbor <ip> peer-group Xmisparsed withXas the neighbor address).positionals_at_end()on the neighbor command makes everything after the first positional parse as positionals.bgp_json_to_cli.pypeer generators emit the newneighborgrammar (shlex-escaped, including the neighbor address; the shell-injection test is updated accordingly); explicit zero timers/limits are no longer dropped and symbolicadd_pathenum names are handled.TBgpService::getRunningConfigRPC (with a brief connection retry — systemd reports the unit active before the thrift server binds its port), proving bgpd parsed and adopted the promoted config rather than only checking the file the CLI wrote.Test Plan
Unit —
bazel test //fboss/cli/...:CmdConfigBgpNeighborTestFixture(14 tests: arg validation/normalization, longest-prefix match, add-path merge matrix, connect-mode, parity attributes, ASN/IP/enum validation, reject paths) andCmdDeleteBgpNeighborTestFixture(5 tests).pytest fboss/cli/fboss2/tools/tests/test_bgp_json_to_cli.py(67 pass, including the shell-injection test against the new grammar).Integration on device (real
bgpd_cppdaemon):Sample usage: