Skip to content

Commit

Permalink
Update Replication Docs (#256)
Browse files Browse the repository at this point in the history
doriac11 authored Dec 5, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent fab8bba commit 8b4287c
Showing 11 changed files with 28 additions and 18 deletions.
4 changes: 2 additions & 2 deletions docs/data-sources/replication_pair.md
Original file line number Diff line number Diff line change
@@ -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

7 changes: 4 additions & 3 deletions docs/resources/peer_system.md
Original file line number Diff line number Diff line change
@@ -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 generated by tfplugindocs -->
## Schema
4 changes: 3 additions & 1 deletion docs/resources/replication_consistency_group.md
Original file line number Diff line number Diff line change
@@ -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 generated by tfplugindocs -->
## Schema
4 changes: 3 additions & 1 deletion docs/resources/replication_consistency_group_action.md
Original file line number Diff line number Diff line change
@@ -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 generated by tfplugindocs -->
## Schema
4 changes: 2 additions & 2 deletions docs/resources/replication_pair.md
Original file line number Diff line number Diff line change
@@ -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

4 changes: 2 additions & 2 deletions powerflex/provider/peer_system_resource_schema.go
Original file line number Diff line number Diff line change
@@ -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.",
4 changes: 2 additions & 2 deletions powerflex/provider/replication_pair_datasource_schema.go
Original file line number Diff line number Diff line change
@@ -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",
4 changes: 2 additions & 2 deletions powerflex/provider/replication_pair_resource_schema.go
Original file line number Diff line number Diff line change
@@ -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",
3 changes: 2 additions & 1 deletion templates/resources/peer_system.md.tmpl
Original file line number Diff line number Diff line change
@@ -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 }}

4 changes: 3 additions & 1 deletion templates/resources/replication_consistency_group.md.tmpl
Original file line number Diff line number Diff line change
@@ -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 }}

Original file line number Diff line number Diff line change
@@ -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 }}

0 comments on commit 8b4287c

Please sign in to comment.