Sync bitbucket and GitHub

CHANGELOG.rst

@@ -5,6 +5,14 @@ Azure NetApp Files (ANF) Collection Release Notes
 .. contents:: Topics
 
 
+v21.8.1
+=======
+
+Bugfixes
+--------
+
+- Hub Automation cannot generate documentation (cannot use doc fragments from another collection).
+
 v21.8.0
 =======
 

HACK.md

@@ -0,0 +1,13 @@
+Because of an issue in Ansible, Hub Automation cannot use doc fragments from an external collection as:
+```
+    - azure.azcollection.azure
+    - azure.azcollection.azure_tags
+```
+
+Red Hat asked us to make local copies of the azcollection doc fragments.  They are in
+```
+ansible_collections/netapp/azure/plugins/doc_fragments/azure.py
+ansible_collections/netapp/azure/plugins/doc_fragments/azure_tags.py
+```
+
+Once the Ansible issue is fixed, we should remove these copies, as they may be out of sync with the azcollection.

README.md

@@ -32,6 +32,13 @@ Join our Slack Channel at [Netapp.io](http://netapp.io/slack)
 This collection follows the [Ansible project's Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html).
 
 # Release Notes
+
+
+## 21.8.1
+
+### Bug Fixes
+  - Hub Automation cannot generate documentation (cannot use doc fragments from another collection).
+
 ## 21.8.0
 
 ### Bug Fixes

changelogs/changelog.yaml

@@ -141,3 +141,11 @@ releases:
     fragments:
     - DEVOPS-4070.yaml
     release_date: '2021-07-14'
+  21.8.1:
+    changes:
+      bugfixes:
+      - Hub Automation cannot generate documentation (cannot use doc fragments from
+        another collection).
+    fragments:
+    - DEVOPS-4135.yaml
+    release_date: '2021-07-16'

changelogs/fragments/DEVOPS-4135.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+  - Hub Automation cannot generate documentation (cannot use doc fragments from another collection).

galaxy.yml

@@ -1,6 +1,6 @@
 namespace: "netapp"
 name: "azure"
-version: "21.8.0"
+version: "21.8.1"
 authors:
     - "NetApp Ansible Team <[email protected]>"
 license_file: COPYING

plugins/doc_fragments/azure.py

@@ -0,0 +1,129 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2016 Matt Davis, <[email protected]>
+# Copyright: (c) 2016 Chris Houseknecht, <[email protected]>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+
+    # Azure doc fragment
+    DOCUMENTATION = r'''
+
+options:
+    ad_user:
+        description:
+            - Active Directory username. Use when authenticating with an Active Directory user rather than service
+              principal.
+        type: str
+    password:
+        description:
+            - Active Directory user password. Use when authenticating with an Active Directory user rather than service
+              principal.
+        type: str
+    profile:
+        description:
+            - Security profile found in ~/.azure/credentials file.
+        type: str
+    subscription_id:
+        description:
+            - Your Azure subscription Id.
+        type: str
+    client_id:
+        description:
+            - Azure client ID. Use when authenticating with a Service Principal.
+        type: str
+    secret:
+        description:
+            - Azure client secret. Use when authenticating with a Service Principal.
+        type: str
+    tenant:
+        description:
+            - Azure tenant ID. Use when authenticating with a Service Principal.
+        type: str
+    cloud_environment:
+        description:
+            - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud),
+              C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or
+              the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
+        type: str
+        default: AzureCloud
+        version_added: '0.0.1'
+    adfs_authority_url:
+        description:
+            - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
+        type: str
+        version_added: '0.0.1'
+    cert_validation_mode:
+        description:
+            - Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but
+              when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be
+              set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable.
+        type: str
+        choices: [ ignore, validate ]
+        version_added: '0.0.1'
+    auth_source:
+        description:
+            - Controls the source of the credentials to use for authentication.
+            - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
+            - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli).
+            - When set to C(env), the credentials will be read from the environment variables
+            - When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
+            - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable
+              C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if more than one is present otherwise the default
+              az cli subscription is used.
+            - When set to C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the
+              environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if the resource is granted
+              access to more than one subscription, otherwise the first subscription is chosen.
+            - The C(msi) was added in Ansible 2.6.
+        type: str
+        default: auto
+        choices:
+        - auto
+        - cli
+        - credential_file
+        - env
+        - msi
+        version_added: '0.0.1'
+    api_profile:
+        description:
+        - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds;
+          future values will allow use with Azure Stack.
+        type: str
+        default: latest
+        version_added: '0.0.1'
+    log_path:
+        description:
+            - Parent argument.
+        type: str
+    log_mode:
+        description:
+            - Parent argument.
+        type: str
+requirements:
+    - python >= 2.7
+    - The host that executes this module must have the azure.azcollection collection installed via galaxy
+    - All python packages listed in collection's requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
+    - Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
+
+notes:
+    - For authentication with Azure you can pass parameters, set environment variables, use a profile stored
+      in ~/.azure/credentials, or log in before you run your tasks or playbook with C(az login).
+    - Authentication is also possible using a service principal or Active Directory user.
+    - To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment
+      variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
+    - To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and
+      AZURE_PASSWORD in the environment.
+    - "Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing
+      a [default] section and the following keys: subscription_id, client_id, secret and tenant or
+      subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile
+      by passing profile or setting AZURE_PROFILE in the environment."
+
+seealso:
+    - name: Sign in with Azure CLI
+      link: https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest
+      description: How to authenticate using the C(az login) command.
+    '''

plugins/doc_fragments/azure_tags.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2016, Matt Davis, <[email protected]>
+# Copyright: (c) 2016, Chris Houseknecht, <[email protected]>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+
+    # Azure doc fragment
+    DOCUMENTATION = r'''
+options:
+    tags:
+        description:
+            - Dictionary of string:string pairs to assign as metadata to the object.
+            - Metadata tags on the object will be updated with any provided values.
+            - To remove tags set append_tags option to false.
+            - Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag.
+            - Azure Front Door doesn't support the use of # in the tag name.
+            - Azure Automation and Azure CDN only support 15 tags on resources.
+        type: dict
+    append_tags:
+        description:
+            - Use to control if tags field is canonical or just appends to existing tags.
+            - When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
+        type: bool
+        default: yes
+    '''

plugins/module_utils/azure_rm_netapp_common.py

@@ -14,7 +14,7 @@
 
 HAS_AZURE_COLLECTION = True
 NEW_STYLE = None
-COLLECTION_VERSION = "21.8.0"
+COLLECTION_VERSION = "21.8.1"
 IMPORT_ERRORS = list()
 
 if 'pytest' in sys.modules:

plugins/modules/azure_rm_netapp_account.py

@@ -23,8 +23,8 @@
     - Create and delete NetApp Azure account.
       Provide the Resource group name for the NetApp account to be created.
 extends_documentation_fragment:
-    - azure.azcollection.azure
-    - azure.azcollection.azure_tags
+    - netapp.azure.azure
+    - netapp.azure.azure_tags
     - netapp.azure.netapp.azure_rm_netapp
 
 options:

plugins/modules/azure_rm_netapp_capacity_pool.py

@@ -24,8 +24,8 @@
       Provide the Resource group name for the capacity pool to be created.
     - Resize NetApp Azure capacity pool
 extends_documentation_fragment:
-    - azure.azcollection.azure
-    - azure.azcollection.azure_tags
+    - netapp.azure.azure
+    - netapp.azure.azure_tags
     - netapp.azure.netapp.azure_rm_netapp
 
 options:
@@ -116,7 +116,7 @@
     from azure.mgmt.netapp.models import CapacityPool
     HAS_AZURE_MGMT_NETAPP = True
 except ImportError as exc:
-    HAS_AZURE_MGMT_NETAPP = False
+    IMPORT_ERRORS.append(str(exc))
 
 from ansible.module_utils.basic import to_native
 from ansible_collections.netapp.azure.plugins.module_utils.azure_rm_netapp_common import AzureRMNetAppModuleBase

plugins/modules/azure_rm_netapp_snapshot.py

@@ -22,7 +22,7 @@
 description:
     - Create and delete NetApp Azure Snapshot.
 extends_documentation_fragment:
-    - azure.azcollection.azure
+    - netapp.azure.azure
     - netapp.azure.netapp.azure_rm_netapp
 
 options:
@@ -103,7 +103,6 @@
     from azure.mgmt.netapp.models import Snapshot
     HAS_AZURE_MGMT_NETAPP = True
 except ImportError as exc:
-    HAS_AZURE_MGMT_NETAPP = False
     IMPORT_ERRORS.append(str(exc))
 
 from ansible.module_utils.basic import to_native

plugins/modules/azure_rm_netapp_volume.py

@@ -22,8 +22,8 @@
 description:
     - Create and delete NetApp Azure volume.
 extends_documentation_fragment:
-    - azure.azcollection.azure
-    - azure.azcollection.azure_tags
+    - netapp.azure.azure
+    - netapp.azure.azure_tags
     - netapp.azure.netapp.azure_rm_netapp
 
 options: