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

Improve CredentialsSettingsVars documentation #59

Closed
Niogui opened this issue Jun 13, 2022 · 2 comments · Fixed by #60
Closed

Improve CredentialsSettingsVars documentation #59

Niogui opened this issue Jun 13, 2022 · 2 comments · Fixed by #60

Comments

@Niogui
Copy link

Niogui commented Jun 13, 2022

I think it would be a good idea to update the README.md of ntc-nautobot-plugin-nornir to replace the sample config:

PLUGINS_CONFIG = {
    "nautobot_plugin_nornir": {
        # ...
        "dispatcher_mapping": None,
        "username": "ntc",
        "password": "password123",
        "secret": "password123",
    }
}

with

PLUGINS_CONFIG = {
    "nautobot_plugin_nornir": {
        "nornir_settings": {
            "credentials": "nautobot_plugin_nornir.plugins.credentials.settings_vars.CredentialsSettingsVars
            # ...
        },
        # ...
        "dispatcher_mapping": None,
        "username": "ntc",
        "password": "password123",
        "secret": "password123",
    }
}

It would be much more explicit and avoid some mistake

@Niogui
Copy link
Author

Niogui commented Jun 13, 2022

And you can also fix a typo in the previous bloc of code:

        "use_config_context": {"secrets", False, "connection_options": True},

should be:

        "use_config_context": {"secrets": False, "connection_options": True},

comma after secrets to be replaced by colons

@JulioPDX
Copy link

@jeffkala This issue reflects the changes that could be made to simplify or reduce errors. Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants