Merge pull request #110 from dell/docs-update

Documentation update 3.3.0

CHANGELOG.rst

@@ -5,6 +5,22 @@ Dellemc.Powerscale Change Logs
 .. contents:: Topics
 
 
+v3.3.0
+======
+
+Minor Changes
+-------------
+
+- Added support for listing writable snapshots in Info module.
+- Added fix for firewall policy issue for network pool operations.
+
+New Modules
+-----------
+
+- dellemc.powerscale.alert_channel - Manage alert channel on a PowerScale Storage System.
+- dellemc.powerscale.alert_rule - Manage alert rule on a PowerScale Storage System.
+- dellemc.powerscale.writable_snapshots - Manage writable snapshots on PowerScale Storage System.
+
 v3.2.0
 ======
 

README.md

@@ -81,7 +81,7 @@ This table provides information about the software prerequisites for the Ansible
 
 | **Ansible Modules** | **OneFS Version** | **Python version** | **Python SDK version** | **Ansible**              |
 |---------------------|-----------------------|--------------------|----------------------------|--------------------------|
-| v3.2.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.15 <br> 2.16 <br> 2.17 |
+| v3.3.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.15 <br> 2.16 <br> 2.17 |
 
 # List of Ansible modules for Dell PowerScale
   * [File System Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/filesystem.rst)

changelogs/changelog.yaml

@@ -296,3 +296,19 @@ releases:
         name: alert_settings
         namespace: ''
     release_date: '2024-07-31'
+  3.3.0:
+    changes:
+      minor_changes:
+        - Added support for listing writable snapshots in Info module.
+        - Added fix for firewall policy issue for network pool operations.
+    modules:
+      - description: Manage alert channel on a PowerScale Storage System.
+        name: alert_channel
+        namespace: ''
+      - description: Manage alert rule on a PowerScale Storage System.
+        name: alert_rule
+        namespace: ''
+      - description: Manage writable snapshots on PowerScale Storage System.
+        name: writable_snapshots
+        namespace: ''
+    release_date: '2024-08-30'

docs/INSTALLATION.md

@@ -22,7 +22,7 @@ Use this procedure to install SDK:
   #### Offline installation of collections
   1. Download the latest tar build from either of the available distribution channels [Ansible Galaxy](https://galaxy.ansible.com/dellemc/powerscale) /[Automation Hub](https://console.redhat.com/ansible/automation-hub/repo/published/dellemc/powerscale) and use this command to install the collection anywhere in your system:
 
-	      ansible-galaxy collection install dellemc-powerscale-3.2.0.tar.gz -p <install_path>
+	      ansible-galaxy collection install dellemc-powerscale-3.3.0.tar.gz -p <install_path>
 
   2. Set the environment variable:
 

docs/ISSUE_TRIAGE.md

@@ -33,7 +33,7 @@ Should explain what happened, what was expected and how to reproduce it together
 
  - Ansible Version: [e.g. 2.15]
  - Python Version [e.g. 3.11]
- - Ansible modules for Dell PowerScale Version: [e.g. 3.2.0]
+ - Ansible modules for Dell PowerScale Version: [e.g. 3.3.0]
  - PowerScale SDK version: [e.g. 0.3.0.1]
  - Any other additional information...
 

docs/Release Notes.md

@@ -1,6 +1,6 @@
 **Ansible Modules for Dell Technologies PowerScale** 
 =========================================
-### Release notes 3.2.0
+### Release notes 3.3.0
 
 >   © 2024 Dell Inc. or its subsidiaries. All rights reserved. Dell
 >   and other trademarks are trademarks of Dell Inc. or its
@@ -27,7 +27,7 @@ Table 1. Revision history
 
 | Revision | Date          | Description                                               |
 |----------|---------------|-----------------------------------------------------------|
-| 01       | July 2024     | Ansible Modules for Dell PowerScale 3.2.0                 |
+| 01       | August 2024   | Ansible Modules for Dell PowerScale 3.3.0                 |
 
 
 Product description
@@ -70,19 +70,22 @@ The Ansible Modules for Dell PowerScale support the following features:
 - Get details, accept terms, and modify support assist settings.
 - Get details and modify alert settings.
 - Get details of filesystems, NFS exports, alert_settings, alert_rules, alert_categories, event_groups and alert_channels using Info module.
+- Get details, create, modify, and delete Alert Channel.
+- Get details, create, modify, and delete Alert Rule.
+- Get details, create, and delete Writable Snapshots.
 
 The Ansible modules use playbooks, written in yaml syntax, to list, show, create, delete, and modify each of these entities.
 
 New Features and Enhancements
 ---------------------------
 This section describes the features of the Ansible Modules for Dell PowerScale for this release.
 
-The Ansible Modules for Dell PowerScale release 3.2.0 supports the following features:
+The Ansible Modules for Dell PowerScale release 3.3.0 supports the following features:
 
-- Added support for check mode and diff mode in network pool module.
-- Added support for check mode in Filesystem, NFS and Smart Quota modules.
-- Added support for listing filesystems, NFS exports, alert_settings, alert_rules, alert_categories, event_groups and alert_channels in Info module
-- Added support for query paramters and filters in Info module.
+- Added support for create, modify, and delete Alert Channel.
+- Added support for create, modify, and delete Alert Rule.
+- Added support for create, and delete Writable Snapshots.
+- Added support for listing Writable Snapshots in Info module
 
 Known issues
 ------------

docs/modules/alert_channel.rst

@@ -40,7 +40,7 @@ Parameters
 
     \ :literal:`False`\  indicates the channel is disabled.
 
-    If not specified when creating the channel, It will be enabled by default.
+    If not specified when creating the channel, it will be enabled by default.
 
 
   excluded_nodes (optional, list, None)
@@ -50,7 +50,7 @@ Parameters
   name (True, str, None)
     Name of the Channel.
 
-    Name should be unique and not modifiable.
+    Name should be unique and cannot be changed.
 
 
   send_test_alert (optional, bool, False)
@@ -94,7 +94,7 @@ Parameters
     smtp_use_auth (optional, bool, None)
       Enable SMTP authentication.
 
-      If \ :emphasis:`smtp\_use\_auth`\  is not set during creation, then It defaults set to c(false).
+      If \ :emphasis:`smtp\_use\_auth`\  is not set during creation, then it defaults set to \ :literal:`false`\ .
 
 
     smtp_username (optional, str, None)
@@ -129,7 +129,7 @@ Parameters
 
     If \ :emphasis:`type`\  is \ :literal:`smtp`\ , then \ :emphasis:`smtp\_parameters`\  is required.
 
-    If \ :emphasis:`type`\  is not set during creation, then It defaults to \ :literal:`connectemc`\ .
+    If \ :emphasis:`type`\  is not set during creation, then it defaults to \ :literal:`connectemc`\ .
 
 
   onefs_host (True, str, None)

galaxy.yml

@@ -14,7 +14,7 @@ name: powerscale
 
 # The version of the collection.
 # Must be compatible with semantic versioning
-version: 3.2.0
+version: 3.3.0
 
 # The path to the Markdown (.md) readme file.
 # This path is relative to the root of the collection.

plugins/modules/alert_channel.py

@@ -36,7 +36,7 @@
     - Enable or disable the channel.
     - C(True) indicates the channel is enabled.
     - C(False) indicates the channel is disabled.
-    - If not specified when creating the channel, It will be
+    - If not specified when creating the channel, it will be
       enabled by default.
     type: bool
   excluded_nodes:
@@ -47,7 +47,7 @@
   name:
     description:
     - Name of the Channel.
-    - Name should be unique and not modifiable.
+    - Name should be unique and cannot be changed.
     type: str
     required: true
   send_test_alert:
@@ -99,7 +99,7 @@
         description:
         - Enable SMTP authentication.
         - If I(smtp_use_auth) is not set during creation,
-          then It defaults set to c(false).
+          then it defaults set to C(false).
         type: bool
       smtp_username:
         description:
@@ -137,7 +137,7 @@
     description:
     - Type of the channel.
     - If I(type) is C(smtp), then I(smtp_parameters) is required.
-    - If I(type) is not set during creation, then It defaults to C(connectemc).
+    - If I(type) is not set during creation, then it defaults to C(connectemc).
     type: str
     choices: ['connectemc', 'smtp']
 attributes:

tests/config.yml

@@ -0,0 +1,2 @@
+modules:
+  python_requires: '>=3.9'