From 025411008d38251148fd5fa962fa416658f61090 Mon Sep 17 00:00:00 2001 From: Jan Snasel Date: Fri, 3 Nov 2023 09:09:59 +0000 Subject: [PATCH] chore: Fix moved files --- docs/admin/install.md | 16 +++++++++++----- docs/admin/uninstall.md | 14 ++++++++++---- docs/admin/upgrade.md | 4 +++- docs/dev/contributing.md | 3 ++- docs/user/external_interactions.md | 2 ++ 5 files changed, 28 insertions(+), 11 deletions(-) diff --git a/docs/admin/install.md b/docs/admin/install.md index df2653d7..3887490e 100644 --- a/docs/admin/install.md +++ b/docs/admin/install.md @@ -1,14 +1,20 @@ # Installing the App in Nautobot +Here you will find detailed instructions on how to **install** and **configure** the App within your Nautobot environment. + ## Prerequisites - The plugin relies on [`nautobot_plugin_nornir`](https://pypi.org/project/nautobot-plugin-nornir/) to be installed and both plugins to be enabled in your configuration settings. -- The plugin is compatible with Nautobot 1.4.0 and higher. +- The plugin is compatible with Nautobot 2.0.0 and higher. - Databases supported: PostgreSQL, MySQL !!! note Please check the [dedicated page](compatibility_matrix.md) for a full compatibility matrix and the deprecation policy. +### Access Requirements + +There are no access requirements from external systems to this plugin. + ## Install Guide !!! note @@ -71,13 +77,13 @@ PLUGINS_CONFIG = { } ``` -Once the Nautobot configuration is updated, run the Post Upgrade command (`nautobot-server post_upgrade`) to run migrations and clear any cache. +Once the Nautobot configuration is updated, run the Post Upgrade command (`nautobot-server post_upgrade`) to run migrations and clear any cache: ```shell nautobot-server post_upgrade ``` -Then restart the Nautobot services which may include: +Then restart (if necessary) the Nautobot services which may include: - Nautobot - Nautobot Workers @@ -89,7 +95,7 @@ sudo systemctl restart nautobot nautobot-worker nautobot-scheduler ## App Configuration -The plugin behavior can be controlled with the following list of settings. +The plugin behavior can be controlled with the following list of settings: !!! note The `enable_backup`, `enable_compliance`, `enable_intended`, `enable_sotagg`, `enable_plan`, `enable_deploy`, and `enable_postprocessing` will toggle inclusion of the entire component. @@ -153,4 +159,4 @@ PLUGINS_CONFIG = { } ``` -The format for defining these methods is via the dotted string format that will be imported by Django. For example, the Netmiko Cisco IOS dispatcher is defined as `nornir_nautobot.plugins.tasks.dispatcher.cisco_ios.NetmikoCiscoIos`. You also must hand any installation of the packaging and assurance that the value you provide is importable in the environment you run it on. \ No newline at end of file +The format for defining these methods is via the dotted string format that will be imported by Django. For example, the Netmiko Cisco IOS dispatcher is defined as `nornir_nautobot.plugins.tasks.dispatcher.cisco_ios.NetmikoCiscoIos`. You also must hand any installation of the packaging and assurance that the value you provide is importable in the environment you run it on. diff --git a/docs/admin/uninstall.md b/docs/admin/uninstall.md index 2bc048c7..6188e343 100644 --- a/docs/admin/uninstall.md +++ b/docs/admin/uninstall.md @@ -1,9 +1,15 @@ # Uninstall the App from Nautobot -## Uninstall Guide - -Remove the configuration you added in `nautobot_config.py` from `PLUGINS` & `PLUGINS_CONFIG`. +Here you will find any steps necessary to cleanly remove the App from your Nautobot environment. ## Database Cleanup -Drop all tables from the plugin: `nautobot_plugin_goldenconfig*`. +Prior to removing the plugin from the `nautobot_config.py`, run the following command to roll back any migration specific to this plugin. + +```shell +nautobot-server migrate nautobot_plugin_golden_config zero +``` + +## Remove App configuration + +Remove the configuration you added in `nautobot_config.py` from `PLUGINS` & `PLUGINS_CONFIG`. diff --git a/docs/admin/upgrade.md b/docs/admin/upgrade.md index 53109384..f4192592 100644 --- a/docs/admin/upgrade.md +++ b/docs/admin/upgrade.md @@ -1,8 +1,10 @@ # Upgrading the App +Here you will find any steps necessary to upgrade the App in your Nautobot environment. + ## Upgrade Guide -When a new release comes out it may be necessary to run a migration of the database to account for any changes in the data models used by this plugin. Execute the command `nautobot-server migrate` from the Nautobot install nautobot/ directory after updating the package. +When a new release comes out it may be necessary to run a migration of the database to account for any changes in the data models used by this plugin. Execute the command `nautobot-server post-upgrade` within the runtime environment of your Nautobot installation after updating the `nautobot-golden-config` package via `pip`. ## v1.0.0 diff --git a/docs/dev/contributing.md b/docs/dev/contributing.md index 0043135c..5ca961d4 100644 --- a/docs/dev/contributing.md +++ b/docs/dev/contributing.md @@ -4,7 +4,8 @@ The project is packaged with a light [development environment](dev_environment.m The project is following Network to Code software development guidelines and is leveraging the following: -- Black, Pylint, Bandit, flake8, yamllint, and pydocstyle for Python linting and formatting. +- Python linting and formatting: `black`, `pylint`, `bandit`, `flake8`, and `pydocstyle`. +- YAML linting is done with `yamllint`. - Django unit test to ensure the plugin is working properly. Documentation is built using [mkdocs](https://www.mkdocs.org/). The [Docker based development environment](dev_environment.md#docker-development-environment) automatically starts a container hosting a live version of the documentation website on [http://localhost:8001](http://localhost:8001) that auto-refreshes when you make any changes to your local files. diff --git a/docs/user/external_interactions.md b/docs/user/external_interactions.md index e80b8424..b6788d92 100644 --- a/docs/user/external_interactions.md +++ b/docs/user/external_interactions.md @@ -1,5 +1,7 @@ # External Interactions +This document describes external dependencies and prerequisites for this App to operate, including system requirements, API endpoints, interconnection or integrations to other applications or services, and similar topics. + ### From the App to Other Systems - Git integrations are required, this is generally `tcp/22` or `tcp/443` to the git repository.