Changelog
0.8.3¤
CHANGES¤
- Improved Netbox device update nfcli to include Fx hosts filtering for nornir datasource
0.8.2¤
BUGS¤
- Fixed nornir inventory load from containerlab handling
0.8.1¤
BUGS¤
- Fixed
show containerlab inventory
command - Fixed Nornir Worker inventory load handling
- Netbox interface update improving mac address handling
FEATURES¤
- Netbox service added
get_containerlab_inventory
task - Containerlab service added
deploy_netbox
task
CHANGES¤
- Improved client post job retry logic
FN
filter argument for Nornir add presence handling for nfcli
0.8.0¤
CHANGES¤
- Restructuring pydantic models structures for better following DRY principles:
- Moved FatAPI models under norfab.models.fastapi
- Added norfab.models.nornir pydantic models
- Events and results models moved under norfab.models
- Added broker
zmq_auth
inventory parameter to turn zero mq authentication and encryption off - Added
verbose-result
command line argument to relevant tasks to emit result details - Updated to CLI shells to support PICLE 0.9.0
- Enhanced Netbox service to support working with instances of Netbox of different major and minor releases
BUGS¤
- Fixed broker to allow workers reconnect on restart.
FEATURES¤
- Improved worker jinja2 templates rendering logic to allow render url first and next download its content
- Added
nornir refresh
CLI command to refresh Nornir workers instances and reload inventory - Added support for Netbox 4.2
- Added support for Nornir service to pull hosts inventory from Containerlab service
0.7.0¤
FEATURES¤
- Added new
workflow
service to run simple workflows constructed using YAML DSL
CHANGES¤
- NFCLI shells - updated to use nested outputter where appropriate
- Nornir worker - updated to set failed flag for its tasks according to test results
- Worker - Added
status
filed to worker result object to reflect job execution status - Nornir Service - replaced
cfg_dry_run
andcli_dry_run
arguments withdry_run
argument - NFCLI shell - added aliases to use dash instead of underscore
- NFCLI shell - Moved Nornir service show commands under
show nornir xyz
path
0.6.0¤
FEATURES¤
- Added support for worker plugins
- Added support for nfcli custom shells
CHANGES¤
- All workers loaded into NorFab using entrypoints implementing lazy loading - workers classes only imported when they being used, in some cases allowing to save on startup time.
0.5.0¤
FEATURES¤
- FastAPI service added bearer authentication support
- Added hooks attachpoints
nornir-startup
andnornir-exit
to influence Nornir service workers startup and exit
0.4.0¤
CHANGES¤
- Improved netbox get_circuits logic.
- Standartised worker
get_version
andget_inventory
methods
Features¤
- Added
runtime_inventory
task to Nornir service, #6 - Added support to configure
startup
andexit
hook functions in inventory to be executed by nfapi on start and on exit.
0.3.1¤
CHANGES¤
- Improved logging handling for NFAPI if it failing to start a worker
- Update client
get
method to return result as a dictionary for broker MMI, file and inventory services - Enhanced Netbox
update_device_facts
andupdate_device_interface
to supportbatch_size
argument - a number of devices to process at a time - Improved nfcli shell for Netbox service to provide more arguments for
netbox update device facts
command
FEATURES¤
- Added Netbox Service
update_device_ip
task to retrieve device interface IP addresses and create them in Netbox - Added support to NorFab simple inventory and nfapi to load inventory from dictionary data as well as to explicitly provide
base_dir
information where to anchor NorFab environment - Added support for NorFab inventory workers section items to be dictionaries in addition to OS path to YAML files allowing to construct workers inventory out of dictionaries and/or YAML files.
0.3.0¤
FEATURES¤
- Added "show version" support for nfcli client to display versions of locally installed libraries, fixes. #4
- Added "show broker version" support for nfcli client to retrieve broker report of the version of libraries broker is running on, fixes. #4
- Added support "show broker inventory" command to display broker inventory
- Simple inventory added support to produce a serialized dictionary output
- Broker added "show_broker_inventory" and "show_broker_version" MMI endpoints
- Added support for simple inventory service to render inventory using Jinja2, renderer passed on
env
variable that contains operating system environment variables, allowing to source any env data into NorFab inventory for both broker and workers. #5 - Created
fastapi
service to host REST API for NorFab
0.2.4¤
BUGS¤
- Fixed nfcli
--workers-list
handling - Fixed
job_data
url handling for nornir cli/cfg/test tasks - Fixed nfapi handling of empty worker name
FEATURES¤
- Added a set of confirmed commit shell commands to nornir cfg netmiko plugin
0.2.3¤
FEATURES¤
- Added nfcli
--workers-list
option to specify a list of workers to start
CHANGES¤
- Fixed handling of jinja2 import for the worker to make it optional
0.2.1¤
CHANGES¤
- Improved libs imports handling to account for distributed deployment
- Improved logging handling
- Fixed nfcli issue with starting components onf NorFab #2
- Changed CTRL+C handling to trigger graceful NorFab exit
FEATURES¤
- Added
broker -> shared_secret
parameter ininventory.yaml
to configure clients and workers broker shared secret key - Added and tested docker files
0.2.0¤
CHANGES¤
- refactored
get_circuits
to usethreadpoolexecutor
to fetch circuits path from netbox - adding
job_data
json load to nornir cli, cfg and test tasks
BUGS¤
- Fixing netbox
get_devices
dry run test - Fixed netbox
get_circuits
devices site retrieval handling
FEATURES¤
- Added cache to Netbox
get_circuits
andget_devices
tasks - Added new
agent
worker to stsart working on use cases to interface with LLMs
0.1.1¤
BUGS¤
- FIxed Netbox CLI Shell handling of NFCLIENT
CHANGES¤
- Updated and tested dependencies for Netmiko 4.5.0
- Updated and tested dependencies for Nornir 3.5.0
- Updated and tested dependencies for Nornir-Salt 0.22.1
0.1.0¤
Changes¤
- Changes to Nornir service module files structure
- PICLE dependency updated: 0.7. -> 0.8.
- Made Nornir Service
progress
argument set toTrue
by default to emit and display events for all Nornir Jobs - Nornir tests changed
table
argument to be set toTrue
by default - Improved
nfapi
broker start logic to wait until broker fully initialized before proceeding to start workers
Features¤
- Added support for Nornir parse task to source TTP template from file with autocompletion
- Added Nornir File Copy task to copy files to devices using SCP
- Added support for logs to be collected into single file from all NorFab local processes
- Added to NorFab worker
job_list
andjob_details
methods - Added
show jobs summary
andshow jobs details
commands to NorFab shell and to Nornir shell - Added
--create-env
argument to nfcli utility to create NorFab folders and files to make it easier to get started using norfab
BUGS¤
- Fixed Nornir Service Watchdog to clean up dead connections from hosts data
0.0.0¤
Initial Release
Notable Features¤
- NorFAB Broker, Client and Worker base classes
- Nornir Service
- Network Service
- Simple Inventory Datastore Service
- File service
- ZeroMQ encryption