Merge pull request #126 from dell/replication_rule_datasource

adding replication rule datasource

Makefile

@@ -3,7 +3,7 @@ HOSTNAME=registry.terraform.io
 NAMESPACE=dell
 NAME=powerstore
 BINARY=terraform-provider-${NAME}
-VERSION=1.1.0
+VERSION=1.2.0
 OS_ARCH=linux_amd64
 
 default: install

docs/data-sources/replication_rule.md

@@ -0,0 +1,127 @@
+---
+# Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.
+# 
+# Licensed under the Mozilla Public License Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://mozilla.org/MPL/2.0/
+# 
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+title: "powerstore_replication_rule data source"
+linkTitle: "powerstore_replication_rule"
+page_title: "powerstore_replication_rule Data Source - powerstore"
+subcategory: ""
+description: |-
+  This datasource is used to query the existing replication rule from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.
+---
+
+# powerstore_replication_rule (Data Source)
+
+This datasource is used to query the existing replication rule from PowerStore 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` or `id` can be provided at a time.
+
+## Example Usage
+
+```terraform
+/*
+Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.
+
+Licensed under the Mozilla Public License Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://mozilla.org/MPL/2.0/
+
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+# commands to run this tf file : terraform init && terraform apply --auto-approve
+# This datasource reads replication rules either by id or name where user can provide a value to any one of them
+# If it is a empty datsource block , then it will read all the replication rules
+# If id or name is provided then it reads a particular replication rule with that id or name
+# Only one of the attribute can be provided among id and  name 
+
+# Get replication rule details using name
+data "powerstore_replication_rule" "test" {
+  depends_on = [powerstore_replication_rule.test]
+  name       = "terraform_replication_rule"
+}
+
+# Get replication rule details using ID
+data "powerstore_replication_rule" "test" {
+  id = "2d0780e3-2ce7-4d8b-b2ec-349c5e9e26a9"
+}
+
+output "replicationRule" {
+  value = data.powerstore_replication_rule.test.replication_rules
+}
+```
+After the successful execution of above said block, We can see the output by executing `terraform output` command. Also, we can fetch information via the variable: `data.powerstore_snapshotrule.test1.attribute_name` where attribute_name is the attribute which user wants to fetch.
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `id` (String) Unique identifier of the replication rule. Conflicts with `name`.
+- `name` (String) Name of the replication rule. Conflicts with `id`.
+
+### Read-Only
+
+- `replication_rules` (Attributes List) List of replication rules. (see [below for nested schema](#nestedatt--replication_rules))
+
+<a id="nestedatt--replication_rules"></a>
+### Nested Schema for `replication_rules`
+
+Read-Only:
+
+- `alert_threshold` (Number) The alert threshold for the replication rule.
+- `id` (String) Unique identifier of the replication rule.
+- `is_read_only` (Boolean) Indicates whether the replication rule is read-only.
+- `is_replica` (Boolean) Indicates whether the replication rule is a replica.
+- `managed_by` (String) The entity that manages the replication rule.
+- `managed_by_id` (String) The ID of the managing entity.
+- `name` (String) Name of the replication rule.
+- `policies` (Attributes List) The protection policies associated with the replication rule. (see [below for nested schema](#nestedatt--replication_rules--policies))
+- `remote_system` (Attributes) The remote system associated with the replication rule. (see [below for nested schema](#nestedatt--replication_rules--remote_system))
+- `remote_system_id` (String) The ID of the remote system associated with the replication rule.
+- `replication_sessions` (Attributes List) The replication session associated with the replication rule. (see [below for nested schema](#nestedatt--replication_rules--replication_sessions))
+- `rpo` (String) The RPO (Recovery Point Objective) of the replication rule.
+
+<a id="nestedatt--replication_rules--policies"></a>
+### Nested Schema for `replication_rules.policies`
+
+Read-Only:
+
+- `id` (String) The ID of the protection policy.
+- `name` (String) The name of the protection policy.
+
+
+<a id="nestedatt--replication_rules--remote_system"></a>
+### Nested Schema for `replication_rules.remote_system`
+
+Read-Only:
+
+- `id` (String) The ID of the remote system.
+- `name` (String) The name of the remote system.
+
+
+<a id="nestedatt--replication_rules--replication_sessions"></a>
+### Nested Schema for `replication_rules.replication_sessions`
+
+Read-Only:
+
+- `id` (String) The ID of the replication session.
+- `state` (String) The state of the replication session.

docs/resources/replication_rule.md

@@ -61,7 +61,7 @@ resource "powerstore_replication_rule" "test" {
 }
 
 //Below example is for import operation
-/*resource "powerstore_snapshotrule" "terraform-provider-test-import" {
+/*resource "powerstore_replication_rule" "terraform-provider-test-import" {
 }*/
 ```
 

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

@@ -0,0 +1,37 @@
+/*
+Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.
+
+Licensed under the Mozilla Public License Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://mozilla.org/MPL/2.0/
+
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+# commands to run this tf file : terraform init && terraform apply --auto-approve
+# This datasource reads replication rules either by id or name where user can provide a value to any one of them
+# If it is a empty datsource block , then it will read all the replication rules
+# If id or name is provided then it reads a particular replication rule with that id or name
+# Only one of the attribute can be provided among id and  name 
+
+# Get replication rule details using name
+data "powerstore_replication_rule" "test" {
+  depends_on = [powerstore_replication_rule.test]
+  name       = "terraform_replication_rule"
+}
+
+# Get replication rule details using ID
+data "powerstore_replication_rule" "test" {
+  id = "2d0780e3-2ce7-4d8b-b2ec-349c5e9e26a9"
+}
+
+output "replicationRule" {
+  value = data.powerstore_replication_rule.test.replication_rules
+}

examples/data-sources/powerstore_replication_rule/provider.tf

@@ -0,0 +1,33 @@
+/*
+Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.
+
+Licensed under the Mozilla Public License Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://mozilla.org/MPL/2.0/
+
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+terraform {
+  required_providers {
+    powerstore = {
+      version = "1.2.0"
+      source  = "registry.terraform.io/dell/powerstore"
+    }
+  }
+}
+
+provider "powerstore" {
+  username = var.username
+  password = var.password
+  endpoint = var.endpoint
+  insecure = true
+  timeout  = var.timeout
+}

examples/data-sources/powerstore_replication_rule/variables.tf

@@ -0,0 +1,36 @@
+/*
+Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.
+
+Licensed under the Mozilla Public License Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://mozilla.org/MPL/2.0/
+
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+variable "username" {
+  type        = string
+  description = "Stores the username of PowerStore host."
+}
+
+variable "password" {
+  type        = string
+  description = "Stores the password of PowerStore host."
+}
+
+variable "timeout" {
+  type        = string
+  description = "Stores the timeout of PowerStore host."
+}
+
+variable "endpoint" {
+  type        = string
+  description = "Stores the endpoint of PowerStore host. eg: https://10.1.1.1/api/rest"
+}

examples/resources/powerstore_replication_rule/resource.tf

@@ -30,5 +30,5 @@ resource "powerstore_replication_rule" "test" {
 }
 
 //Below example is for import operation
-/*resource "powerstore_snapshotrule" "terraform-provider-test-import" {
+/*resource "powerstore_replication_rule" "terraform-provider-test-import" {
 }*/

go.mod

@@ -5,7 +5,7 @@ go 1.23
 toolchain go1.23.2
 
 require (
-	github.com/dell/gopowerstore v1.16.1-0.20241227083619-36c4ea66275f
+	github.com/dell/gopowerstore v1.16.1-0.20250103044727-b55f5083bb46
 	github.com/hashicorp/terraform-plugin-docs v0.20.1
 	github.com/hashicorp/terraform-plugin-framework v1.13.0
 	github.com/hashicorp/terraform-plugin-framework-validators v0.15.0

go.sum

@@ -39,6 +39,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/dell/gopowerstore v1.16.1-0.20241227083619-36c4ea66275f h1:wr07YuRpeBb5sEgBahBGPWMZKomPC2TfbpBjMWMqwVE=
 github.com/dell/gopowerstore v1.16.1-0.20241227083619-36c4ea66275f/go.mod h1:RYodZ8GgJG5p85AviydL43Mt8ldcTqr5a+Cv+vqWacE=
+github.com/dell/gopowerstore v1.16.1-0.20250103044727-b55f5083bb46 h1:EdQbU3wBHUE1Jh/ucKbVkldi+l//jBg9qB0razB0G1A=
+github.com/dell/gopowerstore v1.16.1-0.20250103044727-b55f5083bb46/go.mod h1:S3Gxw34FJbKNorL/OPe/DF+0pUSkBm6E6b4ka7m6cuo=
 github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc=
 github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ=
 github.com/fatih/color v1.13.0/go.mod h1:kLAiJbzzSOZDVNGyDpeOxJ47H46qBXwg5ILebYFFOfk=

models/replication_rule.go

@@ -28,3 +28,44 @@ type ReplicationRule struct {
 	AlertThreshold types.Int64  `tfsdk:"alert_threshold"`
 	IsReadOnly     types.Bool   `tfsdk:"is_read_only"`
 }
+
+// ReplicationRuleDataSourceModel defines the model for replication rule data source
+type ReplicationRuleDataSourceModel struct {
+	ReplicationRules []ReplicationRuleDataSource `tfsdk:"replication_rules"`
+	ID               types.String                `tfsdk:"id"`
+	Name             types.String                `tfsdk:"name"`
+}
+
+// ReplicationRuleDataSource defines the model for replication rule details
+type ReplicationRuleDataSource struct {
+	ID                 types.String         `tfsdk:"id"`
+	Name               types.String         `tfsdk:"name"`
+	RPO                types.String         `tfsdk:"rpo"`
+	RemoteSystemID     types.String         `tfsdk:"remote_system_id"`
+	AlertThreshold     types.Int64          `tfsdk:"alert_threshold"`
+	IsReadOnly         types.Bool           `tfsdk:"is_read_only"`
+	IsReplica          types.Bool           `tfsdk:"is_replica"`
+	ManagedBy          types.String         `tfsdk:"managed_by"`
+	ManagedByID        types.String         `tfsdk:"managed_by_id"`
+	Policies           []Policy             `tfsdk:"policies"`
+	RemoteSystem       RemoteSystem         `tfsdk:"remote_system"`
+	ReplicationSession []ReplicationSession `tfsdk:"replication_sessions"`
+}
+
+// Policy defines the model for policy
+type Policy struct {
+	ID   types.String `tfsdk:"id"`
+	Name types.String `tfsdk:"name"`
+}
+
+// RemoteSystem defines the model for remote system
+type RemoteSystem struct {
+	ID   types.String `tfsdk:"id"`
+	Name types.String `tfsdk:"name"`
+}
+
+// ReplicationSession defines the model for replication session
+type ReplicationSession struct {
+	ID    types.String `tfsdk:"id"`
+	State types.String `tfsdk:"state"`
+}