feat(ipam): support filtering ips on ids (scaleway#4351)

Author: scaleway-bot

cmd/scw/testdata/test-all-usage-ipam-ip-list-usage.golden

@@ -13,14 +13,15 @@ ARGS:
   [subnet-id]                Subnet ID to filter for.
   [vpc-id]                   VPC ID to filter for.
   [attached]                 Defines whether to filter only for IPs which are attached to a resource
+  [resource-name]            Attached resource name to filter for, only IPs attached to a resource with this string within their name will be returned.
   [resource-id]              Resource ID to filter for. Only IPs attached to this resource will be returned
   [resource-ids.{index}]     Resource IDs to filter for. Only IPs attached to at least one of these resources will be returned
   [resource-type]            Resource type to filter for. Only IPs attached to this type of resource will be returned (unknown_type | custom | instance_server | instance_ip | instance_private_nic | lb_server | fip_ip | vpc_gateway | vpc_gateway_network | k8s_node | k8s_cluster | rdb_instance | redis_cluster | baremetal_server | baremetal_private_nic | llm_deployment | mgdb_instance | apple_silicon_server | apple_silicon_private_nic)
+  [resource-types.{index}]   Resource types to filter for. Only IPs attached to these types of resources will be returned (unknown_type | custom | instance_server | instance_ip | instance_private_nic | lb_server | fip_ip | vpc_gateway | vpc_gateway_network | k8s_node | k8s_cluster | rdb_instance | redis_cluster | baremetal_server | baremetal_private_nic | llm_deployment | mgdb_instance | apple_silicon_server | apple_silicon_private_nic)
   [mac-address]              MAC address to filter for. Only IPs attached to a resource with this MAC address will be returned
   [tags.{index}]             Tags to filter for, only IPs with one or more matching tags will be returned
   [is-ipv6]                  Defines whether to filter only for IPv4s or IPv6s
-  [resource-name]            Attached resource name to filter for, only IPs attached to a resource with this string within their name will be returned.
-  [resource-types.{index}]   Resource types to filter for. Only IPs attached to these types of resources will be returned (unknown_type | custom | instance_server | instance_ip | instance_private_nic | lb_server | fip_ip | vpc_gateway | vpc_gateway_network | k8s_node | k8s_cluster | rdb_instance | redis_cluster | baremetal_server | baremetal_private_nic | llm_deployment | mgdb_instance | apple_silicon_server | apple_silicon_private_nic)
+  [ip-ids.{index}]           IP IDs to filter for. Only IPs with these UUIDs will be returned
   [organization-id]          Organization ID to filter for. Only IPs belonging to this Organization will be returned
   [region=fr-par]            Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
 

docs/commands/ipam.md

@@ -107,14 +107,15 @@ scw ipam ip list [arg=value ...]
 | subnet-id |  | Subnet ID to filter for. |
 | vpc-id |  | VPC ID to filter for. |
 | attached |  | Defines whether to filter only for IPs which are attached to a resource |
+| resource-name |  | Attached resource name to filter for, only IPs attached to a resource with this string within their name will be returned. |
 | resource-id |  | Resource ID to filter for. Only IPs attached to this resource will be returned |
 | resource-ids.{index} |  | Resource IDs to filter for. Only IPs attached to at least one of these resources will be returned |
 | resource-type | One of: `unknown_type`, `custom`, `instance_server`, `instance_ip`, `instance_private_nic`, `lb_server`, `fip_ip`, `vpc_gateway`, `vpc_gateway_network`, `k8s_node`, `k8s_cluster`, `rdb_instance`, `redis_cluster`, `baremetal_server`, `baremetal_private_nic`, `llm_deployment`, `mgdb_instance`, `apple_silicon_server`, `apple_silicon_private_nic` | Resource type to filter for. Only IPs attached to this type of resource will be returned |
+| resource-types.{index} | One of: `unknown_type`, `custom`, `instance_server`, `instance_ip`, `instance_private_nic`, `lb_server`, `fip_ip`, `vpc_gateway`, `vpc_gateway_network`, `k8s_node`, `k8s_cluster`, `rdb_instance`, `redis_cluster`, `baremetal_server`, `baremetal_private_nic`, `llm_deployment`, `mgdb_instance`, `apple_silicon_server`, `apple_silicon_private_nic` | Resource types to filter for. Only IPs attached to these types of resources will be returned |
 | mac-address |  | MAC address to filter for. Only IPs attached to a resource with this MAC address will be returned |
 | tags.{index} |  | Tags to filter for, only IPs with one or more matching tags will be returned |
 | is-ipv6 |  | Defines whether to filter only for IPv4s or IPv6s |
-| resource-name |  | Attached resource name to filter for, only IPs attached to a resource with this string within their name will be returned. |
-| resource-types.{index} | One of: `unknown_type`, `custom`, `instance_server`, `instance_ip`, `instance_private_nic`, `lb_server`, `fip_ip`, `vpc_gateway`, `vpc_gateway_network`, `k8s_node`, `k8s_cluster`, `rdb_instance`, `redis_cluster`, `baremetal_server`, `baremetal_private_nic`, `llm_deployment`, `mgdb_instance`, `apple_silicon_server`, `apple_silicon_private_nic` | Resource types to filter for. Only IPs attached to these types of resources will be returned |
+| ip-ids.{index} |  | IP IDs to filter for. Only IPs with these UUIDs will be returned |
 | organization-id |  | Organization ID to filter for. Only IPs belonging to this Organization will be returned |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config |
 

go.mod

@@ -26,7 +26,7 @@ require (
 	github.com/mattn/go-isatty v0.0.20
 	github.com/moby/buildkit v0.13.2
 	github.com/opencontainers/go-digest v1.0.0
-	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241209103932-cb4590f1bf86
+	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241209153125-92afa47368ef
 	github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
 	github.com/spf13/cobra v1.8.1
 	github.com/spf13/pflag v1.0.5

go.sum

@@ -466,8 +466,8 @@ github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUz
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241209103932-cb4590f1bf86 h1:SA93A+shM43Qw7b8srntt5vp+hjuH3gEwRI7YDqZg3o=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241209103932-cb4590f1bf86/go.mod h1:kzh+BSAvpoyHHdHBCDhmSWtBc1NbLMZ2lWHqnBoxFks=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241209153125-92afa47368ef h1:WlyvzZzG1ipVvmolk69a7VdWCP5J0nCRxsNGpUspGrc=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241209153125-92afa47368ef/go.mod h1:kzh+BSAvpoyHHdHBCDhmSWtBc1NbLMZ2lWHqnBoxFks=
 github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8=
 github.com/sclevine/spec v1.4.0/go.mod h1:LvpgJaFyvQzRvc1kaDs0bulYwzC70PbiYjC4QnFHkOM=
 github.com/secure-systems-lab/go-securesystemslib v0.8.0 h1:mr5An6X45Kb2nddcFlbmfHkLguCE9laoZCUzEEpIZXA=

internal/namespaces/ipam/v1/ipam_cli.go

@@ -348,6 +348,13 @@ func ipamIPList() *core.Command {
 				Deprecated: false,
 				Positional: false,
 			},
+			{
+				Name:       "resource-name",
+				Short:      `Attached resource name to filter for, only IPs attached to a resource with this string within their name will be returned.`,
+				Required:   false,
+				Deprecated: false,
+				Positional: false,
+			},
 			{
 				Name:       "resource-id",
 				Short:      `Resource ID to filter for. Only IPs attached to this resource will be returned`,
@@ -370,6 +377,14 @@ func ipamIPList() *core.Command {
 				Positional: false,
 				EnumValues: []string{"unknown_type", "custom", "instance_server", "instance_ip", "instance_private_nic", "lb_server", "fip_ip", "vpc_gateway", "vpc_gateway_network", "k8s_node", "k8s_cluster", "rdb_instance", "redis_cluster", "baremetal_server", "baremetal_private_nic", "llm_deployment", "mgdb_instance", "apple_silicon_server", "apple_silicon_private_nic"},
 			},
+			{
+				Name:       "resource-types.{index}",
+				Short:      `Resource types to filter for. Only IPs attached to these types of resources will be returned`,
+				Required:   false,
+				Deprecated: false,
+				Positional: false,
+				EnumValues: []string{"unknown_type", "custom", "instance_server", "instance_ip", "instance_private_nic", "lb_server", "fip_ip", "vpc_gateway", "vpc_gateway_network", "k8s_node", "k8s_cluster", "rdb_instance", "redis_cluster", "baremetal_server", "baremetal_private_nic", "llm_deployment", "mgdb_instance", "apple_silicon_server", "apple_silicon_private_nic"},
+			},
 			{
 				Name:       "mac-address",
 				Short:      `MAC address to filter for. Only IPs attached to a resource with this MAC address will be returned`,
@@ -392,19 +407,11 @@ func ipamIPList() *core.Command {
 				Positional: false,
 			},
 			{
-				Name:       "resource-name",
-				Short:      `Attached resource name to filter for, only IPs attached to a resource with this string within their name will be returned.`,
-				Required:   false,
-				Deprecated: false,
-				Positional: false,
-			},
-			{
-				Name:       "resource-types.{index}",
-				Short:      `Resource types to filter for. Only IPs attached to these types of resources will be returned`,
+				Name:       "ip-ids.{index}",
+				Short:      `IP IDs to filter for. Only IPs with these UUIDs will be returned`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
-				EnumValues: []string{"unknown_type", "custom", "instance_server", "instance_ip", "instance_private_nic", "lb_server", "fip_ip", "vpc_gateway", "vpc_gateway_network", "k8s_node", "k8s_cluster", "rdb_instance", "redis_cluster", "baremetal_server", "baremetal_private_nic", "llm_deployment", "mgdb_instance", "apple_silicon_server", "apple_silicon_private_nic"},
 			},
 			{
 				Name:       "organization-id",