Skip to content

Commit

Permalink
chore: Fix moved files
Browse files Browse the repository at this point in the history
  • Loading branch information
snaselj committed Nov 3, 2023
1 parent d1601b8 commit 5c6a755
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 11 deletions.
16 changes: 11 additions & 5 deletions docs/admin/install.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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.
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.
14 changes: 10 additions & 4 deletions docs/admin/uninstall.md
Original file line number Diff line number Diff line change
@@ -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`.
4 changes: 3 additions & 1 deletion docs/admin/upgrade.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
3 changes: 2 additions & 1 deletion docs/dev/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/user/external_interactions.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit 5c6a755

Please sign in to comment.