Skip to content

Commit fab8bba

Browse files
authored
Update Rep Docs (#250)
1 parent 228232d commit fab8bba

18 files changed

+40
-28
lines changed

docs/data-sources/peer_system.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ linkTitle: "powerflex_peer_system"
1919
page_title: "powerflex_peer_system Data Source - powerflex"
2020
subcategory: ""
2121
description: |-
22-
This datasource is used to read the Peer MDM entity of the PowerFlex Array.
22+
This datasource is used to read the Peer System entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.
2323
---
2424

2525
# powerflex_peer_system (Data Source)
2626

27-
This datasource is used to read the Peer MDM entity of the PowerFlex Array.
27+
This datasource is used to read the Peer System entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.
2828

2929
## Example Usage
3030

@@ -47,6 +47,7 @@ limitations under the License.
4747
*/
4848
4949
# commands to run this tf file : terraform init && terraform apply --auto-approve
50+
# This feature is only supported for PowerFlex 4.5 and above.
5051
5152
# Get all Peer System details present on the cluster
5253
data "powerflex_peer_system" "example1" {

docs/data-sources/replication_consistency_group.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ linkTitle: "powerflex_replication_consistency_group"
44
page_title: "powerflex_replication_consistency_group Data Source - powerflex"
55
subcategory: ""
66
description: |-
7-
This datasource is used to read the Replication Consistency Group entity of the PowerFlex Array.
7+
This datasource is used to read the Replication Consistency Group entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.
88
---
99

1010
# powerflex_replication_consistency_group (Data Source)
1111

12-
This datasource is used to read the Replication Consistency Group entity of the PowerFlex Array.
12+
This datasource is used to read the Replication Consistency Group entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.
1313

1414
## Example Usage
1515

@@ -28,6 +28,7 @@ limitations under the License.
2828
*/
2929
3030
# commands to run this tf file : terraform init && terraform apply
31+
# This feature is only supported for PowerFlex 4.5 and above.
3132
3233
// Empty filter block will return all the replication conistancy group
3334
data "powerflex_replication_consistency_group" "rcg" {}

docs/data-sources/replication_pair.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ linkTitle: "powerflex_replication_pair"
44
page_title: "powerflex_replication_pair Data Source - powerflex"
55
subcategory: ""
66
description: |-
7-
This datasource is used to read the Replication Pairs entity of the PowerFlex Array.
7+
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.
88
---
99

1010
# powerflex_replication_pair (Data Source)
1111

12-
This datasource is used to read the Replication Pairs entity of the PowerFlex Array.
12+
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.
1313

1414
## Example Usage
1515

@@ -32,6 +32,7 @@ limitations under the License.
3232
*/
3333
3434
# commands to run this tf file : terraform init && terraform apply
35+
# This feature is only supported for PowerFlex 4.5 and above.
3536
3637
// Empty filter block will return all the replication pairs
3738
data "powerflex_replication_pair" "rp" {}

docs/resources/peer_system.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ linkTitle: "powerflex_peer_system"
33
page_title: "powerflex_peer_system Resource - powerflex"
44
subcategory: ""
55
description: |-
6-
This resource is used to manage the Peer System entity of the PowerFlex Array. 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.
6+
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.
77
---
88

99
# powerflex_peer_system (Resource)
1010

11-
This resource is used to manage the Peer System entity of the PowerFlex Array. 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.
11+
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.
1212

1313
## Example Usage
1414

@@ -70,6 +70,9 @@ data "powerflex_protection_domain" "protection_domain_system_1" {
7070
7171
resource "powerflex_peer_system" "system_1" {
7272
provider = powerflex.system_1
73+
74+
// This should be done in order to avoid a confict while sshing
75+
depends_on = [ resource.powerflex_peer_system.system_1 ]
7376
### Required Values
7477
7578
# New name of the Peer System

docs/resources/replication_consistency_group.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ linkTitle: "powerflex_replication_consistency_group"
33
page_title: "powerflex_replication_consistency_group Resource - powerflex"
44
subcategory: ""
55
description: |-
6-
This resource is used to manage the Replication Consistency Group entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex Replication Consistency Group using this resource. We can also Import an existing Replication Consistency Group from the PowerFlex array.
6+
This resource is used to manage the Replication Consistency Group 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 Consistency Group using this resource. We can also Import an existing Replication Consistency Group from the PowerFlex array.
77
---
88

99
# powerflex_replication_consistency_group (Resource)
1010

11-
This resource is used to manage the Replication Consistency Group entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex Replication Consistency Group using this resource. We can also Import an existing Replication Consistency Group from the PowerFlex array.
11+
This resource is used to manage the Replication Consistency Group 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 Consistency Group using this resource. We can also Import an existing Replication Consistency Group from the PowerFlex array.
1212

1313
## Example Usage
1414

docs/resources/replication_consistency_group_action.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ linkTitle: "powerflex_replication_consistency_group_action"
33
page_title: "powerflex_replication_consistency_group_action Resource - powerflex"
44
subcategory: ""
55
description: |-
6-
This resource is used to execute actions on the Replication Consistency Group entity of the PowerFlex Array.
6+
This resource is used to execute actions on the Replication Consistency Group entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.
77
---
88

99
# powerflex_replication_consistency_group_action (Resource)
1010

11-
This resource is used to execute actions on the Replication Consistency Group entity of the PowerFlex Array.
11+
This resource is used to execute actions on the Replication Consistency Group entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.
1212

1313
## Example Usage
1414

docs/resources/replication_pair.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ linkTitle: "powerflex_replication_pair"
33
page_title: "powerflex_replication_pair Resource - powerflex"
44
subcategory: ""
55
description: |-
6-
This resource is used to manage the Replication Pairs entity of the PowerFlex Array. 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.
6+
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.
77
---
88

99
# powerflex_replication_pair (Resource)
1010

11-
This resource is used to manage the Replication Pairs entity of the PowerFlex Array. 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.
11+
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.
1212

1313
## Example Usage
1414

examples/data-sources/powerflex_peer_system/data-source.tf

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ limitations under the License.
1616
*/
1717

1818
# commands to run this tf file : terraform init && terraform apply --auto-approve
19+
# This feature is only supported for PowerFlex 4.5 and above.
1920

2021
# Get all Peer System details present on the cluster
2122
data "powerflex_peer_system" "example1" {

examples/data-sources/powerflex_replication_consistency_group/data-source.tf

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ limitations under the License.
1212
*/
1313

1414
# commands to run this tf file : terraform init && terraform apply
15+
# This feature is only supported for PowerFlex 4.5 and above.
1516

1617
// Empty filter block will return all the replication conistancy group
1718
data "powerflex_replication_consistency_group" "rcg" {}

examples/data-sources/powerflex_replication_pair/data-source.tf

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ limitations under the License.
1616
*/
1717

1818
# commands to run this tf file : terraform init && terraform apply
19+
# This feature is only supported for PowerFlex 4.5 and above.
1920

2021
// Empty filter block will return all the replication pairs
2122
data "powerflex_replication_pair" "rp" {}

examples/resources/powerflex_peer_system/resource.tf

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ data "powerflex_protection_domain" "protection_domain_system_1" {
5555

5656
resource "powerflex_peer_system" "system_1" {
5757
provider = powerflex.system_1
58+
59+
// This should be done in order to avoid a confict while sshing
60+
depends_on = [ resource.powerflex_peer_system.system_1 ]
5861
### Required Values
5962

6063
# New name of the Peer System

powerflex/provider/peer_system_datasource_schema.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ import (
2626

2727
// PeerMdmDataSourceSchema defines the schema for PeerMdm datasource
2828
var PeerMdmDataSourceSchema schema.Schema = schema.Schema{
29-
Description: "This datasource is used to read the Peer MDM entity of the PowerFlex Array.",
30-
MarkdownDescription: "This datasource is used to read the Peer MDM entity of the PowerFlex Array.",
29+
Description: "This datasource is used to read the Peer System entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.",
30+
MarkdownDescription: "This datasource is used to read the Peer System entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.",
3131
Attributes: map[string]schema.Attribute{
3232
"id": schema.StringAttribute{
3333
Description: "default datasource id",

powerflex/provider/peer_system_resource_schema.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ import (
3030

3131
// PeerSystemReourceSchema - variable holds schema for PeerSystemReource resource
3232
var PeerSystemReourceSchema schema.Schema = schema.Schema{
33-
Description: "This resource is used to manage the Peer System entity of the PowerFlex Array. 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.",
34-
MarkdownDescription: "This resource is used to manage the Peer System entity of the PowerFlex Array. 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.",
33+
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.",
34+
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.",
3535
Attributes: map[string]schema.Attribute{
3636
"name": schema.StringAttribute{
3737
Description: "Name of the peer mdm instance.",

powerflex/provider/replication_consistency_group_action_resource_schema.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ import (
2828

2929
// ReplicationConsistencyGroupActionReourceSchema - variable holds schema for ReplicationConsistencyGroupAction resource
3030
var ReplicationConsistencyGroupActionReourceSchema schema.Schema = schema.Schema{
31-
Description: "This resource is used to execute actions on the Replication Consistency Group entity of the PowerFlex Array.",
32-
MarkdownDescription: "This resource is used to execute actions on the Replication Consistency Group entity of the PowerFlex Array.",
31+
Description: "This resource is used to execute actions on the Replication Consistency Group entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.",
32+
MarkdownDescription: "This resource is used to execute actions on the Replication Consistency Group entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.",
3333
Attributes: map[string]schema.Attribute{
3434
"id": schema.StringAttribute{
3535
Description: "Replication Consistency Group ID",

powerflex/provider/replication_consistency_group_datasource_schema.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ import (
2626

2727
// ReplicationConsistencyGroupDataSourceSchema defines the schema for RCG datasource
2828
var ReplicationConsistencyGroupDataSourceSchema schema.Schema = schema.Schema{
29-
Description: "This datasource is used to read the Replication Consistency Group entity of the PowerFlex Array.",
30-
MarkdownDescription: "This datasource is used to read the Replication Consistency Group entity of the PowerFlex Array.",
29+
Description: "This datasource is used to read the Replication Consistency Group entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.",
30+
MarkdownDescription: "This datasource is used to read the Replication Consistency Group entity of the PowerFlex Array. This feature is only supported for PowerFlex 4.5 and above.",
3131
Attributes: map[string]schema.Attribute{
3232
"id": schema.StringAttribute{
3333
Description: "default datasource id",

powerflex/provider/replication_consistency_group_resource_schema.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ import (
2828

2929
// ReplicationConsistencyGroupReourceSchema - variable holds schema for ReplicationConsistencyGroup resource
3030
var ReplicationConsistencyGroupReourceSchema schema.Schema = schema.Schema{
31-
Description: "This resource is used to manage the Replication Consistency Group entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex Replication Consistency Group using this resource. We can also Import an existing Replication Consistency Group from the PowerFlex array.",
32-
MarkdownDescription: "This resource is used to manage the Replication Consistency Group entity of the PowerFlex Array. We can Create, Update and Delete the PowerFlex Replication Consistency Group using this resource. We can also Import an existing Replication Consistency Group from the PowerFlex array.",
31+
Description: "This resource is used to manage the Replication Consistency Group 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 Consistency Group using this resource. We can also Import an existing Replication Consistency Group from the PowerFlex array.",
32+
MarkdownDescription: "This resource is used to manage the Replication Consistency Group 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 Consistency Group using this resource. We can also Import an existing Replication Consistency Group from the PowerFlex array.",
3333
Attributes: map[string]schema.Attribute{
3434
"protection_domain_id": schema.StringAttribute{
3535
Description: "Replication Consistency Group Protection Domain ID",

powerflex/provider/replication_pair_datasource_schema.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ import (
2626

2727
// ReplicationPairsDataSourceSchema defines the schema for ReplicationPairs datasource
2828
var ReplicationPairsDataSourceSchema schema.Schema = schema.Schema{
29-
Description: "This datasource is used to read the Replication Pairs entity of the PowerFlex Array.",
30-
MarkdownDescription: "This datasource is used to read the Replication Pairs entity of the PowerFlex Array.",
29+
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.",
30+
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.",
3131
Attributes: map[string]schema.Attribute{
3232
"id": schema.StringAttribute{
3333
Description: "default datasource id",

powerflex/provider/replication_pair_resource_schema.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ import (
2424

2525
// ReplicationPairReourceSchema - variable holds schema for ReplicationPair resource
2626
var ReplicationPairReourceSchema schema.Schema = schema.Schema{
27-
Description: "This resource is used to manage the Replication Pairs entity of the PowerFlex Array. 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.",
28-
MarkdownDescription: "This resource is used to manage the Replication Pairs entity of the PowerFlex Array. 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.",
27+
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.",
28+
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.",
2929
Attributes: map[string]schema.Attribute{
3030
"name": schema.StringAttribute{
3131
Description: "Replication Pair Name",

0 commit comments

Comments
 (0)