Merge pull request #83 from felixs88/docs-3.1.0

Documentation for 3.1.0

.github/workflows/ansible-test.yml

@@ -17,7 +17,7 @@ jobs:
         ansible-version: [stable-2.15, stable-2.16, stable-2.17, devel]
     steps:
       - name: Check out code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
 
       - name: Set up Python 3.11
         uses: actions/setup-python@v4
@@ -38,7 +38,7 @@ jobs:
 
   ###
   # Unit tests (OPTIONAL)
-  #
+  # 
   # https://docs.ansible.com/ansible/latest/dev_guide/testing_units.html
 
   unit:
@@ -48,19 +48,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python: ['3.9', '3.10', '3.11']
+        python: ['3.10', '3.11']
         ansible:
           - stable-2.15
           - stable-2.16
           - stable-2.17
           - devel
         exclude:
-          - ansible: stable-2.16
-            python: '3.9'
-          - ansible: stable-2.17
-            python: '3.9'
-          - ansible: devel
-            python: '3.9'
           - ansible: devel
             python: '3.10'
 
@@ -73,33 +67,29 @@ jobs:
           ansible-core-version: ${{ matrix.ansible }}
           target-python-version: ${{ matrix.python }}
 
+
   ###
   # Sanity tests (REQUIRED)
   #
   # https://docs.ansible.com/ansible/latest/dev_guide/testing_sanity.html
 
   sanity:
     name: Sanity (Ⓐ${{ matrix.ansible }} with ${{ matrix.python }} python)
+    runs-on: ubuntu-latest
     needs: [build]
     strategy:
+      fail-fast: false
       matrix:
-        python: ['3.9', '3.10', '3.11']
+        python: ['3.10', '3.11']
         ansible:
           - stable-2.15
           - stable-2.16
           - stable-2.17
           - devel
         exclude:
-          - ansible: stable-2.16
-            python: '3.9'
-          - ansible: stable-2.17
-            python: '3.9'
-          - ansible: devel
-            python: '3.9'
           - ansible: devel
             python: '3.10'
 
-    runs-on: ubuntu-latest
     steps:
       - name: Perform sanity testing
         uses: ansible-community/ansible-test-gh-action@release/v1
@@ -117,28 +107,21 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.10", "3.11"]
         ansible-version: [stable-2.15, stable-2.16, stable-2.17, devel]
         exclude:
-        # Ansible-core 2.16 is supported only from Python 3.10 onwards
-          - python-version: "3.9"
-            ansible-version: stable-2.16
-          - python-version: "3.9"
-            ansible-version: stable-2.17
-          - python-version: "3.9"
-            ansible-version: devel
           - ansible-version: devel
             python-version: '3.10'
 
     steps:
       # Important: This sets up your GITHUB_WORKSPACE environment variable
       - name: Checkout the source code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0 # needed for progressive mode to work
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v1
         with:
           python-version: ${{ matrix.python-version }}
 

CHANGELOG.rst

@@ -4,6 +4,22 @@ Dellemc.Powerscale Change Logs
 
 .. contents:: Topics
 
+
+v3.1.0
+======
+
+Minor Changes
+-------------
+
+- Added support for OneFS 9.8 Lonestar release.
+- Added support for running as root, along with other boolean flags such as allow_delete_readonly, allow_execute_always, and inheritable_path_acl in SMB module.
+
+New Modules
+-----------
+
+- dellemc.powerscale.roles - Manage auth roles on a PowerScale Storage System.
+- dellemc.powerscale.support_assist - Manage support assist settings on a PowerScale Storage System.
+
 v3.0.0
 ======
 

README.md

@@ -1,5 +1,13 @@
 # Ansible Modules for Dell Technologies PowerScale
 
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](https://github.com/dell/ansible-powerscale/blob/main/docs/CODE_OF_CONDUCT.md)
+[![License](https://img.shields.io/github/license/dell/ansible-powerscale)](https://github.com/dell/ansible-powerscale/blob/main/LICENSE)
+[![Python version](https://img.shields.io/badge/python-3.9.6+-blue.svg)](https://www.python.org/downloads/)
+[![Ansible version](https://img.shields.io/badge/ansible-2.15.6+-blue.svg)](https://pypi.org/project/ansible/)
+[![isilon-sdk](https://img.shields.io/github/v/release/dell/python-powerscale?include_prereleases&label=isilon-sdk&style=flat-square)](https://github.com/Isilon/isilon_sdk_python)
+[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/dell/ansible-powerscale?include_prereleases&label=latest&style=flat-square)](https://github.com/dell/ansible-powerscale/releases)
+[![codecov](https://codecov.io/gh/dell/ansible-powerscale/branch/main/graph/badge.svg)](https://app.codecov.io/gh/dell/ansible-powerscale)
+
 The Ansible Modules for Dell Technologies (Dell) PowerScale allow Data Center and IT administrators to use RedHat Ansible to automate and orchestrate the configuration and management of Dell PowerScale arrays.
 
 The Ansible Modules for Dell PowerScale support the following features:
@@ -36,20 +44,22 @@ The Ansible Modules for Dell PowerScale support the following features:
 - Get details and modify SMB global settings.
 - Get details and modify SNMP settings.
 - Get details, import, modify, setting default and delete server certificates.
+- Get details, create, modify, and delete auth roles.
+- Get details, and modify support assist settings.
 
 The tasks can be executed by running simple playbooks written in yaml syntax.
 
 ## Table of contents
 
-* [Code of conduct](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/CODE_OF_CONDUCT.md)
-* [Maintainer guide](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/MAINTAINER_GUIDE.md)
-* [Committer guide](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/COMMITTER_GUIDE.md)
-* [Contributing guide](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/CONTRIBUTING.md)
-* [Branching strategy](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/BRANCHING.md)
-* [List of adopters](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/ADOPTERS.md)
-* [Maintainers](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/MAINTAINERS.md)
-* [Support](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/SUPPORT.md)
-* [Security](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/SECURITY.md)
+* [Code of conduct](https://github.com/dell/ansible-powerscale/blob/main/docs/CODE_OF_CONDUCT.md)
+* [Maintainer guide](https://github.com/dell/ansible-powerscale/blob/main/docs/MAINTAINER_GUIDE.md)
+* [Committer guide](https://github.com/dell/ansible-powerscale/blob/main/docs/COMMITTER_GUIDE.md)
+* [Contributing guide](https://github.com/dell/ansible-powerscale/blob/main/docs/CONTRIBUTING.md)
+* [Branching strategy](https://github.com/dell/ansible-powerscale/blob/main/docs/BRANCHING.md)
+* [List of adopters](https://github.com/dell/ansible-powerscale/blob/main/docs/ADOPTERS.md)
+* [Maintainers](https://github.com/dell/ansible-powerscale/blob/main/docs/MAINTAINERS.md)
+* [Support](https://github.com/dell/ansible-powerscale/blob/main/docs/SUPPORT.md)
+* [Security](https://github.com/dell/ansible-powerscale/blob/main/docs/SECURITY.md)
 * [License](#license)
 * [Supported platforms](#supported-platforms)
 * [Prerequisites](#prerequisites)
@@ -58,62 +68,64 @@ The tasks can be executed by running simple playbooks written in yaml syntax.
 * [Maintanence](#maintanence)
 
 ## License
-Ansible collection for PowerScale is released and licensed under the GPL-3.0 license. See [LICENSE](https://github.com/dell/ansible-powerscale/blob/3.0.0/LICENSE) for the full terms. Ansible modules and modules utilities that are part of the Ansible collection for PowerScale are released and licensed under the Apache 2.0 license. See [MODULE-LICENSE](https://github.com/dell/ansible-powerscale/blob/3.0.0/MODULE-LICENSE) for the full terms.
+Ansible collection for PowerScale is released and licensed under the GPL-3.0 license. See [LICENSE](https://github.com/dell/ansible-powerscale/blob/main/LICENSE) for the full terms. Ansible modules and modules utilities that are part of the Ansible collection for PowerScale are released and licensed under the Apache 2.0 license. See [MODULE-LICENSE](https://github.com/dell/ansible-powerscale/blob/main/MODULE-LICENSE) for the full terms.
 
 ## Supported platforms
-  * Dell PowerScale OneFS versions 9.3.x, 9.4.x and 9.5.x
+  * Dell PowerScale OneFS versions 9.3.x, 9.4.x, 9.5.x, and 9.8.x
 
 ## Prerequisites
 This table provides information about the software prerequisites for the Ansible Modules for Dell PowerScale.
 
 | **Ansible Modules** | **OneFS Version** | **Python version** | **Python SDK version** | **Ansible**              |
 |---------------------|-----------------------|--------------------|----------------------------|--------------------------|
-| v3.0.0 | 9.4.x <br> 9.5.x <br> 9.7.x | 3.9 <br> 3.10 <br> 3.11 | 0.3.0.1 | 2.14 <br> 2.15 <br> 2.16 |
+| v3.1.0 | 9.4.x <br> 9.5.x <br> 9.7.x <br> 9.8.x | 3.9 <br> 3.10 <br> 3.11 <br> 3.12 | 0.3.0.1 | 2.14 <br> 2.15 <br> 2.16 <br> 2.17 |
 
 # List of Ansible modules for Dell PowerScale
-  * [File System Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/filesystem.rst)
-  * [Access Zone Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/accesszone.rst)
-  * [User Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/user.rst)
-  * [Group Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/group.rst)
-  * [Snapshot Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/snapshot.rst)
-  * [Snapshot Schedule Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/snapshotschedule.rst)
-  * [NFS Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/nfs.rst)
-  * [SMB Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/smb.rst)
-  * [Smart Quota Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/smartquota.rst)
-  * [Info Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/info.rst)
-  * [Active Directory Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/ads.rst)
-  * [LDAP Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/ldap.rst)
-  * [Node Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/node.rst)
-  * [SyncIQ Policy Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/synciqpolicy.rst)
-  * [SyncIQ Jobs Module](https://github.com/dell/ansible-powerscale/tree/3.0.0/docs/modules/synciqjob.rst)
-  * [SyncIQ Performance Rules Module](https://github.com/dell/ansible-powerscale/tree/3.0.0/docs/modules/synciqrules.rst)
-  * [SyncIQ Reports Module](https://github.com/dell/ansible-powerscale/tree/3.0.0/docs/modules/synciqreports.rst)
-  * [SyncIQ Target Reports Module](https://github.com/dell/ansible-powerscale/tree/3.0.0/docs/modules/synciqtargetreports.rst)
-  * [Groupnet Module](https://github.com/dell/ansible-powerscale/tree/3.0.0/docs/modules/groupnet.rst)
-  * [Subnet Module](https://github.com/dell/ansible-powerscale/tree/3.0.0/docs/modules/subnet.rst)
-  * [Network Pool Module](https://github.com/dell/ansible-powerscale/tree/3.0.0/docs/modules/networkpool.rst)
-  * [Network Rule Module](https://github.com/dell/ansible-powerscale/tree/3.0.0/docs/modules/networkrule.rst)
-  * [NFS Alias Module](https://github.com/dell/ansible-powerscale/tree/3.0.0/docs/modules/nfs_alias.rst)
-  * [Settings Module](https://github.com/dell/ansible-powerscale/tree/3.0.0/docs/modules/settings.rst)
-  * [Network Setting Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/networksettings.rst)
-  * [Smart Pool Setting Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/smartpoolsettings.rst)
-  * [Filepool Policy Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/filepoolpolicy.rst)
-  * [Storagepool Tier Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/storagepooltier.rst)
-  * [SMB File Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/smb_file.rst)
-  * [User Mapping Rule Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/user_mapping_rule.rst)
-  * [S3 Bucket Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/s3_bucket.rst)
-  * [NFS Default Settings Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/nfs_default_settings.rst)
-  * [NFS Global Settings Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/nfs_global_settings.rst)
-  * [NFS Zone Settings Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/nfs_zone_settings.rst)
-  * [SyncIQ Global Settings Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/synciq_global_settings.rst)
-  * [SyncIQ Certificate Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/synciqcertificate.rst)
-  * [SMB Global Settings Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/smb_global_settings.rst)
-  * [SNMP Settings Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/snmp_settings.rst)
-  * [Server Certificate Module](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/modules/server_certificate.rst)
+  * [File System Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/filesystem.rst)
+  * [Access Zone Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/accesszone.rst)
+  * [User Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/user.rst)
+  * [Group Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/group.rst)
+  * [Snapshot Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/snapshot.rst)
+  * [Snapshot Schedule Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/snapshotschedule.rst)
+  * [NFS Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/nfs.rst)
+  * [SMB Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/smb.rst)
+  * [Smart Quota Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/smartquota.rst)
+  * [Info Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/info.rst)
+  * [Active Directory Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/ads.rst)
+  * [LDAP Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/ldap.rst)
+  * [Node Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/node.rst)
+  * [SyncIQ Policy Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/synciqpolicy.rst)
+  * [SyncIQ Jobs Module](https://github.com/dell/ansible-powerscale/tree/main/docs/modules/synciqjob.rst)
+  * [SyncIQ Performance Rules Module](https://github.com/dell/ansible-powerscale/tree/main/docs/modules/synciqrules.rst)
+  * [SyncIQ Reports Module](https://github.com/dell/ansible-powerscale/tree/main/docs/modules/synciqreports.rst)
+  * [SyncIQ Target Reports Module](https://github.com/dell/ansible-powerscale/tree/main/docs/modules/synciqtargetreports.rst)
+  * [Groupnet Module](https://github.com/dell/ansible-powerscale/tree/main/docs/modules/groupnet.rst)
+  * [Subnet Module](https://github.com/dell/ansible-powerscale/tree/main/docs/modules/subnet.rst)
+  * [Network Pool Module](https://github.com/dell/ansible-powerscale/tree/main/docs/modules/networkpool.rst)
+  * [Network Rule Module](https://github.com/dell/ansible-powerscale/tree/main/docs/modules/networkrule.rst)
+  * [NFS Alias Module](https://github.com/dell/ansible-powerscale/tree/main/docs/modules/nfs_alias.rst)
+  * [Settings Module](https://github.com/dell/ansible-powerscale/tree/main/docs/modules/settings.rst)
+  * [Network Setting Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/networksettings.rst)
+  * [Smart Pool Setting Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/smartpoolsettings.rst)
+  * [Filepool Policy Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/filepoolpolicy.rst)
+  * [Storagepool Tier Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/storagepooltier.rst)
+  * [SMB File Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/smb_file.rst)
+  * [User Mapping Rule Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/user_mapping_rule.rst)
+  * [S3 Bucket Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/s3_bucket.rst)
+  * [NFS Default Settings Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/nfs_default_settings.rst)
+  * [NFS Global Settings Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/nfs_global_settings.rst)
+  * [NFS Zone Settings Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/nfs_zone_settings.rst)
+  * [SyncIQ Global Settings Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/synciq_global_settings.rst)
+  * [SyncIQ Certificate Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/synciqcertificate.rst)
+  * [SMB Global Settings Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/smb_global_settings.rst)
+  * [SNMP Settings Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/snmp_settings.rst)
+  * [Server Certificate Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/server_certificate.rst)
+  * [Roles](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/roles.rst)
+  * [Support Assist](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/support_assist.rst)
 
 
 ## Installation and execution of Ansible modules for Dell PowerScale
-The installation and execution steps of Ansible modules for Dell PowerScale can be found [here](https://github.com/dell/ansible-powerscale/blob/3.0.0/docs/INSTALLATION.md).
+The installation and execution steps of Ansible modules for Dell PowerScale can be found [here](https://github.com/dell/ansible-powerscale/blob/main/docs/INSTALLATION.md).
 
 ## Maintenance
 Ansible Modules for Dell Technologies PowerScale deprecation cycle is aligned with [Ansible](https://docs.ansible.com/ansible/latest/dev_guide/module_lifecycle.html).

changelogs/changelog.yaml

@@ -269,3 +269,18 @@ releases:
       minor_changes:
         - Added support for OneFS 9.7 Key West release.
     release_date: '2024-03-29'
+  3.1.0:
+    changes:
+      minor_changes:
+        - Added support for running as root, along with other boolean flags such
+          as allow_delete_readonly, allow_execute_always, and inheritable_path_acl
+          in SMB module.
+        - Added support for OneFS 9.8 Lonestar release.
+    modules:
+      - description: Manage auth roles on a PowerScale Storage System.
+        name: roles
+        namespace: ''
+      - description: Manage support assist settings on a PowerScale Storage System.
+        name: support_assist
+        namespace: ''
+    release_date: '2024-06-28'