Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fixed typos #87

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fixed typos #87

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
34 changes: 17 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,37 +9,37 @@ switches.
FBOSS consists of a number of user-space applications, libraries, and
utilities.

The initial open source release of FBOSS consists primarily of the agent
Copy link

Choose a reason for hiding this comment

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

This isnt required @midopooler

The initial open-source release of FBOSS consists primarily of the agent
daemon, but we are working on releasing additional pieces and functionality as
well.

### Agent Daemon

One of the central pieces of FBOSS is the agent daemon, which runs on each
switch, and controls the hardware forwarding ASIC. The agent daemon sends
forwarding information to the hardware, and implements some control plane
protocols such as ARP and NDP. The agent provides thrift APIs for managing
switch, and controls the hardware forwarding ASIC.  The agent daemon sends
forwarding information to the hardware and implements some control plane
protocols such as ARP and NDP.  The agent provides thrift APIs for managing
routes, to allow external routing control processes to get their routing
information programmed into the hardware forwarding tables.

The code for the agent can be found in fboss/agent

The agent requires a JSON configuration file to specify its port and VLAN
configuration. Some sample configuration files can be found under
fboss/agent/configs. These files are not really intended for human
consumption--at Facebook we have tooling that generates these files for us.
The agent requires a JSON configuration file to specify it's port and VLAN
configuration.  Some sample configuration files can be found under
fboss/agent/configs.  These files are not really intended for human
consumption--at Facebook, we have tooling that generates these files for us.

### Routing Daemon

The FBOSS agent manages the forwarding tables in the hardware ASIC, but it
needs to be informed of the current routes via thrift APIs.

Our initial open source release does not yet contain a routing protocol daemon
capable of talking to the agent. The routing protocol daemon we use at
Our initial open-source release does not yet contain a routing protocol daemon
capable of talking to the agent.  The routing protocol daemon we use at
Facebook is rather specific to our environment, and likely won't be as useful
to the open source community. For more general use outside of Facebook, it
to the open-source community.  For more general use outside of Facebook, it
should be possible to modify existing open source routing tools to talk to the
FBOSS agent, but we have not implemented this yet. In the meantime, we have
FBOSS agent, but we have not implemented this yet.  In the meantime, we have
included a small sample python script in fboss/agent/tools that can manually
add and remove routes.

Expand All @@ -49,8 +49,8 @@ Obviously additional tools and utilities are required for interacting with the
FBOSS agent, reporting its status, generating configuration files, and
debugging issues.

At the moment we do not have many of our tools ready for open source release,
Copy link

Choose a reason for hiding this comment

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

This is also not required @midopooler

but we hope to make more of these available in the future weeks. In the
At the moment we do not have many of our tools ready for open-source release,
but we hope to make more of these available in the future weeks.  In the
meantime, the thrift compiler can automatically generate a python-remote script
to allow manual invocation of the agent's various thrift interfaces.

Expand All @@ -61,12 +61,12 @@ See the BUILD.md document for instructions on how to build FBOSS.
## Future Development

FBOSS has been designed specifically to handle the needs of Facebook's data
center networks, but we hope it can be useful for the wider community as well.
centre networks, but we hope it can be useful for the wider community as well.
However, note that this initial release of FBOSS will likely require
modification and additional development to support other network configurations
beyond the features used by Facebook. Until it matures more, FBOSS will likely
beyond the features used by Facebook.  Until it matures more, FBOSS will likely
be primarily of interest to network software developers, rather than to network
administrators who are hoping to use it as an turnkey solution.
administrators who are hoping to use it as a turnkey solution.

We look forward to getting feedback from the community, and we hope FBOSS can
serve as a jumping-off point for other users wishing to program network
Expand Down