Enhance the proxy_napalm_wrap decorator to allow "proxyless" execution #48290
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Usually the Salt proxies have been designed using a single methodology: for each device you aim to manage, start one Proxy Minion. The NAPALM modules didn't make an exception, however, beginning with saltstack#38339 (therefore starting with release Nitrogen), the functionality has been enhanced in such a way that we can execute the code when we are able to install the regular Minion directly on the network hardware. There is another use case, for something, let's call it "proxyless" when we don't particularly need to start a Proxy process for each device, but rather simply invoke arbitrary functions. These changes make this possible, so with one single Minion (whether Proxy or regular), one is able to execute Salt commands going through the NAPALM library to connect to the remote network device by specifying the connection details from the command line and/or opts/pillar, e.g. ``salt server1 bgp.neighbors driver=junos host=1.2.3.4 username=salt``. If the ``server1`` Minion has the following block in the Pillar (for example): ```yaml napalm: driver: junos username: salt ``` The user would only need to provide the rest of the credentials (depending on each individual case): ``salt server1 bgp.neighbors host=1.2.3.4``.
…lm_inventory
This is going to ease the CLI usage, so we can reduce everything to simply
specifying the host of the device, e.g.,
Having the following configuration in the opts/pillar:
```yaml
napalm:
username: salt
password: test
napalm_inventory:
1.2.3.4:
driver: eos
edge01.bzr01:
driver: junos
```
With the above available in the opts/pillar for a Minion, say ``server1``, the
user would be able to execute: ``salt 'server1' bgp.neighbors host=1.2.3.4`` or
``salt 'server1' net.arp host=edge01.bzr01``, etc.
gtmanfred
suggested changes
Jun 25, 2018
salt/utils/napalm.py
Outdated
| napalm_opts.update(inventory_opts) | ||
| log.debug('Merging the config for %s with the details found in the napalm inventory:', host) | ||
| log.debug(napalm_opts) | ||
| opts = opts.copy() # make sure we don't override the original |
Contributor
There was a problem hiding this comment.
you will probably want to do a copy.deepcopy(opts) here instead, to get any nested options.
Contributor
Author
There was a problem hiding this comment.
Good catch, thanks! When I wrote this I was too focused only at that chunk of config, but indeed, the others would be affected if not using copy.deepcopy.
Contributor
|
Other than one small change, this LGTM |
gtmanfred
approved these changes
Jun 26, 2018
rallytime
approved these changes
Jun 26, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Usually the Salt proxies have been designed using a single methodology: for
each device you aim to manage, start one Proxy Minion. The NAPALM modules didn't
make an exception, however, beginning with #38339
(therefore starting with release Nitrogen), the functionality has been enhanced
in such a way that we can execute the code when we are able to install the
regular Minion directly on the network hardware.
There is another use case, for something, let's call it "proxyless" when we
don't particularly need to start a Proxy process for each device, but rather
simply invoke arbitrary functions. These changes make this possible, so with one
single Minion (whether Proxy or regular), one is able to execute Salt commands
going through the NAPALM library to connect to the remote network device by
specifying the connection details from the command line and/or opts/pillar, e.g.
salt server1 bgp.neighbors driver=junos host=1.2.3.4 username=salt.If the
server1Minion has the following block in the Pillar (for example):The user would only need to provide the rest of the credentials (depending on
each individual case):
salt server1 bgp.neighbors host=1.2.3.4.Having the following configuration in the opts/pillar, for example:
With the above available in the opts/pillar for a Minion, say
server1, theuser would be able to execute:
salt 'server1' bgp.neighbors host=1.2.3.4orsalt 'server1' net.arp host=edge01.bzr01, etc.