Skip to content

Commit

Permalink
Merge pull request #254 from nautobot/stable-1.0
Browse files Browse the repository at this point in the history
Stable 1.0
  • Loading branch information
itdependsnetworks authored May 9, 2022
2 parents ae9dfae + aa9431d commit f4cea3c
Show file tree
Hide file tree
Showing 8 changed files with 45 additions and 20 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Changelog

## v1.0.2 - 2022-05

### Fixed

- #246 Dependabot update to Docker redis-7.x
- #233 Dependabot update to paramiko-2.10.1
- #251 Add description to CSV config replace export

## v1.0.1 - 2022-05

### Fixed

- #238 Fixed repo/docs/homepage links for PyPI
- #243 Removing unneed javascript source as it is part of #243

## v1.0.0 - 2022-04

### Announcements
Expand Down
2 changes: 1 addition & 1 deletion development/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ services:
volumes:
- "pgdata_nautobot_golden_config:/var/lib/postgresql/data"
redis:
image: "redis:6-alpine"
image: "redis:7-alpine"
command:
- "sh"
- "-c" # this is to evaluate the $REDIS_PASSWORD from the env
Expand Down
9 changes: 4 additions & 5 deletions docs/navigating-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,8 @@ and save the configuration. The high-level process to run backups is:

## Configuration Backup Settings

Backup configurations often need some amount of parsing to stay sane. The two obvious use cases are the ability to remove lines such as the "Last
Configuration" changed date, as this will cause unnecessary changes the second is to strip out secrets from the configuration. In an effort to support these
uses cases, the following settings are available and further documented below.
Backup configurations often need some amount of parsing to stay sane. The two obvious use cases are firstly the ability to remove lines such as the "Last
Configuration" changed date, as this will cause unnecessary changes and secondly stripping out secrets from the configuration. In an effort to support these use cases, the following settings are available and further documented below.

* Config Removals - provides the ability to remove a line based on a regex match.
* Config Replacements - provides the ability to swap out parts of a line based on a regex match.
Expand Down Expand Up @@ -48,7 +47,7 @@ The `backup_path_template` can be set in the UI. For navigation details [see](.
### Device Login Credentials

The credentials/secrets management is further described within the [nautbot-plugin-nornir](https://github.com/nautobot/nautobot-plugin-nornir)
repository. For the simplist use case you can set environment variables for `NAPALM_USERNAME`, `NAPALM_PASSWORD`, and `DEVICE_SECRET`. For more
repository. For the simplest use case you can set environment variables for `NAPALM_USERNAME`, `NAPALM_PASSWORD`, and `DEVICE_SECRET`. For more
complicated use cases, please refer to the plugin documentation linked above.

## Starting a Backup Job
Expand Down Expand Up @@ -82,4 +81,4 @@ The line replace uses Python's `re.sub` method. As shown, a common pattern is to

```python
re.sub(r"(username\s+\S+\spassword\s+5\s+)\S+(\s+role\s+\S+)", r"\1<redacted_config>\2", config, flags=re.MULTILINE))
```
```
2 changes: 1 addition & 1 deletion nautobot_golden_config/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Plugin declaration for nautobot_golden_config."""

__version__ = "1.0.0"
__version__ = "1.0.2"

from nautobot.extras.plugins import PluginConfig

Expand Down
2 changes: 1 addition & 1 deletion nautobot_golden_config/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -663,7 +663,7 @@ class ConfigReplace(PrimaryModel):

def to_csv(self):
"""Indicates model fields to return as csv."""
return (self.name, self.platform.slug, self.regex, self.replace)
return (self.name, self.platform.slug, self.description, self.regex, self.replace)

class Meta:
"""Meta information for ConfigReplace model."""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -229,9 +229,6 @@ <h1>{{ object }}</h1>
{% endblock content %}

{% block javascript %}
<script src="{% static 'clipboard.js/clipboard-2.0.6.min.js' %}"
onerror="window.location='{% url 'media_failure' %}?filename=clipboard.js/clipboard-2.0.6.min.js'">
</script>
<script>
url = window.location.href.split("?")[0];
window.history.pushState({}, document.title, url);
Expand Down
24 changes: 19 additions & 5 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
[tool.poetry]
name = "nautobot-golden-config"
version = "1.0.0"
version = "1.0.2"
description = "A plugin for configuration on nautobot"
authors = ["Network to Code, LLC", "<[email protected]>"]

license = "Apache-2.0"

readme = "README.md"
homepage = "https://github.com/nautobot/nautobot-golden-config"
repository = "https://github.com/nautobot/nautobot-golden-config"
documentation = "https://github.com/nautobot/nautobot-golden-config"
homepage = "https://github.com/nautobot/nautobot-plugin-golden-config"
repository = "https://github.com/nautobot/nautobot-plugin-golden-config"
documentation = "https://github.com/nautobot/nautobot-plugin-golden-config"
keywords = ["nautobot", "nautobot-plugin"]
include = [
"CHANGELOG.md",
Expand Down

0 comments on commit f4cea3c

Please sign in to comment.