Updating docs for v1.5 release (#216)

* Updating Readme * Adding link to resources and datasources in readme * Rectifying synciq policy datasource docs * Adding cannot-be-updated tags to resource fields * Updating example Readme
dell · Sep 26, 2024 · 6127286 · 6127286
1 parent c02fcc9
commit 6127286
Show file tree

Hide file tree

Showing 78 changed files with 804 additions and 664 deletions.
diff --git a/README.md b/README.md
@@ -21,12 +21,13 @@ limitations under the License.
 
 The Terraform Provider for Dell Technologies (Dell) PowerScale allows Data Center and IT administrators to use Hashicorp Terraform to automate and orchestrate the provisioning and management of Dell PowerScale storage systems.
 
-The Terraform Provider can be used to manage access zone, active directory, cluster, user, user group, file system, smb share, nfs export, snapshot, snapshot schedule, quota, groupnet, subnet, network pool, network settings, smart pool settings, ldap providers, network rule, file pool policy, ntp server, ntp settings, cluster email settings, acl settings, nfs export settings, role, user mapping rules, role privilege, s3 bucket, nfs global settings, nfs zone settings, smb share settings, smb server settings, namespace acl.
+The Terraform Provider can be used to manage access zone, active directory, cluster, user, user group, file system, smb share, nfs export, snapshot, snapshot schedule, quota, groupnet, subnet, network pool, network settings, smart pool settings, ldap providers, network rule, file pool policy, ntp server, ntp settings, cluster email settings, acl settings, nfs export settings, role, user mapping rules, role privilege, s3 bucket, nfs global settings, nfs zone settings, smb share settings, smb server settings, namespace acl, cluster identity, cluster snmp, cluster owner, cluster time, support assist, s3 keys, s3 zone settings, s3 global settings, synciq policies, synciq rules, synciq global settings, synciq peer certificates.
 
 The logged-in user configured in the Terraform provider must possess adequate permissions against the target Dell PowerScale System.
 
 ## Table of Contents
 
+* [PowerScale Provider Documentation](docs/)
 * [Code of Conduct](https://github.com/dell/dell-terraform-providers/blob/main/docs/CODE_OF_CONDUCT.md)
 * [Maintainer Guide](https://github.com/dell/dell-terraform-providers/blob/main/docs/MAINTAINER_GUIDE.md)
 * [Committer Guide](https://github.com/dell/dell-terraform-providers/blob/main/docs/COMMITTER_GUIDE.md)
@@ -51,75 +52,90 @@ The Terraform Provider for Dell PowerScale is released and licensed under the MP
 
 | **Terraform Provider** | **PowerScale Version** | **OS**                    | **Terraform**               | **Golang** |
 |------------------------|:-----------------------|:--------------------------|-----------------------------|------------|
-| v1.4.0                 | 9.5 <br> 9.7 <br> 9.8  | ubuntu22.04 <br>  rhel9.x |    1.7.x <br> 1.8.x         | 1.22       |
+| v1.5.0                 | 9.5 <br> 9.7 <br> 9.8  | ubuntu22.04 <br>  rhel9.x |    1.8.x <br> 1.9.x         | 1.22       |
 
 ## List of DataSources in Terraform Provider for Dell PowerScale
-* Cluster
-* Access Zone
-* ACL Settings
-* Active Directory
-* Cluster Email Settings
-* File Pool Policy
-* File System
-* Groupnet
-* LDAP Provider
-* Namespace ACL
-* Network Pool
-* Network Rule
-* Network Settings
-* NFS Export
-* NFS Export Settings
-* NFS Global Settings
-* NFS Zone Settings
-* NTP Server
-* NTP Settings
-* Quota
-* Role
-* Role Privilege
-* S3 Bucket
-* Smart Pool Settings
-* SMB Server Settings
-* SMB Share
-* SMB Share Settings
-* Snapshot
-* Snapshot Schedule
-* Subnet
-* User
-* User Group
-* User Mapping Rules
+* [Cluster](docs/data-sources/cluster.md)
+* [Access Zone](docs/data-sources/accesszone.md)
+* [ACL Settings](docs/data-sources/aclsettings.md)
+* [Active Directory Service Provider](docs/data-sources/adsprovider.md)
+* [Cluster Email Settings](docs/data-sources/cluster_email.md)
+* [File Pool Policy](docs/data-sources/filepool_policy.md)
+* [File System](docs/data-sources/filesystem.md)
+* [Groupnet](docs/data-sources/groupnet.md)
+* [LDAP Provider](docs/data-sources/ldap_provider.md)
+* [Namespace ACL](docs/data-sources/namespace_acl.md)
+* [Network Pool](docs/data-sources/networkpool.md)
+* [Network Rule](docs/data-sources/network_rule.md)
+* [Network Settings](docs/data-sources/network_settings.md)
+* [NFS Export](docs/data-sources/nfs_export.md)
+* [NFS Export Settings](docs/data-sources/nfs_export_settings.md)
+* [NFS Global Settings](docs/data-sources/nfs_global_settings.md)
+* [NFS Zone Settings](docs/data-sources/nfs_zone_settings.md)
+* [NTP Server](docs/data-sources/ntpserver.md)
+* [NTP Settings](docs/data-sources/ntpsettings.md)
+* [Quota](docs/data-sources/quota.md)
+* [Role](docs/data-sources/role.md)
+* [Role Privilege](docs/data-sources/roleprivilege.md)
+* [S3 Bucket](docs/data-sources/s3_bucket.md)
+* [Smart Pool Settings](docs/data-sources/smartpool_settings.md)
+* [SMB Server Settings](docs/data-sources/smb_server_settings.md)
+* [SMB Share](docs/data-sources/smb_share.md)
+* [SMB Share Settings](docs/data-sources/smb_share_settings.md)
+* [Snapshot](docs/data-sources/snapshot.md)
+* [Snapshot Schedule](docs/data-sources/snapshot_schedule.md)
+* [Subnet](docs/data-sources/subnet.md)
+* [User](docs/data-sources/user.md)
+* [User Group](docs/data-sources/user_group.md)
+* [User Mapping Rules](docs/data-sources/user_mapping_rules.md)
+* [SyncIQ Policy](docs/data-sources/synciq_policy.md)
+* [SyncIQ Global Settings](docs/data-sources/synciq_global_settings.md)
+* [SyncIQ Rule](docs/data-sources/synciq_rule.md)
+* [SyncIQ Peer Certificate](docs/data-sources/synciq_peer_certificate.md)
 
 ## List of Resources in Terraform Provider for Dell PowerScale
-* Access Zone
-* ACL Settings
-* Active Directory
-* Cluster Email Settings
-* File Pool Policy
-* File System
-* Groupnet
-* LDAP Provider
-* Namespace ACL
-* Network Pool
-* Network Rule
-* Network Settings
-* NFS Export
-* NFS Export Settings
-* NFS Global Settings
-* NFS Zone Settings
-* NTP Server
-* NTP Settings
-* Quota
-* Role
-* S3 Bucket
-* Smart Pool Settings
-* SMB Server Settings
-* SMB Share
-* SMB Share Settings
-* Snapshot
-* Snapshot Schedule
-* Subnet
-* User
-* User Group
-* User Mapping Rules
+* [Access Zone](docs/resources/accesszone.md)
+* [ACL Settings](docs/resources/aclsettings.md)
+* [Active Directory Service Provider](docs/resources/adsprovider.md)
+* [Cluster Email Settings](docs/resources/cluster_email.md)
+* [File Pool Policy](docs/resources/filepool_policy.md)
+* [File System](docs/resources/filesystem.md)
+* [Groupnet](docs/resources/groupnet.md)
+* [LDAP Provider](docs/resources/ldap_provider.md)
+* [Namespace ACL](docs/resources/namespace_acl.md)
+* [Network Pool](docs/resources/networkpool.md)
+* [Network Rule](docs/resources/network_rule.md)
+* [Network Settings](docs/resources/network_settings.md)
+* [NFS Export](docs/resources/nfs_export.md)
+* [NFS Export Settings](docs/resources/nfs_export_settings.md)
+* [NFS Global Settings](docs/resources/nfs_global_settings.md)
+* [NFS Zone Settings](docs/resources/nfs_zone_settings.md)
+* [NTP Server](docs/resources/ntpserver.md)
+* [NTP Settings](docs/resources/ntpsettings.md)
+* [Quota](docs/resources/quota.md)
+* [Role](docs/resources/role.md)
+* [S3 Bucket](docs/resources/s3_bucket.md)
+* [Smart Pool Settings](docs/resources/smartpool_settings.md)
+* [SMB Server Settings](docs/resources/smb_server_settings.md)
+* [SMB Share](docs/resources/smb_share.md)
+* [SMB Share Settings](docs/resources/smb_share_settings.md)
+* [Snapshot](docs/resources/snapshot.md)
+* [Snapshot Schedule](docs/resources/snapshot_schedule.md)
+* [Subnet](docs/resources/subnet.md)
+* [User](docs/resources/user.md)
+* [User Group](docs/resources/user_group.md)
+* [User Mapping Rules](docs/resources/user_mapping_rules.md)
+* [Cluster Identity](docs/resources/cluster_identity.md)
+* [Cluster SNMP](docs/resources/cluster_snmp.md)
+* [Cluster Owner](docs/resources/cluster_owner.md)
+* [Cluster Time](docs/resources/cluster_time.md)
+* [Support Assist](docs/resources/support_assist.md)
+* [S3 Key](docs/resources/s3_key.md)
+* [S3 Zone Settings](docs/resources/s3_zone_settings.md)
+* [S3 Global Settings](docs/resources/s3_global_settings.md)
+* [SyncIQ Policy](docs/resources/synciq_policy.md)
+* [SyncIQ Global Settings](docs/resources/synciq_global_settings.md)
+* [SyncIQ Peer Certificate](docs/resources/synciq_peer_certificate.md)
 
 ## Installation and execution of Terraform Provider for Dell PowerScale
 
@@ -132,7 +148,7 @@ Create a file called `main.tf` in your workspace with the following contents
 terraform {
   required_providers {
     powerscale = { 
-      version = "1.4.0"
+      version = "1.5.0"
       source = "registry.terraform.io/dell/powerscale"
     }
   }

diff --git a/about/INSTALLATION.md b/about/INSTALLATION.md
@@ -26,7 +26,7 @@ Create a file called `main.tf` in your workspace with the following contents
 terraform {
   required_providers {
     powerscale = { 
-      version = "1.0.0"
+      version = "1.5.0"
       source = "registry.terraform.io/dell/powerscale"
     }
   }

diff --git a/docs/data-sources/synciq_global_settings.md b/docs/data-sources/synciq_global_settings.md
@@ -46,7 +46,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-# This Terraform DataSource is used to query the details of the SyncIQ Globalbsettings from PowerScale array.
+# This Terraform DataSource is used to query the details of the SyncIQ Global Settings from PowerScale array.
 
 # Returns the PowerScale SyncIQ Global settings on PowerScale array
 data "powerscale_synciq_global_settings" "all" {

diff --git a/docs/data-sources/synciq_policy.md b/docs/data-sources/synciq_policy.md
@@ -19,12 +19,12 @@ linkTitle: "powerscale_synciq_policy"
 page_title: "powerscale_synciq_policy Data Source - terraform-provider-powerscale"
 subcategory: ""
 description: |-
-  This datasource is used to query the existing SyncIQ Policies from PowerScale array.
+  This datasource is used to query the existing SyncIQ Policies from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.
 ---
 
 # powerscale_synciq_policy (Data Source)
 
-This datasource is used to query the existing SyncIQ Policies from PowerScale array.
+This datasource is used to query the existing SyncIQ Policies from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.
 
 ## Example Usage
 
@@ -53,7 +53,7 @@ data "powerscale_synciq_policy" "all_policies" {
 }
 
 # Returns a the PowerScale SyncIQ Policy with given ID
-data "powerscale_synciq_policy" "all_policies" {
+data "powerscale_synciq_policy" "one_policy" {
   id = "g23j9a1f83h12n5j4"
 }
 
@@ -63,9 +63,9 @@ output "powerscale_synciq_all_policies" {
   value = data.powerscale_synciq_policy.all_policies.policies
 }
 
-# The user can use the fetched policy by ID by the variable data.powerscale_synciq_policy.one.policies[0]
+# The user can use the fetched policy by ID by the variable data.powerscale_synciq_policy.one_policy.policies[0]
 output "policyByID" {
-  value = data.powerscale_synciq_policy.one.policies[0]
+  value = data.powerscale_synciq_policy.one_policy.one_policy[0]
 }
 
 # Get syncIQ policy by name

diff --git a/docs/data-sources/synciq_rule.md b/docs/data-sources/synciq_rule.md
@@ -19,12 +19,12 @@ linkTitle: "powerscale_synciq_rule"
 page_title: "powerscale_synciq_rule Data Source - terraform-provider-powerscale"
 subcategory: ""
 description: |-
-  This datasource is used to query the existing SyncIQ Replication Rules from PowerScale array.
+  This datasource is used to query the existing SyncIQ Replication Rules from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.
 ---
 
 # powerscale_synciq_rule (Data Source)
 
-This datasource is used to query the existing SyncIQ Replication Rules from PowerScale array.
+This datasource is used to query the existing SyncIQ Replication Rules from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.
 
 ## Example Usage
 

diff --git a/docs/index.md b/docs/index.md
@@ -53,7 +53,7 @@ terraform {
   required_providers {
     powerscale = {
       source  = "registry.terraform.io/dell/powerscale"
-      version = "1.4.0"
+      version = "1.5.0"
     }
   }
 }

diff --git a/docs/resources/accesszone.md b/docs/resources/accesszone.md
@@ -83,13 +83,13 @@ resource "powerscale_accesszone" "zone" {
 
 ### Required
 
-- `groupnet` (String) Groupnet identifier
-- `name` (String) Specifies the access zone name. (Update Supported)
-- `path` (String) Specifies the access zone base directory path. (Update Supported)
+- `groupnet` (String) Groupnet identifier. Cannot be updated.
+- `name` (String) Specifies the access zone name.
+- `path` (String) Specifies the access zone base directory path.
 
 ### Optional
 
-- `custom_auth_providers` (List of String) An optional parameter which adds new auth_providers to the access zone. A provider name should be of the form '[provider-type:]provider-name', the provider-type defaults to 'lsa-local-provider'. (Update Supported)
+- `custom_auth_providers` (List of String) An optional parameter which adds new auth_providers to the access zone. A provider name should be of the form '[provider-type:]provider-name', the provider-type defaults to 'lsa-local-provider'.
 
 ### Read-Only
 
@@ -118,6 +118,8 @@ Read-Only:
 - `name` (String) Specifies the persona name, which must be combined with a type.
 - `type` (String) Specifies the type of persona, which must be combined with a name.
 
+Unless specified otherwise, all fields of this resource can be updated.
+
 ## Import
 
 Import is supported using the following syntax:

diff --git a/docs/resources/aclsettings.md b/docs/resources/aclsettings.md
@@ -100,6 +100,8 @@ resource "powerscale_aclsettings" "example_acl_settings" {
 - `synthetic_denies` (String) Synthetic 'deny' ACEs. Options: none, remove
 - `utimes` (String) Access check (utimes). Options: only_owner, owner_and_write
 
+Unless specified otherwise, all fields of this resource can be updated.
+
 ## Import
 
 Import is supported using the following syntax:

diff --git a/docs/resources/adsprovider.md b/docs/resources/adsprovider.md
@@ -190,6 +190,8 @@ resource "powerscale_adsprovider" "ads_test" {
 - `system` (Boolean) If set to true, indicates that this provider instance was created by OneFS and cannot be removed.
 - `zone_name` (String) Specifies the name of the access zone in which this provider was created.
 
+Unless specified otherwise, all fields of this resource can be updated.
+
 ## Import
 
 Import is supported using the following syntax:

diff --git a/docs/resources/cluster_email.md b/docs/resources/cluster_email.md
@@ -109,6 +109,8 @@ Read-Only:
 
 - `smtp_auth_passwd_set` (Boolean) Indicates if an SMTP authentication password is set.
 
+Unless specified otherwise, all fields of this resource can be updated.
+
 ## Import
 
 Import is supported using the following syntax:

diff --git a/docs/resources/cluster_identity.md b/docs/resources/cluster_identity.md
@@ -19,12 +19,12 @@ linkTitle: "powerscale_cluster_identity"
 page_title: "powerscale_cluster_identity Resource - terraform-provider-powerscale"
 subcategory: ""
 description: |-
-  This resource is used to manage the Cluster Identity settings of PowerScale Array. We can Create, Update and Delete the Cluster Identity using this resource. We can also import an existing Cluster Identity from PowerScale array.
+  This resource is used to manage the Cluster Identity settings of PowerScale Array. We can Create, Update and Delete the Cluster Identity using this resource. We can also import the existing Cluster Identity settings from PowerScale array.
 ---
 
 # powerscale_cluster_identity (Resource)
 
-This resource is used to manage the Cluster Identity settings of PowerScale Array. We can Create, Update and Delete the Cluster Identity using this resource. We can also import an existing Cluster Identity from PowerScale array.
+This resource is used to manage the Cluster Identity settings of PowerScale Array. We can Create, Update and Delete the Cluster Identity using this resource. We can also import the existing Cluster Identity settings from PowerScale array.
 
 
 ## Example Usage
@@ -100,6 +100,8 @@ Optional:
 - `motd` (String) The message of the day.
 - `motd_header` (String) The header to the message of the day.
 
+Unless specified otherwise, all fields of this resource can be updated.
+
 ## Import
 
 Import is supported using the following syntax:
@@ -124,6 +126,6 @@ Import is supported using the following syntax:
 # terraform import powerscale_cluster_identity.example_identity_settings <anyString>
 # Example:
 terraform import powerscale_cluster_identity.example_identity_settings "cluster_identity"
-# after running this command, populate the name field and other required parameters in the config file to start managing this resource.
+# after running this command, populate fields as per your requirement in the config file to start managing this resource.
 # Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.
 ```
diff --git a/docs/resources/cluster_owner.md b/docs/resources/cluster_owner.md
@@ -92,6 +92,8 @@ resource "powerscale_cluster_owner" "test" {
 
 - `id` (String) ID of the Cluster Owner Settings.
 
+Unless specified otherwise, all fields of this resource can be updated.
+
 ## Import
 
 Import is supported using the following syntax: