Skip to content

Commit

Permalink
better intro, typos
Browse files Browse the repository at this point in the history
  • Loading branch information
bellhyve committed Jun 20, 2024
1 parent 65d0894 commit 3fb09fb
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,16 @@

# DESCRIPTION

**ngbuddy** ("Netgraph Buddy") is an rc.d script for managing netgraph(4) networks in mixed vm and jail environments. **rc.conf** variables prefixed by **ngbuddy_** are used to manage ng_bridge(4) and ng_eiface(4) devices upon service start (and system boot). Additional tools assist with configuring vm-bhyve and naming their sockets for statistics and graphing.
**ngbuddy** ("Netgraph Buddy") is an rc.d script for managing netgraph(4) in mixed vm and jail environments. Netgraph provides a more flexible networking solution compared to the traditional if_bridge/epair/tap setup, a clearer and shorter list of virtual devices, and performance benefits for some workloads.

**rc.conf** variables prefixed by **ngbuddy_** are used to manage ng_bridge(4) and ng_eiface(4) devices upon service start (and system boot). Additional tools assist with jail interface management, configuring vm-bhyve, naming vm-bhyve sockets, displaying basic statistics, and determine stable MAC addresses to help avoid collisions.

# QUICK START EXAMPLE

The following commands will configure a system for netgraph.

**service ngbuddy enable**
: Sets **rc.conf** variables to enable the ngbuddy service. If no bridge definitions are set, the following bridge definitions will be added: \
: Sets **rc.conf** variables to enable the ngbuddy service. If no bridge definitions are set, the following default bridge definitions will be added: \
: _public_: A bridge interface associated with the host system's current default route, allowing guests to interact with the existing network. \
: _private_: A bridge linked to a new virtual interface named **nghost0**, suitable for host-only or NAT network with your guests. \

Expand Down Expand Up @@ -151,7 +153,7 @@ Configure the jail configuration: \
To create more jails, you can: \
- Copy **/jail/my_jail/** to **/jail/new_jail1/** \
- Copy **/etc/jail.conf.d/my_jail.conf** to **new_jail1.conf** \
- Edit the new configuration as above, chaning the word **my_jail** to **new_jail1** \
- Edit the new configuration as above and change the word **my_jail** to **new_jail1** \
- Run: **service jail start new_jail1** \
- And repeat as desired. \

Expand Down
8 changes: 5 additions & 3 deletions ngbuddy.8
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,14 @@ bhyve(8)
\f[B]service ngbuddy vmname\f[R]
.SH DESCRIPTION
\f[B]ngbuddy\f[R] (\[lq]Netgraph Buddy\[rq]) is an rc.d script for
managing netgraph(4) networks in mixed vm and jail environments.
managing netgraph(4) in mixed vm and jail environments.
\f[B]rc.conf\f[R] variables prefixed by \f[B]ngbuddy_\f[R] are used to
manage ng_bridge(4) and ng_eiface(4) devices upon service start (and
system boot).
Additional tools assist with configuring vm\-bhyve and naming their
sockets for statistics and graphing.
Additional tools assist with jail interface management, configuring
vm\-bhyve, naming vm\-bhyve sockets, displaying basic statistics, and
determining MAC addresses for easier guest migrations and avoiding MAC
collisions.
.SH QUICK START EXAMPLE
The following commands will configure a system for netgraph.
.TP
Expand Down

0 comments on commit 3fb09fb

Please sign in to comment.