From af2222b507fc7e899829aca76f050b81dfd9b01b Mon Sep 17 00:00:00 2001 From: Marek Zbroch Date: Sat, 16 Sep 2023 08:33:12 +0200 Subject: [PATCH 1/3] Updating README --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 04143ede..364159da 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,8 @@ This plugin enable five (5) key use cases. 2. **Intended Configuration** - Is a Nornir process to generate configuration based on a Git repo of Jinja files to combine with a GraphQL generated data and a Git repo to store the intended configuration. 3. **Source of Truth Aggregation** - Is a GraphQL query per device that creates a data structure used in the generation of configuration. 4. **Configuration Compliance** - Is a process to run comparison of the actual (via backups) and intended (via Jinja file creation) CLI configurations upon saving the actual and intended configuration. This is started by either a Nornir process for cli-like configurations or calling the API for json-like configurations -5. **Configuration Postprocessing** - (beta) This process renders a valid configuration artifact from an intended configuration, that can be pushed to devices. The current implementation renders this configuration; however, **it doesn't push it** to the target device. +5. **Configuration Remediation** - Is a process of generating a partial device configuration that would get a configuration feature into a compliant state. +6. **Configuration Deployment** - Is a process to generate a device configuration and push it to the network device. It supports compliance features, remediation engine and manual definitions. > Notice: The operators of their own Nautobot instance are welcome to use any combination of these features. Though the appearance may seem like they are tightly coupled, this isn't actually the case. For example, one can obtain backup configurations from their current RANCID/Oxidized process and simply provide a Git Repo of the location of the backup configurations, and the compliance process would work the same way. Also, another user may only want to generate configurations, but not want to use other features, which is perfectly fine to do so. From 9d2c00ef40347865c2cb8317d17c66c5bb5f5b4e Mon Sep 17 00:00:00 2001 From: Marek Zbroch Date: Sat, 16 Sep 2023 08:33:55 +0200 Subject: [PATCH 2/3] Updating README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 364159da..12130032 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ The Golden Config plugin is a Nautobot plugin that provides a NetDevOps approach ### Key Use Cases -This plugin enable five (5) key use cases. +This plugin enable six (6) key use cases. 1. **Configuration Backups** - Is a Nornir process to connect to devices, optionally parse out lines/secrets, backup the configuration, and save to a Git repository. 2. **Intended Configuration** - Is a Nornir process to generate configuration based on a Git repo of Jinja files to combine with a GraphQL generated data and a Git repo to store the intended configuration. From 869bdf43a8187dfea4d9fa5e935b5cf7a04f5ce9 Mon Sep 17 00:00:00 2001 From: Marek Zbroch Date: Fri, 22 Sep 2023 13:19:20 +0200 Subject: [PATCH 3/3] Updating README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 12130032..8af41be3 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,8 @@ This plugin enable six (6) key use cases. 5. **Configuration Remediation** - Is a process of generating a partial device configuration that would get a configuration feature into a compliant state. 6. **Configuration Deployment** - Is a process to generate a device configuration and push it to the network device. It supports compliance features, remediation engine and manual definitions. +> Notice: **Configuration Postprocessing** - (beta feature) This process renders a valid configuration artifact from an intended configuration, that can be pushed to devices. The current implementation renders this configuration; however, **it doesn't push it** to the target device. + > Notice: The operators of their own Nautobot instance are welcome to use any combination of these features. Though the appearance may seem like they are tightly coupled, this isn't actually the case. For example, one can obtain backup configurations from their current RANCID/Oxidized process and simply provide a Git Repo of the location of the backup configurations, and the compliance process would work the same way. Also, another user may only want to generate configurations, but not want to use other features, which is perfectly fine to do so. ## Screenshots