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.

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

chore: redefine infrahub-sdk version dependency, update README, 0.2.2 version bump #5

Merged
merged 3 commits into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# [Nornir](https://github.com/nornir-automation/nornir) plugin for [Infrahub][]
# [Nornir](https://github.com/nornir-automation/nornir) plugin for [Infrahub][https://github.com/opsmill/infrahub]

Work in progress.
## Installation

pip install nornir_infrahub

## Infrahub as the Nornir inventory

Infrahub can be used as an inventory source for Nonir.
An example of this can be found in [./examples/nornir_inventory.py](./examples/nornir_inventory.py)

## Infrahub Artifact Tasks

A set of tasks are provided to operate on Infrahub Artifacts.
- `generate_artifacts`: generates the Artifacts for a Artifact Definition
- `regenerate_artifact`: re-generates an Artifact for a Nornir Host
- `get_artifact`: retrieve an Artifact for a Nornir Host

An example of this can be found in [./examples/nornir_tasks.py](./examples/nornir_tasks.py)
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "nornir-infrahub"
version = "0.2.1"
version = "0.2.2"
description = "Nornir plugin for Infrahub"
authors = ["OpsMill <[email protected]>"]
readme = "README.md"
Expand All @@ -24,7 +24,7 @@ classifiers = [

[tool.poetry.dependencies]
python = "^3.8, <3.12"
infrahub-sdk = "^0.3.0"
infrahub-sdk = "^0.3"
ruamel-yaml = "^0.18.5"
nornir = "^3.4.1"
nornir-utils = "^0.2.0"
Expand Down