Merge pull request #141 from nornir-automation/rename_abbreviations

rename abbreviations
nornir-automation · May 16, 2018 · 439a0fd · 439a0fd
2 parents f01a4c7 + 5c74d0e
commit 439a0fd
Show file tree

Hide file tree

Showing 9 changed files with 69 additions and 69 deletions.
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ Read the [Nornir documentation](https://nornir.readthedocs.io/) online or review
 Examples
 ========
 
-You can find some examples and already made tools [here](https://github.com/nornir-automation/brg-tools/)
+You can find some examples and already made tools [here](https://github.com/nornir-automation/nornir-tools/)
 
 
 Bugs & New features

diff --git a/docs/index.rst b/docs/index.rst
@@ -36,16 +36,16 @@ Here is an example on how to quickly build a runbook leveraging Nornir to retrie
     from nornir.plugins.functions.text import print_result
     from nornir.plugins.tasks.networking import napalm_get
 
-    brg = InitNornir(
+    nr = InitNornir(
         config_file="nornir.yaml", dry_run=True, num_workers=20
     )
 
-    results = brg.run(
+    results = nr.run(
         task=napalm_get, getters=["facts", "interfaces"]
     )
     print_result(results)
 
-You can find this and other examples `here <https://github.com/nornir-automation/brg-tools/>`_.
+You can find this and other examples `here <https://github.com/nornir-automation/nornir-tools/>`_.
 
 Contents
 ========

diff --git a/docs/tutorials/intro/executing_tasks.ipynb b/docs/tutorials/intro/executing_tasks.ipynb
@@ -7,7 +7,7 @@
    "outputs": [],
    "source": [
     "from nornir.core import InitNornir\n",
-    "brg = InitNornir(config_file=\"config.yaml\")"
+    "nr = InitNornir(config_file=\"config.yaml\")"
    ]
   },
   {
@@ -55,7 +55,7 @@
     "from nornir.plugins.tasks import commands\n",
     "from nornir.plugins.functions.text import print_result\n",
     "\n",
-    "cmh_hosts = brg.filter(site=\"cmh\", role=\"host\")\n",
+    "cmh_hosts = nr.filter(site=\"cmh\", role=\"host\")\n",
     "\n",
     "result = cmh_hosts.run(task=commands.remote_command,\n",
     "                       command=\"ls -la /tmp\")\n",
@@ -138,7 +138,7 @@
    "source": [
     "from nornir.plugins.tasks import networking\n",
     "\n",
-    "cmh_spines = brg.filter(site=\"bma\", role=\"spine\")\n",
+    "cmh_spines = nr.filter(site=\"bma\", role=\"spine\")\n",
     "result = cmh_spines.run(task=networking.napalm_get,\n",
     "                        getters=[\"facts\"])                \n",
     "print_result(result)"
@@ -195,7 +195,7 @@
     "def hi(task):\n",
     "    print(f\"hi! My name is {task.host.name} and I live in {task.host['site']}\")\n",
     "    \n",
-    "brg.run(task=hi, num_workers=1)"
+    "nr.run(task=hi, num_workers=1)"
    ]
   },
   {

diff --git a/docs/tutorials/intro/failed_tasks.ipynb b/docs/tutorials/intro/failed_tasks.ipynb
@@ -21,8 +21,8 @@
     "from nornir.plugins.tasks import networking, text\n",
     "from nornir.plugins.functions.text import print_result\n",
     "\n",
-    "brg = InitNornir(config_file=\"config.yaml\")\n",
-    "cmh = brg.filter(site=\"cmh\", type=\"network_device\")"
+    "nr = InitNornir(config_file=\"config.yaml\")\n",
+    "cmh = nr.filter(site=\"cmh\", type=\"network_device\")"
    ]
   },
   {
@@ -429,7 +429,7 @@
     }
    ],
    "source": [
-    "brg.data.failed_hosts"
+    "nr.data.failed_hosts"
    ]
   },
   {
@@ -456,8 +456,8 @@
     }
    ],
    "source": [
-    "brg.data.reset_failed_hosts()\n",
-    "brg.data.failed_hosts"
+    "nr.data.reset_failed_hosts()\n",
+    "nr.data.failed_hosts"
    ]
   },
   {
@@ -484,8 +484,8 @@
     }
    ],
    "source": [
-    "brg = InitNornir(config_file=\"config.yaml\", raise_on_error=True)\n",
-    "cmh = brg.filter(site=\"cmh\", type=\"network_device\")\n",
+    "nr = InitNornir(config_file=\"config.yaml\", raise_on_error=True)\n",
+    "cmh = nr.filter(site=\"cmh\", type=\"network_device\")\n",
     "try:\n",
     "    cmh.run(task=basic_configuration)\n",
     "except NornirExecutionError:\n",

diff --git a/docs/tutorials/intro/grouping_tasks.ipynb b/docs/tutorials/intro/grouping_tasks.ipynb
@@ -25,8 +25,8 @@
     "from nornir.plugins.tasks import networking, text\n",
     "from nornir.plugins.functions.text import print_title, print_result\n",
     "\n",
-    "brg = InitNornir(config_file=\"config.yaml\", dry_run=True)\n",
-    "cmh = brg.filter(site=\"cmh\", type=\"network_device\")"
+    "nr = InitNornir(config_file=\"config.yaml\", dry_run=True)\n",
+    "cmh = nr.filter(site=\"cmh\", type=\"network_device\")"
    ]
   },
   {
@@ -210,7 +210,7 @@
     "However, this was a `dry_run`. Let's set the `dry_run` variable to `False` so changes are commited and then run the code again:\n",
     "\n",
     "<div class=\"alert alert-info\">\n",
-    "**Note:** The `dry_run` value is shared between the main nornir objects and its childs so in the snippet below `brg.dry_run = False` and `cmh.dry_run = False` are equivalent.\n",
+    "**Note:** The `dry_run` value is shared between the main nornir objects and its childs so in the snippet below `nr.dry_run = False` and `cmh.dry_run = False` are equivalent.\n",
     "</div>"
    ]
   },
@@ -290,7 +290,7 @@
     }
    ],
    "source": [
-    "brg.dry_run = False\n",
+    "nr.dry_run = False\n",
     "print_title(\"Playbook to configure the network\")\n",
     "result = cmh.run(task=basic_configuration)\n",
     "print_result(result)"

diff --git a/docs/tutorials/intro/initializing_nornir.ipynb b/docs/tutorials/intro/initializing_nornir.ipynb
@@ -147,7 +147,7 @@
    "outputs": [],
    "source": [
     "from nornir.core import InitNornir\n",
-    "brg = InitNornir(config_file=\"config.yaml\")"
+    "nr = InitNornir(config_file=\"config.yaml\")"
    ]
   },
   {
@@ -164,7 +164,7 @@
    "outputs": [],
    "source": [
     "from nornir.core import InitNornir\n",
-    "brg = InitNornir(num_workers=100,\n",
+    "nr = InitNornir(num_workers=100,\n",
     "                  inventory=\"nornir.plugins.inventory.simple.SimpleInventory\",\n",
     "                  SimpleInventory={\"host_file\": \"inventory/hosts.yaml\",\n",
     "                                   \"group_file\": \"inventory/groups.yaml\"})"
@@ -184,7 +184,7 @@
    "outputs": [],
    "source": [
     "from nornir.core import InitNornir\n",
-    "brg = InitNornir(num_workers=50, config_file=\"config.yaml\")"
+    "nr = InitNornir(num_workers=50, config_file=\"config.yaml\")"
    ]
   },
   {
@@ -204,7 +204,7 @@
     }
    ],
    "source": [
-    "brg.config.num_workers"
+    "nr.config.num_workers"
    ]
   }
  ],

diff --git a/docs/tutorials/intro/inventory.ipynb b/docs/tutorials/intro/inventory.ipynb
@@ -418,9 +418,9 @@
    ],
    "source": [
     "from nornir.core import InitNornir\n",
-    "brg = InitNornir(config_file=\"config.yaml\")\n",
+    "nr = InitNornir(config_file=\"config.yaml\")\n",
     "\n",
-    "brg.inventory"
+    "nr.inventory"
    ]
   },
   {
@@ -458,7 +458,7 @@
     }
    ],
    "source": [
-    "brg.inventory.hosts"
+    "nr.inventory.hosts"
    ]
   },
   {
@@ -481,7 +481,7 @@
     }
    ],
    "source": [
-    "brg.inventory.groups"
+    "nr.inventory.groups"
    ]
   },
   {
@@ -501,7 +501,7 @@
     }
    ],
    "source": [
-    "brg.inventory.hosts[\"leaf01.bma\"]"
+    "nr.inventory.hosts[\"leaf01.bma\"]"
    ]
   },
   {
@@ -528,7 +528,7 @@
     }
    ],
    "source": [
-    "host = brg.inventory.hosts[\"leaf01.bma\"]\n",
+    "host = nr.inventory.hosts[\"leaf01.bma\"]\n",
     "host.keys()"
    ]
   },
@@ -709,7 +709,7 @@
     }
    ],
    "source": [
-    "leaf01_bma = brg.inventory.hosts[\"leaf01.bma\"]\n",
+    "leaf01_bma = nr.inventory.hosts[\"leaf01.bma\"]\n",
     "leaf01_bma[\"domain\"]  # comes from the group `global`"
    ]
   },
@@ -757,7 +757,7 @@
     }
    ],
    "source": [
-    "leaf01_cmh = brg.inventory.hosts[\"leaf01.cmh\"]\n",
+    "leaf01_cmh = nr.inventory.hosts[\"leaf01.cmh\"]\n",
     "leaf01_cmh[\"domain\"]  # comes from defaults"
    ]
   },
@@ -821,7 +821,7 @@
    "source": [
     "### Filtering the inventory\n",
     "\n",
-    "So far we have seen that `brg.inventory.hosts` and `brg.inventory.groups` are dict-like objects that we can use to iterate over all the hosts and groups or to access any particular one directly. Now we are going to see how we can do some fancy filtering that will enable us to operate on groups of hosts based on their properties.\n",
+    "So far we have seen that `nr.inventory.hosts` and `nr.inventory.groups` are dict-like objects that we can use to iterate over all the hosts and groups or to access any particular one directly. Now we are going to see how we can do some fancy filtering that will enable us to operate on groups of hosts based on their properties.\n",
     "\n",
     "The simpler way of filtering hosts is by `<key, value>` pairs. For instance:"
    ]
@@ -843,7 +843,7 @@
     }
    ],
    "source": [
-    "brg.filter(site=\"cmh\").inventory.hosts.keys()"
+    "nr.filter(site=\"cmh\").inventory.hosts.keys()"
    ]
   },
   {
@@ -870,7 +870,7 @@
     }
    ],
    "source": [
-    "brg.filter(site=\"cmh\", role=\"spine\").inventory.hosts.keys()"
+    "nr.filter(site=\"cmh\", role=\"spine\").inventory.hosts.keys()"
    ]
   },
   {
@@ -897,7 +897,7 @@
     }
    ],
    "source": [
-    "brg.filter(site=\"cmh\").filter(role=\"spine\").inventory.hosts.keys()"
+    "nr.filter(site=\"cmh\").filter(role=\"spine\").inventory.hosts.keys()"
    ]
   },
   {
@@ -924,7 +924,7 @@
     }
    ],
    "source": [
-    "cmh = brg.filter(site=\"cmh\")\n",
+    "cmh = nr.filter(site=\"cmh\")\n",
     "cmh.filter(role=\"spine\").inventory.hosts.keys()"
    ]
   },
@@ -977,7 +977,7 @@
     }
    ],
    "source": [
-    "brg.inventory.groups[\"eu\"].children()"
+    "nr.inventory.groups[\"eu\"].children()"
    ]
   },
   {
@@ -1009,7 +1009,7 @@
     "def has_long_name(host):\n",
     "    return len(host.name) == 11\n",
     "\n",
-    "brg.filter(filter_func=has_long_name).inventory.hosts.keys()"
+    "nr.filter(filter_func=has_long_name).inventory.hosts.keys()"
    ]
   },
   {
@@ -1030,7 +1030,7 @@
    ],
    "source": [
     "# Or a lambda function\n",
-    "brg.filter(filter_func=lambda h: len(h.name) == 9).inventory.hosts.keys()"
+    "nr.filter(filter_func=lambda h: len(h.name) == 9).inventory.hosts.keys()"
    ]
   }
  ],

diff --git a/docs/tutorials/intro/task_results.ipynb b/docs/tutorials/intro/task_results.ipynb
@@ -22,8 +22,8 @@
     "from nornir.plugins.functions.text import print_title\n",
     "import logging\n",
     "\n",
-    "brg = InitNornir(config_file=\"config.yaml\", dry_run=True)\n",
-    "cmh = brg.filter(site=\"cmh\", type=\"network_device\")\n",
+    "nr = InitNornir(config_file=\"config.yaml\", dry_run=True)\n",
+    "cmh = nr.filter(site=\"cmh\", type=\"network_device\")\n",
     "\n",
     "def basic_configuration(task):\n",
     "    # Transform inventory data to configuration via a template file\n",