From f2b4e4eac0feda185477bfeebb32bfe10989c4ce Mon Sep 17 00:00:00 2001 From: Akash Shendge <60608990+shenda1@users.noreply.github.com> Date: Wed, 26 Jun 2024 14:18:37 +0530 Subject: [PATCH] addressed review comments (#198) * addressed review comments Signed-off-by: Shendge --- docs/data-sources/device.md | 4 ++-- docs/data-sources/fault_set.md | 4 ++-- docs/data-sources/firmware_repository.md | 4 ++-- docs/data-sources/node.md | 4 ++-- docs/data-sources/protection_domain.md | 4 ++-- docs/data-sources/resource_group.md | 4 ++-- docs/data-sources/sdc.md | 4 ++-- docs/data-sources/sds.md | 4 ++-- docs/data-sources/service.md | 4 ++-- docs/data-sources/snapshot_policy.md | 4 ++-- docs/data-sources/storage_pool.md | 4 ++-- docs/data-sources/template.md | 4 ++-- docs/data-sources/volume.md | 4 ++-- docs/data-sources/vtree.md | 4 ++-- docs/resources/cluster.md | 24 ++++++++++--------- docs/resources/fault_set.md | 4 ++-- docs/resources/firmware_repository.md | 4 ++-- docs/resources/mdm_cluster.md | 4 ++-- docs/resources/protection_domain.md | 4 ++-- docs/resources/resource_group.md | 4 ++-- docs/resources/sdc.md | 4 ++-- docs/resources/sdc_host.md | 8 +++---- docs/resources/sdc_volumes_mapping.md | 4 ++-- docs/resources/sds.md | 4 ++-- docs/resources/service.md | 4 ++-- docs/resources/snapshot.md | 4 ++-- docs/resources/snapshot_policy.md | 4 ++-- docs/resources/storage_pool.md | 4 ++-- docs/resources/system.md | 4 ++-- docs/resources/user.md | 4 ++-- docs/resources/volume.md | 4 ++-- powerflex/provider/cluster_resource_schema.go | 4 ++-- .../provider/device_datasource_schema.go | 4 ++-- powerflex/provider/fault_set_datasource.go | 4 ++-- .../provider/fault_set_resource_schema.go | 4 ++-- .../firmware_repository_datasource_schema.go | 4 ++-- .../firmware_repository_resource_schema.go | 4 ++-- powerflex/provider/mdm_cluster_resource.go | 4 ++-- powerflex/provider/node_datasource_schema.go | 4 ++-- .../protection_domain_datasource_schema.go | 4 ++-- .../protection_domain_resource_schema.go | 7 +++--- .../resource_group_datasource_schema.go | 4 ++-- .../resource_group_resource_schema.go | 4 ++-- powerflex/provider/sdc_datasource_schema.go | 4 ++-- powerflex/provider/sdc_host_resource.go | 4 ++-- powerflex/provider/sdc_resource_schema.go | 4 ++-- .../provider/sdc_volumes_mapping_resource.go | 4 ++-- powerflex/provider/sds_datasource_schema.go | 4 ++-- powerflex/provider/sds_resource_schema.go | 4 ++-- .../provider/service_datasource_schema.go | 4 ++-- powerflex/provider/service_resource_schema.go | 4 ++-- powerflex/provider/snapshot_policy_schema.go | 4 ++-- .../provider/snapshot_resource_schema.go | 7 +++--- .../snapshotpolicy_datasource_schema.go | 4 ++-- .../storagepool_data_source_schema.go | 4 ++-- .../provider/storagepool_resource_schema.go | 4 ++-- powerflex/provider/system_resource.go | 4 ++-- .../provider/template_datasource_schema.go | 4 ++-- powerflex/provider/user_resource.go | 4 ++-- .../provider/volume_datasource_schema.go | 4 ++-- powerflex/provider/volume_resource_schema.go | 4 ++-- powerflex/provider/vtree_datasource.go | 4 ++-- templates/resources/cluster.md.tmpl | 20 +++++++++------- templates/resources/sdc_host.md.tmpl | 4 ++-- 64 files changed, 154 insertions(+), 148 deletions(-) diff --git a/docs/data-sources/device.md b/docs/data-sources/device.md index 22b1fa91..201de10f 100644 --- a/docs/data-sources/device.md +++ b/docs/data-sources/device.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_device" page_title: "powerflex_device Data Source - powerflex" subcategory: "" description: |- - This datasource is used to query the existing device from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. + This datasource is used to query the existing device from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. --- # powerflex_device (Data Source) -This datasource is used to query the existing device from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. +This datasource is used to query the existing device from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. > **Note:** Only one of `name` and `id` can be provided at a time. diff --git a/docs/data-sources/fault_set.md b/docs/data-sources/fault_set.md index 6c493d5c..9a538589 100644 --- a/docs/data-sources/fault_set.md +++ b/docs/data-sources/fault_set.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_fault_set" page_title: "powerflex_fault_set Data Source - powerflex" subcategory: "" description: |- - This datasource is used to query the existing fault set from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. + This datasource is used to query the existing fault set from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. --- # powerflex_fault_set (Data Source) -This datasource is used to query the existing fault set from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. +This datasource is used to query the existing fault set from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. ## Example Usage diff --git a/docs/data-sources/firmware_repository.md b/docs/data-sources/firmware_repository.md index 0cf013c5..810d391c 100644 --- a/docs/data-sources/firmware_repository.md +++ b/docs/data-sources/firmware_repository.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_firmware_repository" page_title: "powerflex_firmware_repository Data Source - powerflex" subcategory: "" description: |- - This datasource is used to query the existing firmware repository from PowerFlex array. The information fetched from this datasource can be used for getting the necessary details regarding the bundles and their components in that firmware repository. + This datasource is used to query the existing firmware repository from the PowerFlex array. The information fetched from this datasource can be used for getting the necessary details regarding the bundles and their components in that firmware repository. --- # powerflex_firmware_repository (Data Source) -This datasource is used to query the existing firmware repository from PowerFlex array. The information fetched from this datasource can be used for getting the necessary details regarding the bundles and their components in that firmware repository. +This datasource is used to query the existing firmware repository from the PowerFlex array. The information fetched from this datasource can be used for getting the necessary details regarding the bundles and their components in that firmware repository. diff --git a/docs/data-sources/node.md b/docs/data-sources/node.md index d46abce7..9d5e1e1f 100644 --- a/docs/data-sources/node.md +++ b/docs/data-sources/node.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_node" page_title: "powerflex_node Data Source - powerflex" subcategory: "" description: |- - This datasource is used to query the existing nodes from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. + This datasource is used to query the existing nodes from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. --- # powerflex_node (Data Source) -This datasource is used to query the existing nodes from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. +This datasource is used to query the existing nodes from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. ## Example Usage diff --git a/docs/data-sources/protection_domain.md b/docs/data-sources/protection_domain.md index 077d0b96..dd38679b 100644 --- a/docs/data-sources/protection_domain.md +++ b/docs/data-sources/protection_domain.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_protection_domain" page_title: "powerflex_protection_domain Data Source - powerflex" subcategory: "" description: |- - This datasource is used to query the existing protection domain from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. + This datasource is used to query the existing protection domain from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. --- # powerflex_protection_domain (Data Source) -This datasource is used to query the existing protection domain from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. +This datasource is used to query the existing protection domain from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. > **Note:** Only one of `name` and `id` can be provided at a time. diff --git a/docs/data-sources/resource_group.md b/docs/data-sources/resource_group.md index 7eeb7a7b..7082efa8 100644 --- a/docs/data-sources/resource_group.md +++ b/docs/data-sources/resource_group.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_resource_group" page_title: "powerflex_resource_group Data Source - powerflex" subcategory: "" description: |- - This datasource is used to query the existing ResourceGroup from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. + This datasource is used to query the existing ResourceGroup from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. --- # powerflex_resource_group (Data Source) -This datasource is used to query the existing ResourceGroup from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. +This datasource is used to query the existing ResourceGroup from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. ## Example Usage diff --git a/docs/data-sources/sdc.md b/docs/data-sources/sdc.md index aebd7bb0..e912cbc1 100644 --- a/docs/data-sources/sdc.md +++ b/docs/data-sources/sdc.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_sdc" page_title: "powerflex_sdc Data Source - powerflex" subcategory: "" description: |- - This datasource is used to query the existing Storage Data Clients from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. + This datasource is used to query the existing Storage Data Clients from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. --- # powerflex_sdc (Data Source) -This datasource is used to query the existing Storage Data Clients from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. +This datasource is used to query the existing Storage Data Clients from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. > **Note:** Only one of `name` and `id` can be provided at a time. diff --git a/docs/data-sources/sds.md b/docs/data-sources/sds.md index 4e9bee23..d3898836 100644 --- a/docs/data-sources/sds.md +++ b/docs/data-sources/sds.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_sds" page_title: "powerflex_sds Data Source - powerflex" subcategory: "" description: |- - This datasource is used to query the existing Storage Data Servers from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. + This datasource is used to query the existing Storage Data Servers from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. --- # powerflex_sds (Data Source) -This datasource is used to query the existing Storage Data Servers from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. +This datasource is used to query the existing Storage Data Servers from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. > **Note:** Exactly one of `protection_domain_name` and `protection_domain_id` is required. diff --git a/docs/data-sources/service.md b/docs/data-sources/service.md index 295b4e28..1e35b552 100644 --- a/docs/data-sources/service.md +++ b/docs/data-sources/service.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_service" page_title: "powerflex_service Data Source - powerflex" subcategory: "" description: |- - This datasource is used to query the existing services from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. + This datasource is used to query the existing services from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. --- # powerflex_service (Data Source) -This datasource is used to query the existing services from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. +This datasource is used to query the existing services from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. ## Example Usage diff --git a/docs/data-sources/snapshot_policy.md b/docs/data-sources/snapshot_policy.md index 2abc014d..365cf15d 100644 --- a/docs/data-sources/snapshot_policy.md +++ b/docs/data-sources/snapshot_policy.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_snapshot_policy" page_title: "powerflex_snapshot_policy Data Source - powerflex" subcategory: "" description: |- - This datasource is used to query the existing snapshot policies from PowerFlex array. The information fetched from this datasource can be used for getting the details. + This datasource is used to query the existing snapshot policies from the PowerFlex array. The information fetched from this datasource can be used for getting the details. --- # powerflex_snapshot_policy (Data Source) -This datasource is used to query the existing snapshot policies from PowerFlex array. The information fetched from this datasource can be used for getting the details. +This datasource is used to query the existing snapshot policies from the PowerFlex array. The information fetched from this datasource can be used for getting the details. > **Note:** Only one of `name` and `id` can be provided at a time. diff --git a/docs/data-sources/storage_pool.md b/docs/data-sources/storage_pool.md index 9d7519c8..3da1057f 100644 --- a/docs/data-sources/storage_pool.md +++ b/docs/data-sources/storage_pool.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_storage_pool" page_title: "powerflex_storage_pool Data Source - powerflex" subcategory: "" description: |- - This datasource is used to query the existing storage pools from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. + This datasource is used to query the existing storage pools from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. --- # powerflex_storage_pool (Data Source) -This datasource is used to query the existing storage pools from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. +This datasource is used to query the existing storage pools from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. > **Note:** Either `protection_domain_name` or `protection_domain_id` is required. But not both. diff --git a/docs/data-sources/template.md b/docs/data-sources/template.md index f15fdf8c..5905974a 100644 --- a/docs/data-sources/template.md +++ b/docs/data-sources/template.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_template" page_title: "powerflex_template Data Source - powerflex" subcategory: "" description: |- - This datasource is used to query the existing templates from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. + This datasource is used to query the existing templates from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. --- # powerflex_template (Data Source) -This datasource is used to query the existing templates from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. +This datasource is used to query the existing templates from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. ## Example Usage diff --git a/docs/data-sources/volume.md b/docs/data-sources/volume.md index adddd52d..50362bd3 100644 --- a/docs/data-sources/volume.md +++ b/docs/data-sources/volume.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_volume" page_title: "powerflex_volume Data Source - powerflex" subcategory: "" description: |- - This datasource is used to query the existing volume from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. + This datasource is used to query the existing volume from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. --- # powerflex_volume (Data Source) -This datasource is used to query the existing volume from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. +This datasource is used to query the existing volume from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block. > **Note:** Only one of `names`, `id`, `storage_pool_id` and `storage_pool_name` can be provided at a time. diff --git a/docs/data-sources/vtree.md b/docs/data-sources/vtree.md index 727c39d9..d3084eb0 100644 --- a/docs/data-sources/vtree.md +++ b/docs/data-sources/vtree.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_vtree" page_title: "powerflex_vtree Data Source - powerflex" subcategory: "" description: |- - This datasource is used to query the existing vtrees from PowerFlex array. The information fetched from this datasource can be used for getting the details. + This datasource is used to query the existing vtrees from the PowerFlex array. The information fetched from this datasource can be used for getting the details. --- # powerflex_vtree (Data Source) -This datasource is used to query the existing vtrees from PowerFlex array. The information fetched from this datasource can be used for getting the details. +This datasource is used to query the existing vtrees from the PowerFlex array. The information fetched from this datasource can be used for getting the details. ## Example Usage diff --git a/docs/resources/cluster.md b/docs/resources/cluster.md index c3a684fa..85c86dcc 100644 --- a/docs/resources/cluster.md +++ b/docs/resources/cluster.md @@ -19,30 +19,32 @@ linkTitle: "powerflex_cluster" page_title: "powerflex_cluster Resource - powerflex" subcategory: "" description: |- - This terraform resource is used to deploy PowerFlex Cluster. We can Create and Delete the PowerFlex Cluster using this resource. We can also Import an existing Cluster of PowerFlex. + This terraform resource is used to deploy the PowerFlex Cluster. We can Create and Delete the PowerFlex Cluster using this resource. We can also Import an existing Cluster of the PowerFlex. --- # powerflex_cluster (Resource) -This terraform resource is used to deploy PowerFlex Cluster. We can Create and Delete the PowerFlex Cluster using this resource. We can also Import an existing Cluster of PowerFlex. +This terraform resource is used to deploy the PowerFlex Cluster. We can Create and Delete the PowerFlex Cluster using this resource. We can also Import an existing Cluster of the PowerFlex. -> **Note:** For PowerFlex 4.x, the PowerFlex Manager must be installed as a prerequisite. The required packages should be uploaded to the PowerFlex Manager. +**Please consider the following points before using cluster resource.** -> **Note:** For PowerFlex 3.x, a Gateway server is a prerequisite. The required packages should be uploaded to the gateway. The Package resource can be used for uploading packages to the gateway. +1. For PowerFlex 4.x, the PowerFlex Manager must be installed as a prerequisite. The required packages should be uploaded to the PowerFlex Manager. -> **Note:** Support is provided for creating, importing, and deleting operations for this resource. +2. For PowerFlex 3.x, a Gateway server is a prerequisite. The required packages should be uploaded to the gateway. The Package resource can be used for uploading packages to the gateway. -> **Note:** In multi-node cluster deployments, when some of the component installations fail, the partial deployment will not be rolled back. +3. Support is provided for creating, importing, and deleting operations for this resource. -> **Note:** If you've separately installed any SDR, SDS, or SDC and connected it to the cluster and if you face any security certificate issues during the destroy process, you'll have to manually accept the security certificate to resolve them. +4. In multi-node cluster deployments, when some of the component installations fail, the partial deployment will not be rolled back. -> **Note:** During the destroy process, the entire cluster will be destroyed, not just specific individual resources. After destroy need to follow cleanup process. +5. If you've separately installed any SDR, SDS, or SDC and connected it to the cluster and if you face any security certificate issues during the destroy process, you'll have to manually accept the security certificate to resolve them. -> **Note:** `ips` attribute is used in minimal csv configuration whereas `mdm_ips` attribute is used in complete csv configuration. +6. During the destroy process, the entire cluster will be destroyed, not just specific individual resources. After destroy need to follow cleanup process. -> **Note:** For PowerFlex 4.x, there's no need to mention `allow_non_secure_communication_with_lia`, `allow_non_secure_communication_with_mdm`, and `disable_non_mgmt_components_auth`. And, **Rfcache** is not supported. +7. `ips` attribute is used in minimal csv configuration whereas `mdm_ips` attribute is used in complete csv configuration. -> **Note:** To follow the installation process, you can refer to the [Deployment Guide 3.x](https://www.dell.com/support/manuals/en-us/scaleio/pfx_deploy_guide_3.6.x/deploy-powerflex?guid=guid-e9f70972-baac-42c9-9ff9-a3d2b0722f54&lang=en-us) & [Deployment Guide 4.x](https://www.dell.com/support/manuals/en-us/scaleio/powerflex_install_upgrade_guide_4.5.x/introduction?guid=guid-e798f431-7df4-450c-8f86-60ee7f3d1e3e&lang=en-us) +8. For PowerFlex 4.x, there's no need to mention `allow_non_secure_communication_with_lia`, `allow_non_secure_communication_with_mdm`, and `disable_non_mgmt_components_auth`. And, **Rfcache** is not supported. + +9. To follow the installation process, you can refer to the [Deployment Guide 3.x](https://www.dell.com/support/manuals/en-us/scaleio/pfx_deploy_guide_3.6.x/deploy-powerflex?guid=guid-e9f70972-baac-42c9-9ff9-a3d2b0722f54&lang=en-us) & [Deployment Guide 4.x](https://www.dell.com/support/manuals/en-us/scaleio/powerflex_install_upgrade_guide_4.5.x/introduction?guid=guid-e798f431-7df4-450c-8f86-60ee7f3d1e3e&lang=en-us) ## Example Usage diff --git a/docs/resources/fault_set.md b/docs/resources/fault_set.md index 9861ff55..545f6e91 100644 --- a/docs/resources/fault_set.md +++ b/docs/resources/fault_set.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_fault_set" page_title: "powerflex_fault_set Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the Fault Set entity of PowerFlex Array. We can Create, Update and Delete the fault set using this resource. We can also import an existing fault set from PowerFlex array. + This resource is used to manage the Fault Set entity of the PowerFlex Array. We can Create, Update and Delete the fault set using this resource. We can also import an existing fault set from the PowerFlex array. --- # powerflex_fault_set (Resource) -This resource is used to manage the Fault Set entity of PowerFlex Array. We can Create, Update and Delete the fault set using this resource. We can also import an existing fault set from PowerFlex array. +This resource is used to manage the Fault Set entity of the PowerFlex Array. We can Create, Update and Delete the fault set using this resource. We can also import an existing fault set from the PowerFlex array. ## Example Usage diff --git a/docs/resources/firmware_repository.md b/docs/resources/firmware_repository.md index ba90d095..0f12b572 100644 --- a/docs/resources/firmware_repository.md +++ b/docs/resources/firmware_repository.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_firmware_repository" page_title: "powerflex_firmware_repository Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the Firmware Repository entity of PowerFlex Array. We can Create and Update the firmware repository using this resource. As part of create operation, we can upload the compliance file and as part of update we can approve the unsigned files.We can also import an existing firmware repository from PowerFlex array. + This resource is used to manage the Firmware Repository entity of the PowerFlex Array. We can Create and Update the firmware repository using this resource. As part of create operation, we can upload the compliance file and as part of update we can approve the unsigned files.We can also import an existing firmware repository from the PowerFlex array. --- # powerflex_firmware_repository (Resource) -This resource is used to manage the Firmware Repository entity of PowerFlex Array. We can Create and Update the firmware repository using this resource. As part of create operation, we can upload the compliance file and as part of update we can approve the unsigned files.We can also import an existing firmware repository from PowerFlex array. +This resource is used to manage the Firmware Repository entity of the PowerFlex Array. We can Create and Update the firmware repository using this resource. As part of create operation, we can upload the compliance file and as part of update we can approve the unsigned files.We can also import an existing firmware repository from the PowerFlex array. ## Example Usage diff --git a/docs/resources/mdm_cluster.md b/docs/resources/mdm_cluster.md index 526e5460..8fc4ab5f 100644 --- a/docs/resources/mdm_cluster.md +++ b/docs/resources/mdm_cluster.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_mdm_cluster" page_title: "powerflex_mdm_cluster Resource - powerflex" subcategory: "" description: |- - This resource can be used to manage MDM cluster on a PowerFlex array. Supports adding or removing standby MDMs, migrate from 3-node to 5-node cluster or vice-versa, changing MDM ownership, changing performance profile, and renaming MDMs. + This resource can be used to manage MDM cluster on the PowerFlex array. Supports adding or removing standby MDMs, migrate from 3-node to 5-node cluster or vice-versa, changing MDM ownership, changing performance profile, and renaming MDMs. --- # powerflex_mdm_cluster (Resource) -This resource can be used to manage MDM cluster on a PowerFlex array. Supports adding or removing standby MDMs, migrate from 3-node to 5-node cluster or vice-versa, changing MDM ownership, changing performance profile, and renaming MDMs. +This resource can be used to manage MDM cluster on the PowerFlex array. Supports adding or removing standby MDMs, migrate from 3-node to 5-node cluster or vice-versa, changing MDM ownership, changing performance profile, and renaming MDMs. > **Caution:** MDM cluster creation or update is not atomic. In case of partially completed create operations, terraform can mark the resource as tainted. One can manually remove the taint and try applying the configuration (after making necessary adjustments). diff --git a/docs/resources/protection_domain.md b/docs/resources/protection_domain.md index 2298b162..b94c372a 100644 --- a/docs/resources/protection_domain.md +++ b/docs/resources/protection_domain.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_protection_domain" page_title: "powerflex_protection_domain Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the Protection Domain entity of PowerFlex Array. We can Create, Update and Delete the protection domain using this resource. We can also import an existing protection domain from PowerFlex array. + This resource is used to manage the Protection Domain entity of the PowerFlex Array. We can Create, Update and Delete the protection domain using this resource. We can also import an existing protection domain from the PowerFlex array. --- # powerflex_protection_domain (Resource) -This resource is used to manage the Protection Domain entity of PowerFlex Array. We can Create, Update and Delete the protection domain using this resource. We can also import an existing protection domain from PowerFlex array. +This resource is used to manage the Protection Domain entity of the PowerFlex Array. We can Create, Update and Delete the protection domain using this resource. We can also import an existing protection domain from the PowerFlex array. > **Caution:** Protection Domain creation or update is not atomic. In case of partially completed create operations, terraform can mark the resource as tainted. One can manually remove the taint and try applying the configuration (after making necessary adjustments). diff --git a/docs/resources/resource_group.md b/docs/resources/resource_group.md index ff80f67b..d64d0f4e 100644 --- a/docs/resources/resource_group.md +++ b/docs/resources/resource_group.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_resource_group" page_title: "powerflex_resource_group Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the ResourceGroup entity of PowerFlex Array. We can Create, Update and Delete the PowerFlex ResourceGroup using this resource. We can also Import an existing ResourceGroup from PowerFlex array. + This resource is used to manage the ResourceGroup entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex ResourceGroup using this resource. We can also Import an existing ResourceGroup from the PowerFlex array. --- # powerflex_resource_group (Resource) -This resource is used to manage the ResourceGroup entity of PowerFlex Array. We can Create, Update and Delete the PowerFlex ResourceGroup using this resource. We can also Import an existing ResourceGroup from PowerFlex array. +This resource is used to manage the ResourceGroup entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex ResourceGroup using this resource. We can also Import an existing ResourceGroup from the PowerFlex array. ## Example Usage diff --git a/docs/resources/sdc.md b/docs/resources/sdc.md index 08e2bfe2..24041eb4 100644 --- a/docs/resources/sdc.md +++ b/docs/resources/sdc.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_sdc" page_title: "powerflex_sdc Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the SDC entity of PowerFlex Array. We can Create, Update and Delete the PowerFlex SDC using this resource. We can also Import an existing SDC from PowerFlex array. + This resource is used to manage the SDC entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex SDC using this resource. We can also Import an existing SDC from the PowerFlex array. --- # powerflex_sdc (Resource) -This resource is used to manage the SDC entity of PowerFlex Array. We can Create, Update and Delete the PowerFlex SDC using this resource. We can also Import an existing SDC from PowerFlex array. +This resource is used to manage the SDC entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex SDC using this resource. We can also Import an existing SDC from the PowerFlex array. > **Note:** If a cluster is configured with a virtual IP, then it is necessary to provide `virtual_ips` and `virtual_ip_nics` while specifying the primary and secondary MDM details. diff --git a/docs/resources/sdc_host.md b/docs/resources/sdc_host.md index b616052e..345efbd0 100644 --- a/docs/resources/sdc_host.md +++ b/docs/resources/sdc_host.md @@ -19,19 +19,19 @@ linkTitle: "powerflex_sdc_host" page_title: "powerflex_sdc_host Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the SDC entity of PowerFlex Array. We can Create, Update and Delete the SDC using this resource. We can also import an existing SDC from PowerFlex array. + This resource is used to manage the SDC entity of the PowerFlex Array. We can Create, Update and Delete the SDC using this resource. We can also import an existing SDC from the PowerFlex array. --- # powerflex_sdc_host (Resource) -This resource is used to manage the SDC entity of PowerFlex Array. We can Create, Update and Delete the SDC using this resource. We can also import an existing SDC from PowerFlex array. +This resource is used to manage the SDC entity of the PowerFlex Array. We can Create, Update and Delete the SDC using this resource. We can also import an existing SDC from the PowerFlex array. -~> **Caution:** SDC Host creation is not atomic. This resource sets parameters like name, etc. after SDC installation is complete. +~> **Caution:** SDC Host creation is not atomic. This resource sets parameters like name, etc. after SDC installation is complete. If that fails for any reason, Terraform, by default, will mark this resource as tainted and recreate it on the next apply. But these issues (caused by invalid inputs, network disruptions, etc.) do not require resource recreation (ie. SDC re-installation) to resolve. If one untaints this resource manually (by running `terraform untaint `) prior to applying again, this resource can start from where it left off and, if the cause of failure has been rectified, it can take incremental actions to set the necessary SDC parameters. -So please untaint the resource before applying again if you want to prevent unnecessary SDC re-installations. +So please untaint the resource before applying again if you want to prevent unnecessary SDC re-installations. ## Example Usage diff --git a/docs/resources/sdc_volumes_mapping.md b/docs/resources/sdc_volumes_mapping.md index f5c67d5e..13dc84cf 100644 --- a/docs/resources/sdc_volumes_mapping.md +++ b/docs/resources/sdc_volumes_mapping.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_sdc_volumes_mapping" page_title: "powerflex_sdc_volumes_mapping Resource - powerflex" subcategory: "" description: |- - This resource can be used to map/unmap volumes to an SDC on a PowerFlex array. User can import an existing SDC and map volumes to it. + This resource can be used to map/unmap volumes to an SDC on the PowerFlex array. User can import an existing SDC and map volumes to it. --- # powerflex_sdc_volumes_mapping (Resource) -This resource can be used to map/unmap volumes to an SDC on a PowerFlex array. User can import an existing SDC and map volumes to it. +This resource can be used to map/unmap volumes to an SDC on the PowerFlex array. User can import an existing SDC and map volumes to it. > **Caution:** SDC Volume mapping creation or update is not atomic. In case of partially completed create operations, terraform can mark the resource as tainted. One can manually remove the taint and try applying the configuration (after making necessary adjustments). diff --git a/docs/resources/sds.md b/docs/resources/sds.md index c8817076..27d80f6b 100644 --- a/docs/resources/sds.md +++ b/docs/resources/sds.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_sds" page_title: "powerflex_sds Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the Storage Data Servers entity of PowerFlex Array. We can Create, Update and Delete the SDS using this resource. We can also import an existing SDS from PowerFlex array. + This resource is used to manage the Storage Data Servers entity of the PowerFlex Array. We can Create, Update and Delete the SDS using this resource. We can also import an existing SDS from the PowerFlex array. --- # powerflex_sds (Resource) -This resource is used to manage the Storage Data Servers entity of PowerFlex Array. We can Create, Update and Delete the SDS using this resource. We can also import an existing SDS from PowerFlex array. +This resource is used to manage the Storage Data Servers entity of the PowerFlex Array. We can Create, Update and Delete the SDS using this resource. We can also import an existing SDS from the PowerFlex array. > **Caution:** SDS creation or update is not atomic. In case of partially completed create operations, terraform can mark the resource as tainted. One can manually remove the taint and try applying the configuration (after making necessary adjustments). diff --git a/docs/resources/service.md b/docs/resources/service.md index 907309ce..89e8bbfb 100644 --- a/docs/resources/service.md +++ b/docs/resources/service.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_service" page_title: "powerflex_service Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the Service entity of PowerFlex Array. We can Create, Update and Delete the PowerFlex Service using this resource. We can also Import an existing Service from PowerFlex array. + This resource is used to manage the Service entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex Service using this resource. We can also Import an existing Service from the PowerFlex array. --- # powerflex_service (Resource) -This resource is used to manage the Service entity of PowerFlex Array. We can Create, Update and Delete the PowerFlex Service using this resource. We can also Import an existing Service from PowerFlex array. +This resource is used to manage the Service entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex Service using this resource. We can also Import an existing Service from the PowerFlex array. ## Example Usage diff --git a/docs/resources/snapshot.md b/docs/resources/snapshot.md index 4b179f9a..2f4cd73e 100644 --- a/docs/resources/snapshot.md +++ b/docs/resources/snapshot.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_snapshot" page_title: "powerflex_snapshot Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the Snapshot of volumes on PowerFlex Array. We can Create, Update and Delete the snapshots using this resource. We can also import an existing snapshot from PowerFlex array. + This resource is used to manage the Snapshot of volumes on the PowerFlex Array. We can Create, Update and Delete the snapshots using this resource. We can also import an existing snapshot from the PowerFlex array. --- # powerflex_snapshot (Resource) -This resource is used to manage the Snapshot of volumes on PowerFlex Array. We can Create, Update and Delete the snapshots using this resource. We can also import an existing snapshot from PowerFlex array. +This resource is used to manage the Snapshot of volumes on the PowerFlex Array. We can Create, Update and Delete the snapshots using this resource. We can also import an existing snapshot from the PowerFlex array. > **Caution:** Snapshot creation or update is not atomic. In case of partially completed create operations, terraform can mark the resource as tainted. One can manually remove the taint and try applying the configuration (after making necessary adjustments). diff --git a/docs/resources/snapshot_policy.md b/docs/resources/snapshot_policy.md index b0c52cb2..b24b2acf 100644 --- a/docs/resources/snapshot_policy.md +++ b/docs/resources/snapshot_policy.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_snapshot_policy" page_title: "powerflex_snapshot_policy Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the Snapshot Policy entity of PowerFlex Array. We can Create, Update and Delete the snapshot policy using this resource. We can also import an existing snapshot policy from PowerFlex array. + This resource is used to manage the Snapshot Policy entity of the PowerFlex Array. We can Create, Update and Delete the snapshot policy using this resource. We can also import an existing snapshot policy from the PowerFlex array. --- # powerflex_snapshot_policy (Resource) -This resource is used to manage the Snapshot Policy entity of PowerFlex Array. We can Create, Update and Delete the snapshot policy using this resource. We can also import an existing snapshot policy from PowerFlex array. +This resource is used to manage the Snapshot Policy entity of the PowerFlex Array. We can Create, Update and Delete the snapshot policy using this resource. We can also import an existing snapshot policy from the PowerFlex array. ## Example Usage diff --git a/docs/resources/storage_pool.md b/docs/resources/storage_pool.md index 9acdb56a..7b48df35 100644 --- a/docs/resources/storage_pool.md +++ b/docs/resources/storage_pool.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_storage_pool" page_title: "powerflex_storage_pool Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the Storage Pool entity of PowerFlex Array. We can Create, Update and Delete the storage pool using this resource. We can also import an existing storage pool from PowerFlex array. + This resource is used to manage the Storage Pool entity of the PowerFlex Array. We can Create, Update and Delete the storage pool using this resource. We can also import an existing storage pool from the PowerFlex array. --- # powerflex_storage_pool (Resource) -This resource is used to manage the Storage Pool entity of PowerFlex Array. We can Create, Update and Delete the storage pool using this resource. We can also import an existing storage pool from PowerFlex array. +This resource is used to manage the Storage Pool entity of the PowerFlex Array. We can Create, Update and Delete the storage pool using this resource. We can also import an existing storage pool from the PowerFlex array. > **Caution:** Storage Pool creation or update is not atomic. In case of partially completed create operations, terraform can mark the resource as tainted. One can manually remove the taint and try applying the configuration (after making necessary adjustments). diff --git a/docs/resources/system.md b/docs/resources/system.md index 4cc8be37..fe7b87da 100644 --- a/docs/resources/system.md +++ b/docs/resources/system.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_system" page_title: "powerflex_system Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the cluster level operations of PowerFlex Array. This resource supports Create, Update and Delete operations. + This resource is used to manage the cluster level operations of the PowerFlex Array. This resource supports Create, Update and Delete operations. --- # powerflex_system (Resource) -This resource is used to manage the cluster level operations of PowerFlex Array. This resource supports Create, Update and Delete operations. +This resource is used to manage the cluster level operations of the PowerFlex Array. This resource supports Create, Update and Delete operations. ## Example Usage diff --git a/docs/resources/user.md b/docs/resources/user.md index 10c785ae..ee896387 100644 --- a/docs/resources/user.md +++ b/docs/resources/user.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_user" page_title: "powerflex_user Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the User entity of PowerFlex Array. We can Create, Update and Delete the user using this resource. We can also import an existing user from PowerFlex array. However, password cannot be updated using this resource. + This resource is used to manage the User entity of the PowerFlex Array. We can Create, Update and Delete the user using this resource. We can also import an existing user from the PowerFlex array. --- # powerflex_user (Resource) -This resource is used to manage the User entity of PowerFlex Array. We can Create, Update and Delete the user using this resource. We can also import an existing user from PowerFlex array. However, password cannot be updated using this resource. +This resource is used to manage the User entity of the PowerFlex Array. We can Create, Update and Delete the user using this resource. We can also import an existing user from the PowerFlex array. ## Example Usage diff --git a/docs/resources/volume.md b/docs/resources/volume.md index 7eda20c6..4fcfcd7c 100644 --- a/docs/resources/volume.md +++ b/docs/resources/volume.md @@ -19,12 +19,12 @@ linkTitle: "powerflex_volume" page_title: "powerflex_volume Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the Volume entity of PowerFlex Array. We can Create, Update and Delete the volume using this resource. We can also import an existing volume from PowerFlex array. + This resource is used to manage the Volume entity of the PowerFlex Array. We can Create, Update and Delete the volume using this resource. We can also import an existing volume from the PowerFlex array. --- # powerflex_volume (Resource) -This resource is used to manage the Volume entity of PowerFlex Array. We can Create, Update and Delete the volume using this resource. We can also import an existing volume from PowerFlex array. +This resource is used to manage the Volume entity of the PowerFlex Array. We can Create, Update and Delete the volume using this resource. We can also import an existing volume from the PowerFlex array. > **Caution:** Volume creation or update is not atomic. In case of partially completed create operations, terraform can mark the resource as tainted. One can manually remove the taint and try applying the configuration (after making necessary adjustments). diff --git a/powerflex/provider/cluster_resource_schema.go b/powerflex/provider/cluster_resource_schema.go index 0dcc738f..a0e50910 100644 --- a/powerflex/provider/cluster_resource_schema.go +++ b/powerflex/provider/cluster_resource_schema.go @@ -30,8 +30,8 @@ import ( // ClusterReourceSchema defines the schema for cluster resource var ClusterReourceSchema schema.Schema = schema.Schema{ - Description: "This terraform resource is used to deploy PowerFlex Cluster. We can Create and Delete the PowerFlex Cluster using this resource. We can also Import an existing Cluster of PowerFlex.", - MarkdownDescription: "This terraform resource is used to deploy PowerFlex Cluster. We can Create and Delete the PowerFlex Cluster using this resource. We can also Import an existing Cluster of PowerFlex.", + Description: "This terraform resource is used to deploy the PowerFlex Cluster. We can Create and Delete the PowerFlex Cluster using this resource. We can also Import an existing Cluster of the PowerFlex.", + MarkdownDescription: "This terraform resource is used to deploy the PowerFlex Cluster. We can Create and Delete the PowerFlex Cluster using this resource. We can also Import an existing Cluster of the PowerFlex.", Attributes: ClusterResourceModelSchema(), } diff --git a/powerflex/provider/device_datasource_schema.go b/powerflex/provider/device_datasource_schema.go index 884eca1d..de1de74c 100644 --- a/powerflex/provider/device_datasource_schema.go +++ b/powerflex/provider/device_datasource_schema.go @@ -26,8 +26,8 @@ import ( // DeviceDataSourceSchema defines the schema for device datasource var DeviceDataSourceSchema schema.Schema = schema.Schema{ - Description: "This datasource is used to query the existing device from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", - MarkdownDescription: "This datasource is used to query the existing device from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + Description: "This datasource is used to query the existing device from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + MarkdownDescription: "This datasource is used to query the existing device from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "Unique identifier Of The Device Instance." + diff --git a/powerflex/provider/fault_set_datasource.go b/powerflex/provider/fault_set_datasource.go index f152b14a..ccee88af 100644 --- a/powerflex/provider/fault_set_datasource.go +++ b/powerflex/provider/fault_set_datasource.go @@ -200,8 +200,8 @@ func (d *faultSetDataSource) Read(ctx context.Context, req datasource.ReadReques // FaultSetDataSourceSchema defines the schema for Fault Set datasource var FaultSetDataSourceSchema schema.Schema = schema.Schema{ - Description: "This datasource is used to query the existing fault set from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", - MarkdownDescription: "This datasource is used to query the existing fault set from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + Description: "This datasource is used to query the existing fault set from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + MarkdownDescription: "This datasource is used to query the existing fault set from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "Placeholder attribute.", diff --git a/powerflex/provider/fault_set_resource_schema.go b/powerflex/provider/fault_set_resource_schema.go index fdc6b5a5..1dd0d6a1 100644 --- a/powerflex/provider/fault_set_resource_schema.go +++ b/powerflex/provider/fault_set_resource_schema.go @@ -25,8 +25,8 @@ import ( // FaultSetResourceSchema - variable holds schema for Fault set var FaultSetResourceSchema schema.Schema = schema.Schema{ - Description: "This resource is used to manage the Fault Set entity of PowerFlex Array. We can Create, Update and Delete the fault set using this resource. We can also import an existing fault set from PowerFlex array.", - MarkdownDescription: "This resource is used to manage the Fault Set entity of PowerFlex Array. We can Create, Update and Delete the fault set using this resource. We can also import an existing fault set from PowerFlex array.", + Description: "This resource is used to manage the Fault Set entity of the PowerFlex Array. We can Create, Update and Delete the fault set using this resource. We can also import an existing fault set from the PowerFlex array.", + MarkdownDescription: "This resource is used to manage the Fault Set entity of the PowerFlex Array. We can Create, Update and Delete the fault set using this resource. We can also import an existing fault set from the PowerFlex array.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "ID of the Fault Set", diff --git a/powerflex/provider/firmware_repository_datasource_schema.go b/powerflex/provider/firmware_repository_datasource_schema.go index 11396b52..3266024c 100644 --- a/powerflex/provider/firmware_repository_datasource_schema.go +++ b/powerflex/provider/firmware_repository_datasource_schema.go @@ -28,8 +28,8 @@ import ( // FirmwareRepositoryDataSourceSchema defines the schema for Firmware Repository datasource var FirmwareRepositoryDataSourceSchema schema.Schema = schema.Schema{ - Description: "This datasource is used to query the existing firmware repository from PowerFlex array. The information fetched from this datasource can be used for getting the necessary details regarding the bundles and their components in that firmware repository.", - MarkdownDescription: "This datasource is used to query the existing firmware repository from PowerFlex array. The information fetched from this datasource can be used for getting the necessary details regarding the bundles and their components in that firmware repository.", + Description: "This datasource is used to query the existing firmware repository from the PowerFlex array. The information fetched from this datasource can be used for getting the necessary details regarding the bundles and their components in that firmware repository.", + MarkdownDescription: "This datasource is used to query the existing firmware repository from the PowerFlex array. The information fetched from this datasource can be used for getting the necessary details regarding the bundles and their components in that firmware repository.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "Placeholder attribute.", diff --git a/powerflex/provider/firmware_repository_resource_schema.go b/powerflex/provider/firmware_repository_resource_schema.go index 2410245f..48b5ee69 100644 --- a/powerflex/provider/firmware_repository_resource_schema.go +++ b/powerflex/provider/firmware_repository_resource_schema.go @@ -29,8 +29,8 @@ import ( // FirmwareRepositoryResourceSchema - variable holds schema for Firmware Repository var FirmwareRepositoryResourceSchema schema.Schema = schema.Schema{ - Description: "This resource is used to manage the Firmware Repository entity of PowerFlex Array. We can Create and Update the firmware repository using this resource. As part of create operation, we can upload the compliance file and as part of update we can approve the unsigned files.We can also import an existing firmware repository from PowerFlex array.", - MarkdownDescription: "This resource is used to manage the Firmware Repository entity of PowerFlex Array. We can Create and Update the firmware repository using this resource. As part of create operation, we can upload the compliance file and as part of update we can approve the unsigned files.We can also import an existing firmware repository from PowerFlex array.", + Description: "This resource is used to manage the Firmware Repository entity of the PowerFlex Array. We can Create and Update the firmware repository using this resource. As part of create operation, we can upload the compliance file and as part of update we can approve the unsigned files.We can also import an existing firmware repository from the PowerFlex array.", + MarkdownDescription: "This resource is used to manage the Firmware Repository entity of the PowerFlex Array. We can Create and Update the firmware repository using this resource. As part of create operation, we can upload the compliance file and as part of update we can approve the unsigned files.We can also import an existing firmware repository from the PowerFlex array.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "ID of the Firmware Repository", diff --git a/powerflex/provider/mdm_cluster_resource.go b/powerflex/provider/mdm_cluster_resource.go index 662d2c8d..0d93e766 100644 --- a/powerflex/provider/mdm_cluster_resource.go +++ b/powerflex/provider/mdm_cluster_resource.go @@ -68,8 +68,8 @@ func (d *mdmClusterResource) Schema(_ context.Context, _ resource.SchemaRequest, // MdmClusterResourceSchema defines the schema for Mdm resource var MdmClusterResourceSchema schema.Schema = schema.Schema{ - Description: "This resource can be used to manage MDM cluster on a PowerFlex array. Supports adding or removing standby MDMs, migrate from 3-node to 5-node cluster or vice-versa, changing MDM ownership, changing performance profile, and renaming MDMs.", - MarkdownDescription: "This resource can be used to manage MDM cluster on a PowerFlex array. Supports adding or removing standby MDMs, migrate from 3-node to 5-node cluster or vice-versa, changing MDM ownership, changing performance profile, and renaming MDMs.", + Description: "This resource can be used to manage MDM cluster on the PowerFlex array. Supports adding or removing standby MDMs, migrate from 3-node to 5-node cluster or vice-versa, changing MDM ownership, changing performance profile, and renaming MDMs.", + MarkdownDescription: "This resource can be used to manage MDM cluster on the PowerFlex array. Supports adding or removing standby MDMs, migrate from 3-node to 5-node cluster or vice-versa, changing MDM ownership, changing performance profile, and renaming MDMs.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "Unique identifier of the MDM cluster.", diff --git a/powerflex/provider/node_datasource_schema.go b/powerflex/provider/node_datasource_schema.go index 8d75a967..df3c25f8 100644 --- a/powerflex/provider/node_datasource_schema.go +++ b/powerflex/provider/node_datasource_schema.go @@ -28,8 +28,8 @@ import ( // NodeDataSourceSchema defines the schema for node datasource var NodeDataSourceSchema schema.Schema = schema.Schema{ - Description: "This datasource is used to query the existing nodes from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", - MarkdownDescription: "This datasource is used to query the existing nodes from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + Description: "This datasource is used to query the existing nodes from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + MarkdownDescription: "This datasource is used to query the existing nodes from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "Placeholder attribute.", diff --git a/powerflex/provider/protection_domain_datasource_schema.go b/powerflex/provider/protection_domain_datasource_schema.go index ce6a1b83..0b92a328 100644 --- a/powerflex/provider/protection_domain_datasource_schema.go +++ b/powerflex/provider/protection_domain_datasource_schema.go @@ -26,8 +26,8 @@ import ( // ProtectionDomainDataSourceSchema defines the schema for Protection Domain datasource var ProtectionDomainDataSourceSchema schema.Schema = schema.Schema{ - Description: "This datasource is used to query the existing protection domain from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", - MarkdownDescription: "This datasource is used to query the existing protection domain from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + Description: "This datasource is used to query the existing protection domain from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + MarkdownDescription: "This datasource is used to query the existing protection domain from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "Unique identifier of the protection domain instance." + diff --git a/powerflex/provider/protection_domain_resource_schema.go b/powerflex/provider/protection_domain_resource_schema.go index 987b76b1..f76e1b81 100644 --- a/powerflex/provider/protection_domain_resource_schema.go +++ b/powerflex/provider/protection_domain_resource_schema.go @@ -18,6 +18,8 @@ limitations under the License. package provider import ( + "terraform-provider-powerflex/powerflex/helper" + types "github.com/dell/goscaleio/types/v1" "github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator" "github.com/hashicorp/terraform-plugin-framework/resource/schema" @@ -26,13 +28,12 @@ import ( "github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier" "github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier" "github.com/hashicorp/terraform-plugin-framework/schema/validator" - "terraform-provider-powerflex/powerflex/helper" ) // ProtectionDomainResourceSchema defines the schema for Protection Domain resource var ProtectionDomainResourceSchema schema.Schema = schema.Schema{ - Description: "This resource is used to manage the Protection Domain entity of PowerFlex Array. We can Create, Update and Delete the protection domain using this resource. We can also import an existing protection domain from PowerFlex array.", - MarkdownDescription: "This resource is used to manage the Protection Domain entity of PowerFlex Array. We can Create, Update and Delete the protection domain using this resource. We can also import an existing protection domain from PowerFlex array.", + Description: "This resource is used to manage the Protection Domain entity of the PowerFlex Array. We can Create, Update and Delete the protection domain using this resource. We can also import an existing protection domain from the PowerFlex array.", + MarkdownDescription: "This resource is used to manage the Protection Domain entity of the PowerFlex Array. We can Create, Update and Delete the protection domain using this resource. We can also import an existing protection domain from the PowerFlex array.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "Unique identifier of the protection domain instance.", diff --git a/powerflex/provider/resource_group_datasource_schema.go b/powerflex/provider/resource_group_datasource_schema.go index 03798944..88529a7d 100644 --- a/powerflex/provider/resource_group_datasource_schema.go +++ b/powerflex/provider/resource_group_datasource_schema.go @@ -28,8 +28,8 @@ import ( // ResourceGroupDataSourceSchema defines the schema for ResourceGroup datasource var ResourceGroupDataSourceSchema schema.Schema = schema.Schema{ - Description: "This datasource is used to query the existing ResourceGroup from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", - MarkdownDescription: "This datasource is used to query the existing ResourceGroup from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + Description: "This datasource is used to query the existing ResourceGroup from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + MarkdownDescription: "This datasource is used to query the existing ResourceGroup from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "Placeholder attribute.", diff --git a/powerflex/provider/resource_group_resource_schema.go b/powerflex/provider/resource_group_resource_schema.go index 11863743..3a945b8f 100644 --- a/powerflex/provider/resource_group_resource_schema.go +++ b/powerflex/provider/resource_group_resource_schema.go @@ -31,8 +31,8 @@ import ( // ResourceGroupReourceSchema - variable holds schema for ResourceGroup resource var ResourceGroupReourceSchema schema.Schema = schema.Schema{ - Description: "This resource is used to manage the ResourceGroup entity of PowerFlex Array. We can Create, Update and Delete the PowerFlex ResourceGroup using this resource. We can also Import an existing ResourceGroup from PowerFlex array.", - MarkdownDescription: "This resource is used to manage the ResourceGroup entity of PowerFlex Array. We can Create, Update and Delete the PowerFlex ResourceGroup using this resource. We can also Import an existing ResourceGroup from PowerFlex array.", + Description: "This resource is used to manage the ResourceGroup entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex ResourceGroup using this resource. We can also Import an existing ResourceGroup from the PowerFlex array.", + MarkdownDescription: "This resource is used to manage the ResourceGroup entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex ResourceGroup using this resource. We can also Import an existing ResourceGroup from the PowerFlex array.", Attributes: map[string]schema.Attribute{ "deployment_name": schema.StringAttribute{ Description: "Deployment Name", diff --git a/powerflex/provider/sdc_datasource_schema.go b/powerflex/provider/sdc_datasource_schema.go index 6093c349..7841c0df 100644 --- a/powerflex/provider/sdc_datasource_schema.go +++ b/powerflex/provider/sdc_datasource_schema.go @@ -28,8 +28,8 @@ import ( // SDCDataSourceScheme is variable for schematic for SDC Data Source var SDCDataSourceScheme schema.Schema = schema.Schema{ - Description: "This datasource is used to query the existing Storage Data Clients from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", - MarkdownDescription: "This datasource is used to query the existing Storage Data Clients from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + Description: "This datasource is used to query the existing Storage Data Clients from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + MarkdownDescription: "This datasource is used to query the existing Storage Data Clients from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "ID of the SDC to fetch." + diff --git a/powerflex/provider/sdc_host_resource.go b/powerflex/provider/sdc_host_resource.go index 899864d8..aace5049 100644 --- a/powerflex/provider/sdc_host_resource.go +++ b/powerflex/provider/sdc_host_resource.go @@ -109,8 +109,8 @@ func (r *sdcHostResource) ValidateConfig(ctx context.Context, req resource.Valid func (r *sdcHostResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - Description: "This resource is used to manage the SDC entity of PowerFlex Array. We can Create, Update and Delete the SDC using this resource. We can also import an existing SDC from PowerFlex array.", - MarkdownDescription: "This resource is used to manage the SDC entity of PowerFlex Array. We can Create, Update and Delete the SDC using this resource. We can also import an existing SDC from PowerFlex array.", + Description: "This resource is used to manage the SDC entity of the PowerFlex Array. We can Create, Update and Delete the SDC using this resource. We can also import an existing SDC from the PowerFlex array.", + MarkdownDescription: "This resource is used to manage the SDC entity of the PowerFlex Array. We can Create, Update and Delete the SDC using this resource. We can also import an existing SDC from the PowerFlex array.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "The id of the SDC", diff --git a/powerflex/provider/sdc_resource_schema.go b/powerflex/provider/sdc_resource_schema.go index 101e14b3..f9b78abf 100644 --- a/powerflex/provider/sdc_resource_schema.go +++ b/powerflex/provider/sdc_resource_schema.go @@ -32,8 +32,8 @@ import ( // SDCReourceSchema - varible holds schema for SDC resource var SDCReourceSchema schema.Schema = schema.Schema{ DeprecationMessage: "Use sdc_host instead", - Description: "This resource is used to manage the SDC entity of PowerFlex Array. We can Create, Update and Delete the PowerFlex SDC using this resource. We can also Import an existing SDC from PowerFlex array.", - MarkdownDescription: "This resource is used to manage the SDC entity of PowerFlex Array. We can Create, Update and Delete the PowerFlex SDC using this resource. We can also Import an existing SDC from PowerFlex array.", + Description: "This resource is used to manage the SDC entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex SDC using this resource. We can also Import an existing SDC from the PowerFlex array.", + MarkdownDescription: "This resource is used to manage the SDC entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex SDC using this resource. We can also Import an existing SDC from the PowerFlex array.", Attributes: map[string]schema.Attribute{ "sdc_details": sdcDetailSchema, "sdc_state_details": sdcStateDetailSchema, diff --git a/powerflex/provider/sdc_volumes_mapping_resource.go b/powerflex/provider/sdc_volumes_mapping_resource.go index 4a865d63..97a54aff 100644 --- a/powerflex/provider/sdc_volumes_mapping_resource.go +++ b/powerflex/provider/sdc_volumes_mapping_resource.go @@ -55,8 +55,8 @@ func (r *sdcVolumeMappingResource) Metadata(_ context.Context, req resource.Meta func (r *sdcVolumeMappingResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - Description: "This resource can be used to map/unmap volumes to an SDC on a PowerFlex array. User can import an existing SDC and map volumes to it.", - MarkdownDescription: "This resource can be used to map/unmap volumes to an SDC on a PowerFlex array. User can import an existing SDC and map volumes to it.", + Description: "This resource can be used to map/unmap volumes to an SDC on the PowerFlex array. User can import an existing SDC and map volumes to it.", + MarkdownDescription: "This resource can be used to map/unmap volumes to an SDC on the PowerFlex array. User can import an existing SDC and map volumes to it.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "The ID of the SDC.", diff --git a/powerflex/provider/sds_datasource_schema.go b/powerflex/provider/sds_datasource_schema.go index bf5d7cf6..8b42bf0d 100644 --- a/powerflex/provider/sds_datasource_schema.go +++ b/powerflex/provider/sds_datasource_schema.go @@ -28,8 +28,8 @@ import ( // SdsDataSourceSchema is the schema for reading the sds data var SdsDataSourceSchema schema.Schema = schema.Schema{ - Description: "This datasource is used to query the existing Storage Data Servers from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", - MarkdownDescription: "This datasource is used to query the existing Storage Data Servers from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + Description: "This datasource is used to query the existing Storage Data Servers from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + MarkdownDescription: "This datasource is used to query the existing Storage Data Servers from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "Placeholder identifier attribute.", diff --git a/powerflex/provider/sds_resource_schema.go b/powerflex/provider/sds_resource_schema.go index cdcb8282..3c16585f 100644 --- a/powerflex/provider/sds_resource_schema.go +++ b/powerflex/provider/sds_resource_schema.go @@ -30,8 +30,8 @@ import ( // SDSResourceSchema variable to define schema for the SDS resource var SDSResourceSchema schema.Schema = schema.Schema{ - Description: "This resource is used to manage the Storage Data Servers entity of PowerFlex Array. We can Create, Update and Delete the SDS using this resource. We can also import an existing SDS from PowerFlex array.", - MarkdownDescription: "This resource is used to manage the Storage Data Servers entity of PowerFlex Array. We can Create, Update and Delete the SDS using this resource. We can also import an existing SDS from PowerFlex array.", + Description: "This resource is used to manage the Storage Data Servers entity of the PowerFlex Array. We can Create, Update and Delete the SDS using this resource. We can also import an existing SDS from the PowerFlex array.", + MarkdownDescription: "This resource is used to manage the Storage Data Servers entity of the PowerFlex Array. We can Create, Update and Delete the SDS using this resource. We can also import an existing SDS from the PowerFlex array.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "The id of the SDS", diff --git a/powerflex/provider/service_datasource_schema.go b/powerflex/provider/service_datasource_schema.go index c9f2cecb..7c66dbc6 100644 --- a/powerflex/provider/service_datasource_schema.go +++ b/powerflex/provider/service_datasource_schema.go @@ -29,8 +29,8 @@ import ( // ServiceDataSourceSchema defines the schema for service datasource var ServiceDataSourceSchema schema.Schema = schema.Schema{ DeprecationMessage: "Use Resource Group Datasource instead", - Description: "This datasource is used to query the existing services from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", - MarkdownDescription: "This datasource is used to query the existing services from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + Description: "This datasource is used to query the existing services from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + MarkdownDescription: "This datasource is used to query the existing services from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "Placeholder attribute.", diff --git a/powerflex/provider/service_resource_schema.go b/powerflex/provider/service_resource_schema.go index 99436e1c..384ea1c6 100644 --- a/powerflex/provider/service_resource_schema.go +++ b/powerflex/provider/service_resource_schema.go @@ -32,8 +32,8 @@ import ( // ServiceReourceSchema - variable holds schema for Service resource var ServiceReourceSchema schema.Schema = schema.Schema{ DeprecationMessage: "Use Resource Group Resource instead", - Description: "This resource is used to manage the Service entity of PowerFlex Array. We can Create, Update and Delete the PowerFlex Service using this resource. We can also Import an existing Service from PowerFlex array.", - MarkdownDescription: "This resource is used to manage the Service entity of PowerFlex Array. We can Create, Update and Delete the PowerFlex Service using this resource. We can also Import an existing Service from PowerFlex array.", + Description: "This resource is used to manage the Service entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex Service using this resource. We can also Import an existing Service from the PowerFlex array.", + MarkdownDescription: "This resource is used to manage the Service entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex Service using this resource. We can also Import an existing Service from the PowerFlex array.", Attributes: map[string]schema.Attribute{ "deployment_name": schema.StringAttribute{ Description: "Deployment Name", diff --git a/powerflex/provider/snapshot_policy_schema.go b/powerflex/provider/snapshot_policy_schema.go index 64a478b7..6e3e8343 100644 --- a/powerflex/provider/snapshot_policy_schema.go +++ b/powerflex/provider/snapshot_policy_schema.go @@ -29,8 +29,8 @@ import ( // SnapshotPolicyResourceSchema - variable holds schema for Snapshot Policy var SnapshotPolicyResourceSchema schema.Schema = schema.Schema{ - Description: "This resource is used to manage the Snapshot Policy entity of PowerFlex Array. We can Create, Update and Delete the snapshot policy using this resource. We can also import an existing snapshot policy from PowerFlex array.", - MarkdownDescription: "This resource is used to manage the Snapshot Policy entity of PowerFlex Array. We can Create, Update and Delete the snapshot policy using this resource. We can also import an existing snapshot policy from PowerFlex array.", + Description: "This resource is used to manage the Snapshot Policy entity of the PowerFlex Array. We can Create, Update and Delete the snapshot policy using this resource. We can also import an existing snapshot policy from the PowerFlex array.", + MarkdownDescription: "This resource is used to manage the Snapshot Policy entity of the PowerFlex Array. We can Create, Update and Delete the snapshot policy using this resource. We can also import an existing snapshot policy from the PowerFlex array.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "ID of the Snapshot Policy.", diff --git a/powerflex/provider/snapshot_resource_schema.go b/powerflex/provider/snapshot_resource_schema.go index b3390aa4..1e1cc7ad 100644 --- a/powerflex/provider/snapshot_resource_schema.go +++ b/powerflex/provider/snapshot_resource_schema.go @@ -18,6 +18,8 @@ limitations under the License. package provider import ( + "terraform-provider-powerflex/powerflex/helper" + "github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator" "github.com/hashicorp/terraform-plugin-framework/path" "github.com/hashicorp/terraform-plugin-framework/resource/schema" @@ -25,13 +27,12 @@ import ( "github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier" "github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier" "github.com/hashicorp/terraform-plugin-framework/schema/validator" - "terraform-provider-powerflex/powerflex/helper" ) // SnapshotResourceSchema variable to define schema for the snapshot resource var SnapshotResourceSchema schema.Schema = schema.Schema{ - Description: "This resource is used to manage the Snapshot of volumes on PowerFlex Array. We can Create, Update and Delete the snapshots using this resource. We can also import an existing snapshot from PowerFlex array.", - MarkdownDescription: "This resource is used to manage the Snapshot of volumes on PowerFlex Array. We can Create, Update and Delete the snapshots using this resource. We can also import an existing snapshot from PowerFlex array.", + Description: "This resource is used to manage the Snapshot of volumes on the PowerFlex Array. We can Create, Update and Delete the snapshots using this resource. We can also import an existing snapshot from the PowerFlex array.", + MarkdownDescription: "This resource is used to manage the Snapshot of volumes on the PowerFlex Array. We can Create, Update and Delete the snapshots using this resource. We can also import an existing snapshot from the PowerFlex array.", Attributes: map[string]schema.Attribute{ "name": schema.StringAttribute{ Description: "The name of the snapshot.", diff --git a/powerflex/provider/snapshotpolicy_datasource_schema.go b/powerflex/provider/snapshotpolicy_datasource_schema.go index ddf176ab..0cac6713 100644 --- a/powerflex/provider/snapshotpolicy_datasource_schema.go +++ b/powerflex/provider/snapshotpolicy_datasource_schema.go @@ -27,8 +27,8 @@ import ( // SnapshotPolicyDataSourceSchema is the schema for reading the snapshot policy data var SnapshotPolicyDataSourceSchema schema.Schema = schema.Schema{ - Description: "This datasource is used to query the existing snapshot policies from PowerFlex array. The information fetched from this datasource can be used for getting the details.", - MarkdownDescription: "This datasource is used to query the existing snapshot policies from PowerFlex array. The information fetched from this datasource can be used for getting the details.", + Description: "This datasource is used to query the existing snapshot policies from the PowerFlex array. The information fetched from this datasource can be used for getting the details.", + MarkdownDescription: "This datasource is used to query the existing snapshot policies from the PowerFlex array. The information fetched from this datasource can be used for getting the details.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "Unique identifier of the snapshot policy instance to fetch." + diff --git a/powerflex/provider/storagepool_data_source_schema.go b/powerflex/provider/storagepool_data_source_schema.go index 05cf90d6..a7ebbab6 100644 --- a/powerflex/provider/storagepool_data_source_schema.go +++ b/powerflex/provider/storagepool_data_source_schema.go @@ -28,8 +28,8 @@ import ( // DataSourceSchema is the schema for reading the storage pool data var DataSourceSchema schema.Schema = schema.Schema{ - Description: "This datasource is used to query the existing storage pools from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", - MarkdownDescription: "This datasource is used to query the existing storage pools from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + Description: "This datasource is used to query the existing storage pools from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + MarkdownDescription: "This datasource is used to query the existing storage pools from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "Placeholder identifier attribute.", diff --git a/powerflex/provider/storagepool_resource_schema.go b/powerflex/provider/storagepool_resource_schema.go index 2687e362..77775cbc 100644 --- a/powerflex/provider/storagepool_resource_schema.go +++ b/powerflex/provider/storagepool_resource_schema.go @@ -27,8 +27,8 @@ import ( // StoragepoolReourceSchema - varible holds schema for Storagepool var StoragepoolReourceSchema schema.Schema = schema.Schema{ - Description: "This resource is used to manage the Storage Pool entity of PowerFlex Array. We can Create, Update and Delete the storage pool using this resource. We can also import an existing storage pool from PowerFlex array.", - MarkdownDescription: "This resource is used to manage the Storage Pool entity of PowerFlex Array. We can Create, Update and Delete the storage pool using this resource. We can also import an existing storage pool from PowerFlex array.", + Description: "This resource is used to manage the Storage Pool entity of the PowerFlex Array. We can Create, Update and Delete the storage pool using this resource. We can also import an existing storage pool from the PowerFlex array.", + MarkdownDescription: "This resource is used to manage the Storage Pool entity of the PowerFlex Array. We can Create, Update and Delete the storage pool using this resource. We can also import an existing storage pool from the PowerFlex array.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "ID of the Storage pool", diff --git a/powerflex/provider/system_resource.go b/powerflex/provider/system_resource.go index dbf44aa1..6ea83035 100644 --- a/powerflex/provider/system_resource.go +++ b/powerflex/provider/system_resource.go @@ -91,8 +91,8 @@ func (r *systemResource) Configure(_ context.Context, req resource.ConfigureRequ // SystemResourceSchema defines the schema for system resource var SystemResourceSchema schema.Schema = schema.Schema{ - Description: "This resource is used to manage the cluster level operations of PowerFlex Array. This resource supports Create, Update and Delete operations.", - MarkdownDescription: "This resource is used to manage the cluster level operations of PowerFlex Array. This resource supports Create, Update and Delete operations.", + Description: "This resource is used to manage the cluster level operations of the PowerFlex Array. This resource supports Create, Update and Delete operations.", + MarkdownDescription: "This resource is used to manage the cluster level operations of the PowerFlex Array. This resource supports Create, Update and Delete operations.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Computed: true, diff --git a/powerflex/provider/template_datasource_schema.go b/powerflex/provider/template_datasource_schema.go index 4dad401b..3800ae6b 100644 --- a/powerflex/provider/template_datasource_schema.go +++ b/powerflex/provider/template_datasource_schema.go @@ -28,8 +28,8 @@ import ( // TemplateDataSourceSchema defines the schema for template datasource var TemplateDataSourceSchema schema.Schema = schema.Schema{ - Description: "This datasource is used to query the existing templates from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", - MarkdownDescription: "This datasource is used to query the existing templates from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + Description: "This datasource is used to query the existing templates from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + MarkdownDescription: "This datasource is used to query the existing templates from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "Placeholder attribute.", diff --git a/powerflex/provider/user_resource.go b/powerflex/provider/user_resource.go index fe15c109..e4a43062 100644 --- a/powerflex/provider/user_resource.go +++ b/powerflex/provider/user_resource.go @@ -58,8 +58,8 @@ func (r *userResource) Metadata(_ context.Context, req resource.MetadataRequest, func (r *userResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{ - Description: "This resource is used to manage the User entity of PowerFlex Array. We can Create, Update and Delete the user using this resource. We can also import an existing user from PowerFlex array. However, password cannot be updated using this resource.", - MarkdownDescription: "This resource is used to manage the User entity of PowerFlex Array. We can Create, Update and Delete the user using this resource. We can also import an existing user from PowerFlex array. However, password cannot be updated using this resource.", + Description: "This resource is used to manage the User entity of the PowerFlex Array. We can Create, Update and Delete the user using this resource. We can also import an existing user from the PowerFlex array.", + MarkdownDescription: "This resource is used to manage the User entity of the PowerFlex Array. We can Create, Update and Delete the user using this resource. We can also import an existing user from the PowerFlex array.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "The ID of the user.", diff --git a/powerflex/provider/volume_datasource_schema.go b/powerflex/provider/volume_datasource_schema.go index 25657bde..3c98a5ea 100644 --- a/powerflex/provider/volume_datasource_schema.go +++ b/powerflex/provider/volume_datasource_schema.go @@ -26,8 +26,8 @@ import ( // VolumeDataSourceSchema is the schema for reading the volume data var VolumeDataSourceSchema schema.Schema = schema.Schema{ - Description: "This datasource is used to query the existing volume from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", - MarkdownDescription: "This datasource is used to query the existing volume from PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + Description: "This datasource is used to query the existing volume from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", + MarkdownDescription: "This datasource is used to query the existing volume from the PowerFlex array. The information fetched from this datasource can be used for getting the details / for further processing in resource block.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "Unique identifier of the volume instance." + diff --git a/powerflex/provider/volume_resource_schema.go b/powerflex/provider/volume_resource_schema.go index 992000e9..443a3dd7 100644 --- a/powerflex/provider/volume_resource_schema.go +++ b/powerflex/provider/volume_resource_schema.go @@ -31,8 +31,8 @@ import ( // VolumeResourceSchema variable to define schema for the volume resource var VolumeResourceSchema schema.Schema = schema.Schema{ - Description: "This resource is used to manage the Volume entity of PowerFlex Array. We can Create, Update and Delete the volume using this resource. We can also import an existing volume from PowerFlex array.", - MarkdownDescription: "This resource is used to manage the Volume entity of PowerFlex Array. We can Create, Update and Delete the volume using this resource. We can also import an existing volume from PowerFlex array.", + Description: "This resource is used to manage the Volume entity of the PowerFlex Array. We can Create, Update and Delete the volume using this resource. We can also import an existing volume from the PowerFlex array.", + MarkdownDescription: "This resource is used to manage the Volume entity of the PowerFlex Array. We can Create, Update and Delete the volume using this resource. We can also import an existing volume from the PowerFlex array.", Attributes: map[string]schema.Attribute{ "name": schema.StringAttribute{ Description: "The name of the volume.", diff --git a/powerflex/provider/vtree_datasource.go b/powerflex/provider/vtree_datasource.go index 24730db4..3ed6470b 100644 --- a/powerflex/provider/vtree_datasource.go +++ b/powerflex/provider/vtree_datasource.go @@ -159,8 +159,8 @@ func (d *vtreeDataSource) Read(ctx context.Context, req datasource.ReadRequest, // VTreeDataSourceSchema defines the schema for VTree data source var VTreeDataSourceSchema schema.Schema = schema.Schema{ - Description: "This datasource is used to query the existing vtrees from PowerFlex array. The information fetched from this datasource can be used for getting the details.", - MarkdownDescription: "This datasource is used to query the existing vtrees from PowerFlex array. The information fetched from this datasource can be used for getting the details.", + Description: "This datasource is used to query the existing vtrees from the PowerFlex array. The information fetched from this datasource can be used for getting the details.", + MarkdownDescription: "This datasource is used to query the existing vtrees from the PowerFlex array. The information fetched from this datasource can be used for getting the details.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "Placeholder identifier attribute.", diff --git a/templates/resources/cluster.md.tmpl b/templates/resources/cluster.md.tmpl index 6b26472c..a8a942cc 100644 --- a/templates/resources/cluster.md.tmpl +++ b/templates/resources/cluster.md.tmpl @@ -26,23 +26,25 @@ description: |- {{ .Description | trimspace }} -> **Note:** For PowerFlex 4.x, the PowerFlex Manager must be installed as a prerequisite. The required packages should be uploaded to the PowerFlex Manager. +**Please consider the following points before using cluster resource.** -> **Note:** For PowerFlex 3.x, a Gateway server is a prerequisite. The required packages should be uploaded to the gateway. The Package resource can be used for uploading packages to the gateway. +1. For PowerFlex 4.x, the PowerFlex Manager must be installed as a prerequisite. The required packages should be uploaded to the PowerFlex Manager. -> **Note:** Support is provided for creating, importing, and deleting operations for this resource. +2. For PowerFlex 3.x, a Gateway server is a prerequisite. The required packages should be uploaded to the gateway. The Package resource can be used for uploading packages to the gateway. -> **Note:** In multi-node cluster deployments, when some of the component installations fail, the partial deployment will not be rolled back. +3. Support is provided for creating, importing, and deleting operations for this resource. -> **Note:** If you've separately installed any SDR, SDS, or SDC and connected it to the cluster and if you face any security certificate issues during the destroy process, you'll have to manually accept the security certificate to resolve them. +4. In multi-node cluster deployments, when some of the component installations fail, the partial deployment will not be rolled back. -> **Note:** During the destroy process, the entire cluster will be destroyed, not just specific individual resources. After destroy need to follow cleanup process. +5. If you've separately installed any SDR, SDS, or SDC and connected it to the cluster and if you face any security certificate issues during the destroy process, you'll have to manually accept the security certificate to resolve them. -> **Note:** `ips` attribute is used in minimal csv configuration whereas `mdm_ips` attribute is used in complete csv configuration. +6. During the destroy process, the entire cluster will be destroyed, not just specific individual resources. After destroy need to follow cleanup process. -> **Note:** For PowerFlex 4.x, there's no need to mention `allow_non_secure_communication_with_lia`, `allow_non_secure_communication_with_mdm`, and `disable_non_mgmt_components_auth`. And, **Rfcache** is not supported. +7. `ips` attribute is used in minimal csv configuration whereas `mdm_ips` attribute is used in complete csv configuration. -> **Note:** To follow the installation process, you can refer to the [Deployment Guide 3.x](https://www.dell.com/support/manuals/en-us/scaleio/pfx_deploy_guide_3.6.x/deploy-powerflex?guid=guid-e9f70972-baac-42c9-9ff9-a3d2b0722f54&lang=en-us) & [Deployment Guide 4.x](https://www.dell.com/support/manuals/en-us/scaleio/powerflex_install_upgrade_guide_4.5.x/introduction?guid=guid-e798f431-7df4-450c-8f86-60ee7f3d1e3e&lang=en-us) +8. For PowerFlex 4.x, there's no need to mention `allow_non_secure_communication_with_lia`, `allow_non_secure_communication_with_mdm`, and `disable_non_mgmt_components_auth`. And, **Rfcache** is not supported. + +9. To follow the installation process, you can refer to the [Deployment Guide 3.x](https://www.dell.com/support/manuals/en-us/scaleio/pfx_deploy_guide_3.6.x/deploy-powerflex?guid=guid-e9f70972-baac-42c9-9ff9-a3d2b0722f54&lang=en-us) & [Deployment Guide 4.x](https://www.dell.com/support/manuals/en-us/scaleio/powerflex_install_upgrade_guide_4.5.x/introduction?guid=guid-e798f431-7df4-450c-8f86-60ee7f3d1e3e&lang=en-us) {{ if .HasExample -}} ## Example Usage diff --git a/templates/resources/sdc_host.md.tmpl b/templates/resources/sdc_host.md.tmpl index 13ddef6e..dad176a4 100644 --- a/templates/resources/sdc_host.md.tmpl +++ b/templates/resources/sdc_host.md.tmpl @@ -26,12 +26,12 @@ description: |- {{ .Description | trimspace }} -~> **Caution:** SDC Host creation is not atomic. This resource sets parameters like name, etc. after SDC installation is complete. +~> **Caution:** SDC Host creation is not atomic. This resource sets parameters like name, etc. after SDC installation is complete. If that fails for any reason, Terraform, by default, will mark this resource as tainted and recreate it on the next apply. But these issues (caused by invalid inputs, network disruptions, etc.) do not require resource recreation (ie. SDC re-installation) to resolve. If one untaints this resource manually (by running `terraform untaint `) prior to applying again, this resource can start from where it left off and, if the cause of failure has been rectified, it can take incremental actions to set the necessary SDC parameters. -So please untaint the resource before applying again if you want to prevent unnecessary SDC re-installations. +So please untaint the resource before applying again if you want to prevent unnecessary SDC re-installations. ## Example Usage