Skip to content

Commit

Permalink
Merge pull request #42 from Bhavneet-Sharma/Feature-doc-update
Browse files Browse the repository at this point in the history
Documents Update for Release 3.1.0
  • Loading branch information
Bhavneet-Sharma authored Jan 25, 2024
2 parents 36b4447 + 81b6763 commit 55091ee
Show file tree
Hide file tree
Showing 128 changed files with 2,217 additions and 676 deletions.
20 changes: 20 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,26 @@ Dellemc.Powerstore Change Logs

.. contents:: Topics

v3.1.0
======

Minor Changes
-------------

- Added support for creating multiple NFS exports with same name
but different NAS servers
- Info module is enhanced to list file interfaces, file DNS,
file NIS, SMB servers and NFS servers.

New Modules
-----------

- dellemc.powerstore.file_interface - Manage file interfaces for PowerStore
- dellemc.powerstore.file_dns - Manage file DNS for PowerStore
- dellemc.powerstore.file_nis - Manage file NIS for PowerStore
- dellemc.powerstore.smb_server - Manage SMB server for PowerStore
- dellemc.powerstore.nfs_server - Manage NFS server for PowerStore
- dellemc.powerstore.service_config - Manage service config for PowerStore

v3.0.0
======
Expand Down
100 changes: 53 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
# Ansible Modules for Dell Technologies PowerStore
The Ansible Modules for Dell Technologies (Dell) PowerStore allow Data Center and IT administrators to use RedHat Ansible to automate and orchestrate the configuration and management of Dell PowerStore arrays.

The capabilities of the Ansible modules are managing volumes, volume groups, vCenters, hosts, host groups, snapshots, snapshot rules, replication rules, replication sessions, protection policies, file systems, NAS servers, SMB shares, user and tree quotas, file system snapshots, NFS exports, Clusters, Networks, Local users, Jobs, Roles, Certificates, Remote systems, security configuration, DNS server, Email notification destination, NTP server, Remote support configuration, Remote support contacts, SMTP configuration, LDAP accounts, LDAP domain configuration and storage containers. It also allows gathering high level info from the array. The options available for each are list, show, create, modify and delete. These tasks can be executed by running simple playbooks written in yaml syntax. The modules are written so that all the operations are idempotent, so making multiple identical requests has the same effect as making a single request.
The capabilities of the Ansible modules are managing volumes, volume groups, vCenters, hosts, host groups, snapshots, snapshot rules, replication rules, replication sessions, protection policies, file systems, NAS servers, SMB shares, user and tree quotas, file system snapshots, NFS exports, Clusters, Networks, Local users, Jobs, Roles, Certificates, Remote systems, security configuration, DNS server, Email notification destination, NTP server, Remote support configuration, Remote support contacts, SMTP configuration, LDAP accounts, LDAP domain configuration, storage containers, File DNS, File interface, File NIS, NFS server, SMB Server and service config. It also allows gathering high level info from the array. The options available for each are list, show, create, modify and delete. These tasks can be executed by running simple playbooks written in yaml syntax. The modules are written so that all the operations are idempotent, so making multiple identical requests has the same effect as making a single request.
## Table of contents

* [Code of conduct](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/CODE_OF_CONDUCT.md)
* [Maintainer guide](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/MAINTAINER_GUIDE.md)
* [Committer guide](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/COMMITTER_GUIDE.md)
* [Contributing guide](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/CONTRIBUTING.md)
* [Branching strategy](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/BRANCHING.md)
* [List of adopters](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/ADOPTERS.md)
* [Maintainers](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/MAINTAINERS.md)
* [Support](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/SUPPORT.md)
* [Code of conduct](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/CODE_OF_CONDUCT.md)
* [Maintainer guide](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/MAINTAINER_GUIDE.md)
* [Committer guide](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/COMMITTER_GUIDE.md)
* [Contributing guide](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/CONTRIBUTING.md)
* [Branching strategy](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/BRANCHING.md)
* [List of adopters](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/ADOPTERS.md)
* [Maintainers](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/MAINTAINERS.md)
* [Support](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/SUPPORT.md)
* [License](#license)
* [Security](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/SECURITY.md)
* [Security](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/SECURITY.md)
* [Prerequisites](#prerequisites)
* [List of Ansible modules for Dell PowerStore](#list-of-ansible-modules-for-dell-powerstore)
* [Installation and execution of Ansible modules for Dell PowerStore](#installation-and-execution-of-ansible-modules-for-dell-powerstore)
* [Maintenance](#maintenance)

## License
The Ansible collection for PowerStore is released and licensed under the GPL-3.0 license. See [LICENSE](https://github.com/dell/ansible-powerstore/blob/3.0.0/LICENSE) for the full terms. Ansible modules and modules utilities that are part of the Ansible collection for PowerStore are released and licensed under the Apache 2.0 license. See [MODULE-LICENSE](https://github.com/dell/ansible-powerstore/blob/3.0.0/MODULE-LICENSE) for the full terms.
The Ansible collection for PowerStore is released and licensed under the GPL-3.0 license. See [LICENSE](https://github.com/dell/ansible-powerstore/blob/3.1.0/LICENSE) for the full terms. Ansible modules and modules utilities that are part of the Ansible collection for PowerStore are released and licensed under the Apache 2.0 license. See [MODULE-LICENSE](https://github.com/dell/ansible-powerstore/blob/3.1.0/MODULE-LICENSE) for the full terms.

## Prerequisites

| **Ansible Modules** | **PowerStore Version** | **SDK version** | **Python version** | **Ansible** |
|---------------------|-----------------------|-----------------|--------------------|--------------------------|
| v3.0.0 | 3.2.x <br> 3.5.x <br> 3.6.x | 2.0.0 | 3.9.x <br> 3.10.x <br> 3.11.x | 2.14 <br> 2.15 <br> 2.16 |
| v3.1.0 | 2.9.x <br> 3.2.x <br> 3.5.x <br> 3.6.x | 2.0.0 | 3.6.x <br> 3.9.x <br> 3.10.x <br> 3.11.x | 2.14 <br> 2.15 <br> 2.16 |


* Please follow PyPowerStore installation instructions on [PyPowerStore Documentation](https://github.com/dell/python-powerstore)
Expand All @@ -35,43 +35,49 @@ The Ansible collection for PowerStore is released and licensed under the GPL-3.0
The modules are written in such a way that all requests are idempotent and hence fault-tolerant. It essentially means that the result of a successfully performed request is independent of the number of times it is executed.

## List of Ansible Modules for Dell PowerStore
* [Volume module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/volume.rst)
* [Volume group module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/volumegroup.rst)
* [Host module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/host.rst)
* [Host group module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/hostgroup.rst)
* [Snapshot module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/snapshot.rst)
* [Snapshot rule module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/snapshotrule.rst)
* [Replication rule module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/replicationrule.rst)
* [Replication session module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/replicationsession.rst)
* [Protection policy module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/protectionpolicy.rst)
* [Info module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/info.rst)
* [File system module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/filesystem.rst)
* [NAS server module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/nasserver.rst)
* [SMB share module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/smbshare.rst)
* [Quota module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/quota.rst)
* [File system snapshot module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/filesystem_snapshot.rst)
* [NFS export module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/nfs.rst)
* [Cluster module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/cluster.rst)
* [Network module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/network.rst)
* [Local user module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/local_user.rst)
* [Role module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/role.rst)
* [Job module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/job.rst)
* [Certificate module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/certificate.rst)
* [Remote system module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/remotesystem.rst)
* [Security config module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/security_config.rst)
* [DNS module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/dns.rst)
* [Email module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/email.rst)
* [NTP module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/ntp.rst)
* [Remote support module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/remote_support.rst)
* [Remote support contact module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/remote_support_contact.rst)
* [SMTP config module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/smtp_config.rst)
* [LDAP Account module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/ldap_account.rst)
* [LDAP Domain module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/ldap_domain.rst)
* [vCenter module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/vcenter.rst)
* [Storage container module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/storage_container.rst)
* [Volume module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/volume.rst)
* [Volume group module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/volumegroup.rst)
* [Host module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/host.rst)
* [Host group module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/hostgroup.rst)
* [Snapshot module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/snapshot.rst)
* [Snapshot rule module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/snapshotrule.rst)
* [Replication rule module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/replicationrule.rst)
* [Replication session module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/replicationsession.rst)
* [Protection policy module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/protectionpolicy.rst)
* [Info module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/info.rst)
* [File system module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/filesystem.rst)
* [NAS server module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/nasserver.rst)
* [SMB share module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/smbshare.rst)
* [Quota module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/quota.rst)
* [File system snapshot module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/filesystem_snapshot.rst)
* [NFS export module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/nfs.rst)
* [Cluster module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/cluster.rst)
* [Network module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/network.rst)
* [Local user module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/local_user.rst)
* [Role module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/role.rst)
* [Job module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/job.rst)
* [Certificate module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/certificate.rst)
* [Remote system module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/remotesystem.rst)
* [Security config module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/security_config.rst)
* [DNS module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/dns.rst)
* [Email module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/email.rst)
* [NTP module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/ntp.rst)
* [Remote support module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/remote_support.rst)
* [Remote support contact module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/remote_support_contact.rst)
* [SMTP config module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/smtp_config.rst)
* [LDAP Account module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/ldap_account.rst)
* [LDAP Domain module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/ldap_domain.rst)
* [vCenter module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/vcenter.rst)
* [Storage container module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/storage_container.rst)
* [File interface module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/file_interface.rst)
* [File DNS module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/file_dns.rst)
* [File NIS module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/file_nis.rst)
* [SMB server module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/smb_server.rst)
* [NFS server module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/nfs_server.rst)
* [Service config module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/service_config.rst)

## Installation and execution of Ansible modules for Dell PowerStore
The installation and execution steps of Ansible modules for Dell PowerStore can be found [here](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/INSTALLATION.md)
The installation and execution steps of Ansible modules for Dell PowerStore can be found [here](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/INSTALLATION.md)

## Maintenance
Ansible Modules for Dell Technologies PowerStore deprecation cycle is aligned with [Ansible](https://docs.ansible.com/ansible/latest/dev_guide/module_lifecycle.html).
27 changes: 27 additions & 0 deletions changelogs/changelog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -216,3 +216,30 @@ releases:
minor_changes:
- Added support for PowerStore 3.6.x.x.
release_date: '2023-11-30'
3.1.0:
changes:
minor_changes:
- Added support for creating multiple NFS exports with same name
but different NAS servers
- Info module is enhanced to list file interfaces, file DNS,
file NIS, SMB servers and NFS servers.
modules:
- description: Manage file interfaces on Dell PowerStore
name: file_interface
namespace: ''
- description: Manage file DNS on Dell PowerStore
name: file_dns
namespace: ''
- description: Manage file NIS on Dell PowerStore
name: file_nis
namespace: ''
- description: Manage SMB servers on Dell PowerStore
name: smb_server
namespace: ''
- description: Manage NFS servers on Dell PowerStore
name: nfs_server
namespace: ''
- description: Manage service configurations on Dell PowerStore
name: service_config
namespace: ''
release_date: '2024-01-31'
8 changes: 4 additions & 4 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You may obtain a copy of the License at

# How to contribute

Become one of the contributors to this project! We thrive to build a welcoming and open community for anyone who wants to use the project or contribute to it. There are just a few small guidelines you need to follow. To help us create a safe and positive community experience for all, we require all participants to adhere to the [Code of Conduct](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/CODE_OF_CONDUCT.md).
Become one of the contributors to this project! We thrive to build a welcoming and open community for anyone who wants to use the project or contribute to it. There are just a few small guidelines you need to follow. To help us create a safe and positive community experience for all, we require all participants to adhere to the [Code of Conduct](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/CODE_OF_CONDUCT.md).

## Table of contents

Expand Down Expand Up @@ -76,7 +76,7 @@ Triage helps ensure that issues resolve quickly by:

If you don't have the knowledge or time to code, consider helping with _issue triage_. The Ansible modules for Dell PowerStore community will thank you for saving them time by spending some of yours.

Read more about the ways you can [Triage issues](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/ISSUE_TRIAGE.md).
Read more about the ways you can [Triage issues](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/ISSUE_TRIAGE.md).

## Your first contribution

Expand All @@ -89,7 +89,7 @@ When you're ready to contribute, it's time to create a pull request.

## Branching

* [Branching Strategy for Ansible modules for Dell PowerStore](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/BRANCHING.md)
* [Branching Strategy for Ansible modules for Dell PowerStore](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/BRANCHING.md)

## Signing your commits

Expand Down Expand Up @@ -144,7 +144,7 @@ Make sure that the title for your pull request uses the same format as the subje

### Quality gates for pull requests

GitHub Actions are used to enforce quality gates when a pull request is created or when any commit is made to the pull request. These GitHub Actions enforce our minimum code quality requirement for any code that get checked into the repository. If any of the quality gates fail, it is expected that the contributor will look into the check log, understand the problem and resolve the issue. If help is needed, please feel free to reach out the maintainers of the project for [support](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/SUPPORT.md).
GitHub Actions are used to enforce quality gates when a pull request is created or when any commit is made to the pull request. These GitHub Actions enforce our minimum code quality requirement for any code that get checked into the repository. If any of the quality gates fail, it is expected that the contributor will look into the check log, understand the problem and resolve the issue. If help is needed, please feel free to reach out the maintainers of the project for [support](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/SUPPORT.md).

#### Code sanitization

Expand Down
Loading

0 comments on commit 55091ee

Please sign in to comment.