2
2
3
3
### Overview
4
4
5
- The resource module builder is an Ansible playbook that helps developers scaffold and maintain an Ansible network resource modules .
5
+ The resource module builder is an Ansible Playbook that helps developers scaffold and maintain an Ansible network resource module .
6
6
7
7
** Capabilities**
8
8
- Use a defined model to scaffold a resource module directory layout and initial class files.
9
- - Scaffold either an ansible role or collection.
10
- - Subsequent uses of RMB will only replace the module arspec and file containing the module doc string.
11
- - Complex examples can be stored along side the model in the same directory
9
+ - Scaffold either an Ansible role or a collection.
10
+ - Subsequent uses of the Resource Module Builder ( RMB) will only replace the module arspec and file containing the module doc string.
11
+ - Complex examples can be stored along side the model in the same directory.
12
12
- Maintain the model as the source of truth for the module and use RMB to update the source files as needed.
13
13
- Generates working sample modules for both ` <network_os>_<resource> ` and ` <network_os>_facts `
14
14
@@ -228,7 +228,7 @@ def main():
228
228
229
229
` module_utils/<ansible_network_os>/facts/<resource>/ ` .
230
230
231
- - Populate facts for the resource
231
+ - Populate facts for the resource.
232
232
- Entry in ` module_utils/<ansible_network_os>/facts/facts.py ` for ` get_facts ` API to keep
233
233
` <ansible_network_os>_facts ` module and facts gathered for the resource module in sync
234
234
for every subset.
@@ -237,10 +237,10 @@ def main():
237
237
238
238
` module_utils/<ansible_network_os>/<config>/<resource>/ ` .
239
239
240
- - Implement ` execute_module ` API that loads the config to device and generates result with
240
+ - Implement ` execute_module ` API that loads the config to device and generates the result with
241
241
` changed ` , ` commands ` , ` before ` and ` after ` keys.
242
- - Call ` get_facts ` API that returns the ` <resource> ` config facts or Return the diff if the
243
- device has onbox support diff support.
242
+ - Call ` get_facts ` API that returns the ` <resource> ` config facts or return the diff if the
243
+ device has onbox diff support.
244
244
- Compare facts gathered and given key-values if diff is not supported.
245
245
- Generate final config.
246
246
0 commit comments