A declarative network manager API for hosts.
Copr build status:
- EPEL 7 GIT master:
- Fedora GIT master:
Nmstate is a library with an accompanying command line tool that manages host networking settings in a declarative manner. The networking state is described by a pre-defined schema. Reporting of current state and changes to it (desired state) both conform to the schema.
Nmstate is aimed to satisfy enterprise needs to manage host networking through a northbound declarative API and multi provider support on the southbound. NetworkManager acts as the main (and currently the only) provider supported.
Nmstate uses the NetworkManager mailing
list
(Archives) for
discussions. Emails about nmstate should be tagged with [nmstate] in the
subject header to ease filtering.
Development planning (sprints and progress reporting) happens in (Jira). Access requires login.
There is also #nmstate on Freenode
IRC.
Nmstate uses tox to run unit tests and linters. Since Nmstate uses the binary
module PyGObject it also requires the build dependencies for it.
Recommended minimum installation:
yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm # install EPEL for python-pip
subscription-manager repos --enable "rhel-*-optional-rpms" --enable "rhel-*-extras-rpms" # recommended for EPEL
yum install git python-pip
pip install tox # python-tox in EPEL seems to be too old
yum-builddep python-gobject # install build dependencies for PyGObjectNote: This will not run the unit tests for Python 3.6 because this Python version is not available there.
Run Unit Tests:
toxInstall (from sources) system-wide:
sudo pip install --upgrade .Install just for the local user:
pip install --user --upgrade .Make sure that ~/.local/bin is in your PATH when installing as a local user.
The export command can be used to add it for the current session:
export PATH="${HOME}/.local/bin:${PATH}"Nmstate also provides a container image based on CentOS 7 to try it:
CONTAINER_ID=$(sudo docker run --privileged -d -v /sys/fs/cgroup:/sys/fs/cgroup:ro nmstate/centos7-nmstate)
sudo docker exec -ti "${CONTAINER_ID}" /bin/bash
# now play with nmstatectl in the container
nmstatectl show
# remove the container at the end
sudo docker stop "${CONTAINER_ID}"
sudo docker rm "${CONTAINER_ID}"Show current state:
nmstatectl showChange to desired state:
nmstatectl set desired-state.yml
nmstatectl set desired-state.jsonEdit current state of eth3 in a text editor:
nmstatectl edit eth3nmstatectl will also read from stdin when no file is specified:
nmstatectl set < desired-state.ymlDesired/Current state example (JSON):
{
"interfaces": [
{
"description": "Production Network",
"ethernet": {
"auto-negotiation": true,
"duplex": "full",
"speed": 1000
},
"ipv4": {
"address": [
{
"ip": "192.0.2.142",
"prefix-length": 24
}
],
"enabled": true
},
"mtu": 1500,
"name": "eth3",
"state": "up",
"type": "ethernet"
}
]
}See nmstatectl --help for additional command-line options.
- bond
- dummy
- ethernet
- ovs-bridge