From 8b4287c2e769b05fb5bee55980aed8d0e4ff600a Mon Sep 17 00:00:00 2001 From: Connor Doria <128822122+doriac11@users.noreply.github.com> Date: Thu, 5 Dec 2024 11:06:27 -0500 Subject: [PATCH] Update Replication Docs (#256) --- docs/data-sources/replication_pair.md | 4 ++-- docs/resources/peer_system.md | 7 ++++--- docs/resources/replication_consistency_group.md | 4 +++- docs/resources/replication_consistency_group_action.md | 4 +++- docs/resources/replication_pair.md | 4 ++-- powerflex/provider/peer_system_resource_schema.go | 4 ++-- powerflex/provider/replication_pair_datasource_schema.go | 4 ++-- powerflex/provider/replication_pair_resource_schema.go | 4 ++-- templates/resources/peer_system.md.tmpl | 3 ++- templates/resources/replication_consistency_group.md.tmpl | 4 +++- .../resources/replication_consistency_group_action.md.tmpl | 4 +++- 11 files changed, 28 insertions(+), 18 deletions(-) diff --git a/docs/data-sources/replication_pair.md b/docs/data-sources/replication_pair.md index c87df72a..f12d0901 100644 --- a/docs/data-sources/replication_pair.md +++ b/docs/data-sources/replication_pair.md @@ -4,12 +4,12 @@ linkTitle: "powerflex_replication_pair" page_title: "powerflex_replication_pair Data Source - powerflex" subcategory: "" description: |- - This datasource is used to read the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. + This datasource is used to read the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. An RCG is a collection of multiple replication pairs that need to be replicated together in a coordinated and consistent manner. The key purpose is to ensure that all the data within the group is replicated in a consistent state. Applies to a group of data that needs to be kept consistent across the source and target --- # powerflex_replication_pair (Data Source) -This datasource is used to read the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. +This datasource is used to read the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. An RCG is a collection of multiple replication pairs that need to be replicated together in a coordinated and consistent manner. The key purpose is to ensure that all the data within the group is replicated in a consistent state. Applies to a group of data that needs to be kept consistent across the source and target ## Example Usage diff --git a/docs/resources/peer_system.md b/docs/resources/peer_system.md index beb0a27a..ffa4716a 100644 --- a/docs/resources/peer_system.md +++ b/docs/resources/peer_system.md @@ -3,12 +3,12 @@ linkTitle: "powerflex_peer_system" page_title: "powerflex_peer_system Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the Peer System entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Peer Systems using this resource. We can also Import an existing Peer Systems from the PowerFlex array. + This resource is used to manage the Peer System entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Peer Systems using this resource. We can also Import an existing Peer Systems from the PowerFlex array. Peer system refers to the setup where multiple MDM nodes work together as peers to provide redundancy and high availability. This means that if one MDM node fails, other peer MDM nodes can take over its responsibilities, ensuring continuous operation without disruptions --- # powerflex_peer_system (Resource) -This resource is used to manage the Peer System entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Peer Systems using this resource. We can also Import an existing Peer Systems from the PowerFlex array. +This resource is used to manage the Peer System entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Peer Systems using this resource. We can also Import an existing Peer Systems from the PowerFlex array. Peer system refers to the setup where multiple MDM nodes work together as peers to provide redundancy and high availability. This means that if one MDM node fails, other peer MDM nodes can take over its responsibilities, ensuring continuous operation without disruptions ## Example Usage @@ -168,7 +168,8 @@ resource "powerflex_peer_system" "system_2" { } ``` -After the execution of above resource block, resource would have been created on the PowerFlex array. For more information, please check the terraform state file. +After the execution of above resource block, the two PowerFlex Peer Systems will be connected. The user can then setup Replication Groups and Pairs in order to replicate volumes across powerflex systems. +For more information, please check the terraform state file. ## Schema diff --git a/docs/resources/replication_consistency_group.md b/docs/resources/replication_consistency_group.md index a23a6a0c..5c594ec6 100644 --- a/docs/resources/replication_consistency_group.md +++ b/docs/resources/replication_consistency_group.md @@ -97,7 +97,9 @@ resource "powerflex_replication_consistency_group" "example" { } ``` -After the execution of above resource block, resource would have been created on the PowerFlex array. For more information, please check the terraform state file. +After the execution of above resource block, the Replication Consistency Group will be created between the two Peer Systems. +The user can then add Replication Pairs to the RCGs in order to replicate volumes between systems. +For more information, please check the terraform state file. ## Schema diff --git a/docs/resources/replication_consistency_group_action.md b/docs/resources/replication_consistency_group_action.md index 3e3f315f..f9e188c7 100644 --- a/docs/resources/replication_consistency_group_action.md +++ b/docs/resources/replication_consistency_group_action.md @@ -76,7 +76,9 @@ resource "powerflex_replication_consistency_group_action" "example" { } ``` -After the execution of above resource block, resource would have been created on the PowerFlex array. For more information, please check the terraform state file. +After the execution of above resource block, The selected Action will be preformed on the selected RCG. +Each time the RCG Actions resource is run it will preform the action again. +For more information, please check the terraform state file. ## Schema diff --git a/docs/resources/replication_pair.md b/docs/resources/replication_pair.md index 7dece98f..3e3b1e0c 100644 --- a/docs/resources/replication_pair.md +++ b/docs/resources/replication_pair.md @@ -3,12 +3,12 @@ linkTitle: "powerflex_replication_pair" page_title: "powerflex_replication_pair Resource - powerflex" subcategory: "" description: |- - This resource is used to manage the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Replication Pairs using this resource. We can also Import an existing Replication Pairs from the PowerFlex array. + This resource is used to manage the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Replication Pairs using this resource. We can also Import an existing Replication Pairs from the PowerFlex array. A replication pair involves a set of data on a source system being continuously copied to a target system. This typically applies to individual volumes, files, or objects. --- # powerflex_replication_pair (Resource) -This resource is used to manage the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Replication Pairs using this resource. We can also Import an existing Replication Pairs from the PowerFlex array. +This resource is used to manage the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Replication Pairs using this resource. We can also Import an existing Replication Pairs from the PowerFlex array. A replication pair involves a set of data on a source system being continuously copied to a target system. This typically applies to individual volumes, files, or objects. ## Example Usage diff --git a/powerflex/provider/peer_system_resource_schema.go b/powerflex/provider/peer_system_resource_schema.go index 69deac46..0b413d07 100644 --- a/powerflex/provider/peer_system_resource_schema.go +++ b/powerflex/provider/peer_system_resource_schema.go @@ -30,8 +30,8 @@ import ( // PeerSystemReourceSchema - variable holds schema for PeerSystemReource resource var PeerSystemReourceSchema schema.Schema = schema.Schema{ - Description: "This resource is used to manage the Peer System entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Peer Systems using this resource. We can also Import an existing Peer Systems from the PowerFlex array.", - MarkdownDescription: "This resource is used to manage the Peer System entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Peer Systems using this resource. We can also Import an existing Peer Systems from the PowerFlex array.", + Description: "This resource is used to manage the Peer System entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Peer Systems using this resource. We can also Import an existing Peer Systems from the PowerFlex array. Peer system refers to the setup where multiple MDM nodes work together as peers to provide redundancy and high availability. This means that if one MDM node fails, other peer MDM nodes can take over its responsibilities, ensuring continuous operation without disruptions", + MarkdownDescription: "This resource is used to manage the Peer System entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Peer Systems using this resource. We can also Import an existing Peer Systems from the PowerFlex array. Peer system refers to the setup where multiple MDM nodes work together as peers to provide redundancy and high availability. This means that if one MDM node fails, other peer MDM nodes can take over its responsibilities, ensuring continuous operation without disruptions", Attributes: map[string]schema.Attribute{ "name": schema.StringAttribute{ Description: "Name of the peer mdm instance.", diff --git a/powerflex/provider/replication_pair_datasource_schema.go b/powerflex/provider/replication_pair_datasource_schema.go index 5a437767..a0c636bb 100644 --- a/powerflex/provider/replication_pair_datasource_schema.go +++ b/powerflex/provider/replication_pair_datasource_schema.go @@ -26,8 +26,8 @@ import ( // ReplicationPairsDataSourceSchema defines the schema for ReplicationPairs datasource var ReplicationPairsDataSourceSchema schema.Schema = schema.Schema{ - Description: "This datasource is used to read the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.", - MarkdownDescription: "This datasource is used to read the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.", + Description: "This datasource is used to read the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. An RCG is a collection of multiple replication pairs that need to be replicated together in a coordinated and consistent manner. The key purpose is to ensure that all the data within the group is replicated in a consistent state. Applies to a group of data that needs to be kept consistent across the source and target", + MarkdownDescription: "This datasource is used to read the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. An RCG is a collection of multiple replication pairs that need to be replicated together in a coordinated and consistent manner. The key purpose is to ensure that all the data within the group is replicated in a consistent state. Applies to a group of data that needs to be kept consistent across the source and target", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ Description: "default datasource id", diff --git a/powerflex/provider/replication_pair_resource_schema.go b/powerflex/provider/replication_pair_resource_schema.go index 0b66a993..1a754e15 100644 --- a/powerflex/provider/replication_pair_resource_schema.go +++ b/powerflex/provider/replication_pair_resource_schema.go @@ -24,8 +24,8 @@ import ( // ReplicationPairReourceSchema - variable holds schema for ReplicationPair resource var ReplicationPairReourceSchema schema.Schema = schema.Schema{ - Description: "This resource is used to manage the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Replication Pairs using this resource. We can also Import an existing Replication Pairs from the PowerFlex array.", - MarkdownDescription: "This resource is used to manage the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Replication Pairs using this resource. We can also Import an existing Replication Pairs from the PowerFlex array.", + Description: "This resource is used to manage the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Replication Pairs using this resource. We can also Import an existing Replication Pairs from the PowerFlex array. A replication pair involves a set of data on a source system being continuously copied to a target system. This typically applies to individual volumes, files, or objects.", + MarkdownDescription: "This resource is used to manage the Replication Pairs entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above. We can Create, Update and Delete the PowerFlex Replication Pairs using this resource. We can also Import an existing Replication Pairs from the PowerFlex array. A replication pair involves a set of data on a source system being continuously copied to a target system. This typically applies to individual volumes, files, or objects.", Attributes: map[string]schema.Attribute{ "name": schema.StringAttribute{ Description: "Replication Pair Name", diff --git a/templates/resources/peer_system.md.tmpl b/templates/resources/peer_system.md.tmpl index 3b046568..6533876c 100644 --- a/templates/resources/peer_system.md.tmpl +++ b/templates/resources/peer_system.md.tmpl @@ -16,7 +16,8 @@ description: |- {{tffile .ExampleFile }} {{- end }} -After the execution of above resource block, resource would have been created on the PowerFlex array. For more information, please check the terraform state file. +After the execution of above resource block, the two PowerFlex Peer Systems will be connected. The user can then setup Replication Groups and Pairs in order to replicate volumes across powerflex systems. +For more information, please check the terraform state file. {{ .SchemaMarkdown | trimspace }} diff --git a/templates/resources/replication_consistency_group.md.tmpl b/templates/resources/replication_consistency_group.md.tmpl index 3b046568..f20eb1c9 100644 --- a/templates/resources/replication_consistency_group.md.tmpl +++ b/templates/resources/replication_consistency_group.md.tmpl @@ -16,7 +16,9 @@ description: |- {{tffile .ExampleFile }} {{- end }} -After the execution of above resource block, resource would have been created on the PowerFlex array. For more information, please check the terraform state file. +After the execution of above resource block, the Replication Consistency Group will be created between the two Peer Systems. +The user can then add Replication Pairs to the RCGs in order to replicate volumes between systems. +For more information, please check the terraform state file. {{ .SchemaMarkdown | trimspace }} diff --git a/templates/resources/replication_consistency_group_action.md.tmpl b/templates/resources/replication_consistency_group_action.md.tmpl index 2e3ea845..4bf9be01 100644 --- a/templates/resources/replication_consistency_group_action.md.tmpl +++ b/templates/resources/replication_consistency_group_action.md.tmpl @@ -16,6 +16,8 @@ description: |- {{tffile .ExampleFile }} {{- end }} -After the execution of above resource block, resource would have been created on the PowerFlex array. For more information, please check the terraform state file. +After the execution of above resource block, The selected Action will be preformed on the selected RCG. +Each time the RCG Actions resource is run it will preform the action again. +For more information, please check the terraform state file. {{ .SchemaMarkdown | trimspace }}