Metadata-Version: 2.4
Name: os-net-config
Version: 18.1.0
Summary: Declarative network configuration tool for hosts
Home-page: https://github.com/os-net-config/os-net-config
Author: os-net-config Community
Author-email: os-net-config@noreply.github.com
Maintainer: os-net-config Community
License: Apache License (2.0)
Project-URL: Release Notes, https://github.com/os-net-config/os-net-config/releases
Project-URL: Source Code, https://github.com/os-net-config/os-net-config
Classifier: Environment :: Console
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: System :: Networking
Classifier: Topic :: System :: Systems Administration
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: pbr!=2.1.0,>=2.0.0
Requires-Dist: netaddr>=0.7.13
Requires-Dist: oslo.concurrency>=3.26.0
Requires-Dist: oslo.utils>=3.33.0
Requires-Dist: PyYAML>=3.10.0
Requires-Dist: jsonschema>=3.2.0
Requires-Dist: pyudev>=0.16.1
Requires-Dist: pyroute2>=0.7.10
Requires-Dist: setuptools<71.0.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: maintainer
Dynamic: project-url
Dynamic: requires-dist
Dynamic: summary

=============
os-net-config
=============

A declarative network configuration tool for hosts.

Overview
--------

``os-net-config`` is a host network configuration tool which supports multiple
backend configuration providers. One of: ifcfg (network-init-scripts), 
nmstate (NetworkManager), or eni (basic support for /etc/network/interfaces)

Features
--------

The core aim of this project is to allow fine grained (but extendable)
configuration of the networking parameters for a network host. The
project consists of:

* A CLI (os-net-config) which provides configuration via a YAML or JSON
  file formats.  By default os-net-config uses a YAML config file located
  at /etc/os-net-config/config.yaml. This can be customized via the
  --config-file CLI option.

* The provider used by os-net-config, which can be customized via a flag
  Try "os-net-config --help" for a list of supported PROVIDERs.

* A python library which provides configuration via an object model.

* A set of related services like os-net-config-sriov, os-net-config-sriov-bind,
  os-net-config-dcb.

* Configuration examples could be found at
  https://github.com/os-net-config/os-net-config/tree/master/etc/os-net-config/samples

Release Notes
-------------

Release notes for os-net-config can be found at:
https://github.com/os-net-config/os-net-config/releases

Historical release notes (versions prior to 18.1.0) are available at:
https://docs.openstack.org/releasenotes/os-net-config

Contributing
------------

See `CONTRIBUTING.rst`__.

__ https://github.com/os-net-config/os-net-config/blob/master/CONTRIBUTING.rst

Installation
------------

* RPM based
  os-net-config is part of Openstack RHEL8+, you may install it using 'sudo yum install os-net-config'

* From source code
  Use git to download source and then 'cd os-net-confg', 'python setup.py install --prefix=/usr'

License
-------

Licensed under the Apache License, Version 2.0 (the “License”); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

