Change Ansible Collection Namespace & Collection Name (#122)

Author: FragmentedPacket

.travis.yml

@@ -7,9 +7,9 @@ sudo: false
 
 env:
   global:
-    - COLLECTION_NAMESPACE: netbox_community
-    - COLLECTION_NAME: ansible_modules
-    - COLLECTION_VERSION: 0.1.8
+    - COLLECTION_NAMESPACE: netbox
+    - COLLECTION_NAME: netbox
+    - COLLECTION_VERSION: 0.1.9
     - secure: "tE6GtwrRU+Kjobx/94xqR2MqM20pHCnrLcHgPzIHA3npdwuA+GjCBiBLTkEEQM4fUWIfzUTyjSr9bZErm1PTI1GcIRdniTgJ3ZzSSkE7tgeYALB/7xsusB57SlmbBQm2SGwU558uWZ3NHEsi0WTgD8GKZo77OpGX72FZKsVXOz6k2wve51sOtoSVjgCsvWTmZHx4ynGdiA5wFkZfaEcjXECahKtunW+MlB5kpJzkVeLRUEXFMhWlsIYiA5nj8OI/X3Nk9ugh1ribENX9LrjpgrqQ9YariZ8G6py1ONuKZIn2g7xs5kNQ3qL6HL6N7SoUxiwH16CfSyugFaYiMfaxQ4NUVGGRHS4vSGbNIf+gLHcYvP40miI1f/+pntCzqygZMhW73FX2o+KH2OGv09khOl8k1nDg2/XvW0kCc/FU6l+Jp5wCC8H9X2uiULtQpRqts5TzIonlPEzGIpfGFgJ5m54Emhv9gjG1Z5OOyL/qae1Wr+L/uhiFafcglZYh8NHEMWCUCkeqFqR2kDmUMtdgYLD7Q7NdwlL/PSVVs1l7UPiQHlnecQKEHN7CvR3eKByTEmkCKafRYh/JQ9rBt9sZc7aAPVu+w3wWUwbHS4o4vVnmyXvJb1PeJSiuynF7CBo4Qd6qj4YwX8gLK6PylGyaMOp169u6xw1mo5/CX0pJ3x4="
 
 matrix:
@@ -50,7 +50,7 @@ matrix:
 
 before_script:
   - mkdir -p ~/ansible_collections/$COLLECTION_NAMESPACE
-  - cp -R $COLLECTION_NAME ~/ansible_collections/$COLLECTION_NAMESPACE/$COLLECTION_NAME
+  - cp -R ansible_modules ~/ansible_collections/$COLLECTION_NAMESPACE/$COLLECTION_NAME
   - cd ~/ansible_collections/$COLLECTION_NAMESPACE/$COLLECTION_NAME
   - ansible-galaxy collection build .
   - ansible-galaxy collection install $COLLECTION_NAMESPACE-$COLLECTION_NAME-$COLLECTION_VERSION.tar.gz -p /home/travis/.ansible/collections
@@ -63,12 +63,13 @@ script:
   - ansible-playbook tests/integration/regression-tests.yml -vvvv
   - ansible-playbook tests/integration/integration-tests.yml -vvvv
 
+before_deploy:
+  - pip install ansible
+  - ansible-galaxy collection build .
+
 deploy:
   provider: script
   skip_cleanup: true
-  script:
-    - pip install ansible
-    - ansible-galaxy collection build .
-    - ansible-galaxy collection publish $COLLECTION_NAMESPACE-$COLLECTION_NAME-$COLLECTION_VERSION.tar.gz --api-key="$GALAXY_API_TOKEN"
+  script: ansible-galaxy collection publish $COLLECTION_NAMESPACE-$COLLECTION_NAME-$COLLECTION_VERSION.tar.gz --api-key="$GALAXY_API_TOKEN"
   on:
     tags: true

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## v0.1.9
+
+### Overview
+
+This version has a few breaking changes due to new namespace and collection name. I felt it necessary to change the name of the lookup plugin and inventory plugin just not to have a non descriptive namespace call to use them. Below is an example:
+`netbox.netbox.netbox` would be used for both inventory plugin and lookup plugin, but in different contexts so no collision will arise, but confusion will.
+
+I renamed the lookup plugin to `nb_lookup` so it will be used with the FQCN `netbox.netbox.nb_lookup`.
+
+The inventory plugin will now be called within an inventory file by `netbox.netbox.nb_inventory`
+
+### Bug Fixes
+
+- [#120](https://github.com/netbox-community/ansible_modules/pull/120) - Update netbox_tenant and netbox_tenant_group to use slugs for searching (available since NetBox 2.6). Added slug options to netbox_site, netbox_tenant, netbox_tenant_group
+
 ## v.1.8
 
 ### Bug Fixes
@@ -14,7 +29,6 @@
 - [#62](https://github.com/netbox-community/ansible_modules/issues/62) - Change lookups to property for subclassing of inventory plugin
 - [#60](https://github.com/netbox-community/ansible_modules/issues/60) - Added option for interfaces and IP addresses of interfaces to be fetched via inventory plugin
 
-
 ### Bug Fixes
 
 - [#95](https://github.com/netbox-community/ansible_modules/issues/95) - Updated _to_slug to follow same constructs NetBox uses

CONTRIBUTING.md

@@ -261,7 +261,7 @@ Copying an existing module that has close to the same options is typically the p
 - Update the module_util, module, and endpoint variable for the endpoint
 
   ```python
-  from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_dcim import (
+  from ansible_collections.netbox.netbox.plugins.module_utils.netbox_dcim import (
       NetboxDcimModule,
       NB_DEVICE_ROLES,
   )

README.md

@@ -4,9 +4,13 @@
 
 # Netbox modules for Ansible using Ansible Collections
 
+We have moved this collection to a different namespace and collection name on Ansible Galaxy. The new versions will be at `netbox.netbox`.
+
+To keep the code simple, we only officially support the two latesst releases of Netbox and don't guarantee backwards compatibility beyond that. We do try and keep these breaking changes to a minimum, but sometimes changes to NetBox's API cause us to have to make breaking changes.
+
 ## Requirements
 
-- Netbox 2.5+
+- NetBox 2.5+ or the two latest NetBox releases
 - **pynetbox 4.2.5+**
 - Python 3.6+
 - Ansible 2.9+
@@ -55,12 +59,12 @@
 ## How to Use
 
 - Install via Galaxy
-  - `ansible-galaxy collection install netbox_community.ansible_modules`
+  - `ansible-galaxy collection install netbox.netbox`
 - Install via source
   - `git clone [email protected]:netbox-community/ansible_modules.git`
   - `cd ansible_modules`
   - `ansible-galaxy collection build .`
-  - `ansible-galaxy collection install netbox_community-ansible_modules-X.X.X.tar.gz`
+  - `ansible-galaxy collection install netbox-netbox-X.X.X.tar.gz`
     - Can add `-p` to provide a different path other than the default path, but it must be within your `ansible.cfg` or provided via an environment variable.
 
 ### Example playbooks
@@ -73,7 +77,7 @@ Using the **collections** at the play level
   hosts: localhost
   gather_facts: False
   collections:
-    - netbox_community.ansible_modules
+    - netbox.netbox
 
   tasks:
     - name: Create device within Netbox with only required information
@@ -99,7 +103,7 @@ Using the **collections** at the task level
 
   tasks:
     - name: Create device within Netbox with only required information
-      netbox_community.ansible_modules.netbox_device:
+      netbox.netbox.netbox_device:
         netbox_url: http://netbox-demo.org:32768
         netbox_token: 0123456789abcdef0123456789abcdef01234567
         data:
@@ -116,7 +120,7 @@ Using the **collections** in a role's task files
 ```yaml
 ---
 - name: Create device within Netbox with only required information
-  netbox_community.ansible_modules.netbox_device:
+  netbox.netbox.netbox_device:
     netbox_url: http://netbox-demo.org:32768
     netbox_token: 0123456789abcdef0123456789abcdef01234567
     data:
@@ -132,7 +136,7 @@ OR
 ---
 - name: Create device within Netbox with only required information
   collections:
-    - netbox_community.ansible_modules:
+    - netbox.netbox
   netbox_device:
     netbox_url: http://netbox-demo.org:32768
     netbox_token: 0123456789abcdef0123456789abcdef01234567
@@ -158,7 +162,7 @@ Using the **collections** lookup plugin at the task level
       assert:
         that: "{{ query_result|count }} == 3"
       vars:
-        query_result: "{{ query('netbox_community.ansible_modules.netbox', 'sites', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}"
+        query_result: "{{ query('nb_lookup', 'sites', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}"
 ```
 
 ## How to Contribute

galaxy.yml

@@ -3,13 +3,13 @@
 # The namespace of the collection. This can be a company/brand/organization or product namespace under which all
 # content lives. May only contain alphanumeric characters and underscores. Additionally namespaces cannot start with
 # underscores or numbers and cannot contain consecutive underscores
-namespace: netbox_community
+namespace: netbox
 
 # The name of the collection. Has the same character restrictions as 'namespace'
-name: ansible_modules
+name: netbox
 
 # The version of the collection. Must be compatible with semantic versioning
-version: 0.1.8
+version: 0.1.9
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: README.md

plugins/inventory/netbox.py renamed to plugins/inventory/nb_inventory.py

@@ -6,7 +6,7 @@
 __metaclass__ = type
 
 DOCUMENTATION = """
-    name: netbox
+    name: nb_inventory
     plugin_type: inventory
     author:
         - Remy Leone (@sieben)
@@ -23,7 +23,7 @@
         plugin:
             description: token that ensures this is a source file for the 'netbox' plugin.
             required: True
-            choices: ['netbox_community.ansible_modules.netbox']
+            choices: ['netbox.netbox.nb_inventory']
         api_endpoint:
             description: Endpoint of the NetBox API
             required: True
@@ -85,7 +85,7 @@
 # netbox_inventory.yml file in YAML format
 # Example command line: ansible-inventory -v --list -i netbox_inventory.yml
 
-plugin: netbox_community.ansible_modules.netbox
+plugin: netbox.netbox.nb_inventory
 api_endpoint: http://localhost:8000
 validate_certs: True
 config_context: False
@@ -113,7 +113,7 @@
 # NetBox inventory plugin also supports Constructable semantics
 # You can fill your hosts vars using the compose option:
 
-plugin: netbox_community.ansible_modules.netbox
+plugin: netbox.netbox.nb_inventory
 compose:
   foo: last_updated
   bar: display_name
@@ -198,7 +198,7 @@
 
 
 class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
-    NAME = "netbox_community.ansible_modules.netbox"
+    NAME = "netbox.netbox.netbox"
 
     def _fetch_information(self, url):
         results = None

plugins/lookup/netbox.py renamed to plugins/lookup/nb_lookup.py

@@ -23,7 +23,7 @@
 __metaclass__ = type
 
 DOCUMENTATION = """
-    lookup: netbox
+    lookup: nb_lookup
     author: Chris Mills (@cpmills1975)
     version_added: "2.9"
     short_description: Queries and returns elements from Netbox
@@ -64,7 +64,7 @@
       msg: >
         "Device {{ item.value.display_name }} (ID: {{ item.key }}) was
          manufactured by {{ item.value.device_type.manufacturer.name }}"
-    loop: "{{ query('netbox', 'devices',
+    loop: "{{ query('nb_lookup', 'devices',
                     api_endpoint='http://localhost/',
                     token='<redacted>') }}"
 
@@ -77,7 +77,7 @@
       msg: >
         "Device {{ item.value.display_name }} (ID: {{ item.key }}) was
          manufactured by {{ item.value.device_type.manufacturer.name }}"
-    loop: "{{ query('netbox', 'devices',
+    loop: "{{ query('nb_lookup', 'devices',
                     api_endpoint='http://localhost/',
                     api_filter='role=management tag=Dell'),
                     token='<redacted>') }}"
@@ -86,7 +86,7 @@
 tasks:
   - name: "Obtain secrets for R1-Device"
     debug:
-      msg: "{{ query('netbox', 'secrets', api_filter='device=R1-Device', api_endpoint='http://localhost/', token='<redacted>', key_file='~/.ssh/id_rsa') }}"
+      msg: "{{ query('nb_lookup', 'secrets', api_filter='device=R1-Device', api_endpoint='http://localhost/', token='<redacted>', key_file='~/.ssh/id_rsa') }}"
 """
 
 RETURN = """

plugins/module_utils/netbox_circuits.py

@@ -7,7 +7,7 @@
 
 # This should just be temporary once 2.9 is relased and tested we can remove this
 try:
-    from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_utils import (
+    from ansible_collections.netbox.netbox.plugins.module_utils.netbox_utils import (
         NetboxModule,
         ENDPOINT_NAME_MAPPING,
         SLUG_REQUIRED,

plugins/module_utils/netbox_dcim.py

@@ -10,7 +10,7 @@
 from ansible.module_utils.basic import missing_required_lib
 
 try:
-    from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_utils import (
+    from ansible_collections.netbox.netbox.plugins.module_utils.netbox_utils import (
         NetboxModule,
         ENDPOINT_NAME_MAPPING,
         SLUG_REQUIRED,

plugins/module_utils/netbox_extras.py

@@ -7,7 +7,7 @@
 
 # This should just be temporary once 2.9 is relased and tested we can remove this
 try:
-    from ansible_collections.netbox_community.ansible_modules.plugins.module_utils.netbox_utils import (
+    from ansible_collections.netbox.netbox.plugins.module_utils.netbox_utils import (
         NetboxModule,
         ENDPOINT_NAME_MAPPING,
     )