docs: generate docs for datasource filter feature

Author: ZStack-Robot

docs/data-sources/backupstorages.md

@@ -17,9 +17,18 @@ List all backup storages, or query backup storages by exact name match, or query
 data "zstack_backupstorages" "example" {
   #   name  = "backupstorage name"
   #   name_pattern = "image%"  # Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
-  filter = { # option
-    Status = "Connected"
-    State  = "Enabled"
+  # optional support schema  filter
+  filter {
+    name   = "status"
+    values = ["Connected"]
+  }
+  filter {
+    name   = "state"
+    values = ["Enabled"]
+  }
+  filter {
+    name   = "total_capacity"
+    values = ["7999424823296"]
   }
 }
 
@@ -33,14 +42,23 @@ output "zstack_imagestorages" {
 
 ### Optional
 
-- `filter` (Map of String) Key-value pairs to filter image Storages. For example, to filter by status, use `Status = "Connected"`.
+- `filter` (Block List) Filter resources based on any field in the schema. For example, to filter by status, use `name = "status"` and `values = ["Ready"]`. (see [below for nested schema](#nestedblock--filter))
 - `name` (String) Exact name for searching backup storage.
 - `name_pattern` (String) Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
 
 ### Read-Only
 
 - `backup_storages` (Attributes List) List of backup storage entries (see [below for nested schema](#nestedatt--backup_storages))
 
+<a id="nestedblock--filter"></a>
+### Nested Schema for `filter`
+
+Required:
+
+- `name` (String) Name of the field to filter by (e.g., status, state).
+- `values` (Set of String) Values to filter by. Multiple values will be treated as an OR condition.
+
+
 <a id="nestedatt--backup_storages"></a>
 ### Nested Schema for `backup_storages`
 

docs/data-sources/clusters.md

@@ -17,10 +17,17 @@ Fetches a list of clusters and their associated attributes.
 data "zstack_clusters" "example" {
   #name = "cluster1"
   #name_pattern = "clu%"  # Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
-  filter = { # option
-    State          = "Enabled"
-    HypervisorType = "KVM"
-    Architecture   = "x86_64"
+  filter {
+    name   = "architecture"
+    values = ["aarch64", "x86_64"]
+  }
+  filter {
+    name   = "state"
+    values = ["Enabled"]
+  }
+  filter {
+    name   = "hypervisor_type"
+    values = ["KVM"]
   }
 }
 
@@ -34,20 +41,30 @@ output "zstack_clusters" {
 
 ### Optional
 
-- `filter` (Map of String) Key-value pairs to filter Clusters. For example, to filter by CPU Architecture, use `Architecture = "x86_64"`.
+- `filter` (Block List) Filter resources based on any field in the schema. For example, to filter by status, use `name = "status"` and `values = ["Ready"]`. (see [below for nested schema](#nestedblock--filter))
 - `name` (String) Exact name for searching Cluster
 - `name_pattern` (String) Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
 
 ### Read-Only
 
 - `clusters` (Attributes List) List of clusters matching the specified filters (see [below for nested schema](#nestedatt--clusters))
 
+<a id="nestedblock--filter"></a>
+### Nested Schema for `filter`
+
+Required:
+
+- `name` (String) Name of the field to filter by (e.g., status, state).
+- `values` (Set of String) Values to filter by. Multiple values will be treated as an OR condition.
+
+
 <a id="nestedatt--clusters"></a>
 ### Nested Schema for `clusters`
 
 Read-Only:
 
-- `hypervisortype` (String) Type of hypervisor used by the cluster (e.g., KVM, ESXi)
+- `architecture` (String) Architecture of the cluster
+- `hypervisor_type` (String) Type of hypervisor used by the cluster (e.g., KVM, ESXi)
 - `name` (String) Name of the cluster
 - `state` (String) State of the cluster (e.g., Enabled, Disabled)
 - `type` (String) ype of the cluster

docs/data-sources/disk_offers.md

@@ -17,8 +17,13 @@ Fetches a list of disk offers and their associated attributes from the ZStack en
 data "zstack_disk_offers" "example" {
   name = "smallDiskOffering"
   # name_pattern = "sm%"  # Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
-  filter = { # option
-    State = "Enabled"
+  filter {
+    name   = "name"
+    values = ["name1", "name2"]
+  }
+  filter {
+    name   = "state"
+    values = ["Enabled"]
   }
 }
 
@@ -32,14 +37,23 @@ output "zstack_disk_offers" {
 
 ### Optional
 
-- `filter` (Map of String) Key-value pairs to filter disk offering. For example, to filter by State, use `State = "Enabled"`.
+- `filter` (Block List) Filter resources based on any field in the schema. For example, to filter by status, use `name = "status"` and `values = ["Ready"]`. (see [below for nested schema](#nestedblock--filter))
 - `name` (String) Exact name for searching  disk offer
 - `name_pattern` (String) Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
 
 ### Read-Only
 
 - `disk_offers` (Attributes List) (see [below for nested schema](#nestedatt--disk_offers))
 
+<a id="nestedblock--filter"></a>
+### Nested Schema for `filter`
+
+Required:
+
+- `name` (String) Name of the field to filter by (e.g., status, state).
+- `values` (Set of String) Values to filter by. Multiple values will be treated as an OR condition.
+
+
 <a id="nestedatt--disk_offers"></a>
 ### Nested Schema for `disk_offers`
 

docs/data-sources/hosts.md

@@ -17,11 +17,21 @@ Fetches a list of hosts and their associated attributes from the ZStack environm
 data "zstack_images" "example" {
   #  name = "imageName"
   #   name_pattern = "hostname%"  # Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
-  filter = {
-    Status       = "Ready"
-    State        = "Enabled"
-    Platform     = "Linux"
-    Architecture = "x86_64"
+  filter {
+    name   = "architecture"
+    values = ["aarch64", "x86_64"]
+  }
+  filter {
+    name   = "state"
+    values = ["Enabled"]
+  }
+  filter {
+    name   = "status"
+    values = ["Ready", "Deleted"]
+  }
+  filter {
+    name   = "guest_os_type"
+    values = ["Linux"]
   }
 }
 
@@ -35,14 +45,23 @@ output "zstack_images" {
 
 ### Optional
 
-- `filter` (Map of String) Key-value pairs to filter hosts. For example, to filter by State, use `State = "Enabled"`.
+- `filter` (Block List) Filter resources based on any field in the schema. For example, to filter by status, use `name = "status"` and `values = ["Ready"]`. (see [below for nested schema](#nestedblock--filter))
 - `name` (String) Exact name for searching hosts
 - `name_pattern` (String) Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
 
 ### Read-Only
 
 - `hosts` (Attributes List) List of host entries matching the specified filters (see [below for nested schema](#nestedatt--hosts))
 
+<a id="nestedblock--filter"></a>
+### Nested Schema for `filter`
+
+Required:
+
+- `name` (String) Name of the field to filter by (e.g., status, state).
+- `values` (Set of String) Values to filter by. Multiple values will be treated as an OR condition.
+
+
 <a id="nestedatt--hosts"></a>
 ### Nested Schema for `hosts`
 

docs/data-sources/images.md

@@ -17,13 +17,21 @@ Fetches a list of images and their associated attributes from the ZStack environ
 data "zstack_hosts" "example" {
   #  name = "hostname"
   #   name_pattern = "hostname%"  # Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
-  filter = { # option
-    State            = "Enabled"
-    Status           = "Connected"
-    HypervisorType   = "KVM"
-    Architecture     = "x86_64"
-    TotalCpuCapacity = "480"
-    ManagementIp     = "172.30.3.4"
+  filter {
+    name   = "architecture"
+    values = ["aarch64", "x86_64"]
+  }
+  filter {
+    name   = "state"
+    values = ["Enabled"]
+  }
+  filter {
+    name   = "status"
+    values = ["Disconnected"]
+  }
+  filter {
+    name   = "cluster_uuid"
+    values = ["37c25209578c495ca176f60ad0cd97fa"]
   }
 }
 
@@ -37,14 +45,23 @@ output "zstack_hosts" {
 
 ### Optional
 
-- `filter` (Map of String) Key-value pairs to filter images. For example, to filter by status, use `Status = "Ready"`.
+- `filter` (Block List) Filter resources based on any field in the schema. For example, to filter by status, use `name = "status"` and `values = ["Ready"]`. (see [below for nested schema](#nestedblock--filter))
 - `name` (String) Exact name for searching images
 - `name_pattern` (String) Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
 
 ### Read-Only
 
 - `images` (Attributes List) List of Images (see [below for nested schema](#nestedatt--images))
 
+<a id="nestedblock--filter"></a>
+### Nested Schema for `filter`
+
+Required:
+
+- `name` (String) Name of the field to filter by (e.g., status, state).
+- `values` (Set of String) Values to filter by. Multiple values will be treated as an OR condition.
+
+
 <a id="nestedatt--images"></a>
 ### Nested Schema for `images`
 

docs/data-sources/instance_offers.md

@@ -17,8 +17,21 @@ Fetches a list of instance offers and their associated attributes from the ZStac
 data "zstack_instance_offers" "example" {
   # name = "InstanceOffering-1"
   # name_pattern = "clu%"  # Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
-  filter = { # option
-    State = "Enabled"
+  filter {
+    name   = "allocator_strategy"
+    values = ["LeastVmPreferredHostAllocatorStrategy"]
+  }
+  filter {
+    name   = "state"
+    values = ["Enabled"]
+  }
+  filter {
+    name   = "memory_size"
+    values = ["1073741824"]
+  }
+  filter {
+    name   = "cpu_num"
+    values = [1]
   }
 }
 
@@ -32,14 +45,23 @@ output "zstack_instance_offers" {
 
 ### Optional
 
-- `filter` (Map of String) Key-value pairs to filter instance offering. For example, to filter by State, use `State = "Enabled"`.
+- `filter` (Block List) Filter resources based on any field in the schema. For example, to filter by status, use `name = "status"` and `values = ["Ready"]`. (see [below for nested schema](#nestedblock--filter))
 - `name` (String) Exact name for searching  instance offer
 - `name_pattern` (String) Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
 
 ### Read-Only
 
 - `instance_offers` (Attributes List) (see [below for nested schema](#nestedatt--instance_offers))
 
+<a id="nestedblock--filter"></a>
+### Nested Schema for `filter`
+
+Required:
+
+- `name` (String) Name of the field to filter by (e.g., status, state).
+- `values` (Set of String) Values to filter by. Multiple values will be treated as an OR condition.
+
+
 <a id="nestedatt--instance_offers"></a>
 ### Nested Schema for `instance_offers`
 

docs/data-sources/instances.md

@@ -17,9 +17,17 @@ Fetches a list of VM instances and their associated attributes from the ZStack e
 data "zstack_instances" "vminstances" {
   #   name = "name of vm instance"
   #    name_pattern = "virtual machine instances name% Pattern"   # Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
-  filter = { # option
-    State  = "Running"
-    CPUNum = "3"
+  filter {
+    name   = "architecture"
+    values = ["aarch64", "x86_64"]
+  }
+  filter {
+    name   = "state"
+    values = ["Running", "Stopped"]
+  }
+  filter {
+    name   = "hypervisor_type"
+    values = ["KVM"]
   }
 }
 
@@ -34,14 +42,23 @@ output "zstack_vminstances" {
 
 ### Optional
 
-- `filter` (Map of String) Key-value pairs to filter instance . For example, to filter by State, use `State = "Running"`.
+- `filter` (Block List) Filter resources based on any field in the schema. For example, to filter by status, use `name = "status"` and `values = ["Ready"]`. (see [below for nested schema](#nestedblock--filter))
 - `name` (String) Exact name for searching VM instance
 - `name_pattern` (String) Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
 
 ### Read-Only
 
 - `vminstances` (Attributes List) (see [below for nested schema](#nestedatt--vminstances))
 
+<a id="nestedblock--filter"></a>
+### Nested Schema for `filter`
+
+Required:
+
+- `name` (String) Name of the field to filter by (e.g., status, state).
+- `values` (Set of String) Values to filter by. Multiple values will be treated as an OR condition.
+
+
 <a id="nestedatt--vminstances"></a>
 ### Nested Schema for `vminstances`
 

docs/data-sources/l2networks.md

@@ -17,9 +17,13 @@ Fetches a list of L2 networks and their associated attributes from the ZStack en
 data "zstack_l2networks" "networks" {
   #   name = "L2 networks name"
   #   name_pattern = "L2 networks name% Pattern"   # Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
-  filter = {
-    Vlan = 36
-    Type = "L2VlanNetwork"
+  filter {
+    name   = "vlan"
+    values = [36]
+  }
+  filter {
+    name   = "physical_interface"
+    values = ["ens29f1"]
   }
 }
 
@@ -33,14 +37,23 @@ output "zstack_l2networks" {
 
 ### Optional
 
-- `filter` (Map of String) Key-value pairs to filter L2 networks . For example, to filter by Vlan, use `Vlan = "2"`.
+- `filter` (Block List) Filter resources based on any field in the schema. For example, to filter by status, use `name = "status"` and `values = ["Ready"]`. (see [below for nested schema](#nestedblock--filter))
 - `name` (String) Exact name for searching L2 Network.
 - `name_pattern` (String) Pattern for fuzzy name search, similar to MySQL LIKE. Use % for multiple characters and _ for exactly one character.
 
 ### Read-Only
 
 - `l2networks` (Attributes List) List of L2 networks matching the specified filters. (see [below for nested schema](#nestedatt--l2networks))
 
+<a id="nestedblock--filter"></a>
+### Nested Schema for `filter`
+
+Required:
+
+- `name` (String) Name of the field to filter by (e.g., status, state).
+- `values` (Set of String) Values to filter by. Multiple values will be treated as an OR condition.
+
+
 <a id="nestedatt--l2networks"></a>
 ### Nested Schema for `l2networks`