Skip to content

[Nexthop] Add Distro CLI fboss-image device image-upstream command#1018

Open
travisb-nexthop wants to merge 5 commits intofacebook:mainfrom
nexthop-ai:distro_cli_2.2.1_image_upstream
Open

[Nexthop] Add Distro CLI fboss-image device image-upstream command#1018
travisb-nexthop wants to merge 5 commits intofacebook:mainfrom
nexthop-ai:distro_cli_2.2.1_image_upstream

Conversation

@travisb-nexthop
Copy link
Contributor

Pre-submission checklist

  • I've ran the linters locally and fixed lint errors related to the files I modified in this PR. You can install the linters by running pip install -r requirements-dev.txt && pre-commit install
  • pre-commit run

Summary

This is a simple front-end for the image-upstream command which will
combine the various image description options into an URL and then
download it, checking that previously downloaded images are not
re-downloaded if the HTTP server indicates that they have not changed.

Later work will formalize the image publishing backend, but this
provides most of the necessary front-end.

Test Plan

New unit tests. Also a manual happy-path test that when the cache does
not contain the image it is downloaded and immediately repeating the
command does not redownload the file.

The Distro CLI getip and ssh commands make a best-effort attempt to
determine an IP for the given switch based on its MAC address and then
either return that IP or directly ssh to it.

It does so by connecting to the Distro Infra container and checking on
the configured interface for pre-existing IP neighbor/ARP entries. If
no such entries are found it will attempt a subnet ping to refresh the
Linux kernel neighbor entries.

In most cases this is sufficient after the system has PXE booted and
therefore the neighbor cache is filled.

Testing is as easy as starting the Distro Infra container:
```
$ ./distro_infra.sh --intf eth1 --persist-dir data
```

Then running the fboss-image device getip command with the appropriate
MAC address:
```
$ ./fboss-image device dc:da:4d:fc:ad:2d getip
[0.00s] Getting IP for device dc:da:4d:fc:ad:2d
10.250.33.2
```
The fboss-image device image command configures the Distro
Infrastructure to PXE boot the given image file for the given device
on the next reboot.

This replaces the manual steps previously necessary with the MVP
Distro Infrastucture.

Testing:

```
$ ./fboss-image device dc:da:4d:fc:ad:2d image nh-fboss-broadcom-xgs.tar
[0.00s] Setting image for device dc:da:4d:fc:ad:2d: nh-fboss-broadcom-xgs.tar
[0.07s] Using persistent directory: /home/travisb/work/upstream/fboss/fboss-image/distro_infra/data
[0.07s] Extracting image tarball to /home/travisb/work/upstream/fboss/fboss-image/distro_infra/data/dc-da-4d-fc-ad-2d...
[1.96s] Image extracted successfully to /home/travisb/work/upstream/fboss/fboss-image/distro_infra/data/dc-da-4d-fc-ad-2d
[1.96s] Enabling PXE boot for MAC address: dc-da-4d-fc-ad-2d
[2.09s] Successfully configured device dc:da:4d:fc:ad:2d with image nh-fboss-broadcom-xgs.tar
[2.09s] Device is ready for PXE boot
```

Then watch the switch PXE boot on the next boot:
```
>>Checking Media Presence......
>>Media Present......
>>Start PXE over IPv6 on MAC: DC-DA-4D-FC-AD-2D. Press ESC key to abort PXE boot..
  Station IP address is FC00:33:0:0:0:FB05:5030:774C
  Server IP address is FC00:33:0:0:0:0:0:1000
  NBP filename is ipxev6.efi
  NBP filesize is 1158144 Bytes

>>Checking Media Presence......
>>Media Present......
 Downloading NBP file...

  NBP file downloaded successfully.
iPXE initialising devices...
```
This is a simple front-end for the image-upstream command which will
combine the various image description options into an URL and then
download it, checking that previously downloaded images are not
re-downloaded if the HTTP server indicates that they have not changed.

Later work will formalize the image publishing backend, but this
provides most of the necessary front-end.

New unit tests. Also a manual happy-path test that when the cache does
not contain the image it is downloaded and immediately repeating the
command does not redownload the file.
@travisb-nexthop travisb-nexthop force-pushed the distro_cli_2.2.1_image_upstream branch from 6c5ad73 to 95d8d29 Compare March 18, 2026 21:45
@travisb-nexthop
Copy link
Contributor Author

This is stacked on top of #977

@travisb-nexthop travisb-nexthop marked this pull request as ready for review March 18, 2026 21:58
@travisb-nexthop travisb-nexthop requested a review from a team as a code owner March 18, 2026 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant