Skip to content

Commit

Permalink
docs(ipam): document expected format of requested IP (#3801)
Browse files Browse the repository at this point in the history
  • Loading branch information
scaleway-bot authored May 3, 2024
1 parent 8cbf6bf commit aecb9d7
Show file tree
Hide file tree
Showing 23 changed files with 64 additions and 42 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ARGS:
[source.private-network-id] Private Network the IP lives in if the IP is a private IP.
[source.subnet-id] Private Network subnet the IP lives in if the IP is a private IP in a Private Network.
[is-ipv6] Request an IPv6 instead of an IPv4
[address] Request a specific IP in the requested source pool
[address] Request this specific IP address in the specified source pool
[tags.{index}] Tags for the IP
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/ipam.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ scw ipam ip create [arg=value ...]
| source.private-network-id | | Private Network the IP lives in if the IP is a private IP. |
| source.subnet-id | | Private Network subnet the IP lives in if the IP is a private IP in a Private Network. |
| is-ipv6 | | Request an IPv6 instead of an IPv4 |
| address | | Request a specific IP in the requested source pool |
| address | | Request this specific IP address in the specified source pool |
| tags.{index} | | Tags for the IP |
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |

Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,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.26.0.20240429124613-30a12e8a3fb1
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.26.0.20240503083153-7b6fd123c9be
github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
github.com/spf13/cobra v1.8.0
github.com/spf13/pflag v1.0.5
Expand Down
4 changes: 2 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -453,8 +453,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.26.0.20240429124613-30a12e8a3fb1 h1:c4nXEzSj5M7wHGnlvwYZ0dgoMLUv212Vt7rNerfdhAk=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.26.0.20240429124613-30a12e8a3fb1/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.26.0.20240503083153-7b6fd123c9be h1:0pZ7mSBSxH7UrUFQK0Z84MTnv6GCWNGXpEqzn+uMNMw=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.26.0.20240503083153-7b6fd123c9be/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
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=
Expand Down
2 changes: 1 addition & 1 deletion internal/namespaces/ipam/v1/ipam_cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ func ipamIPCreate() *core.Command {
},
{
Name: "address",
Short: `Request a specific IP in the requested source pool`,
Short: `Request this specific IP address in the specified source pool`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Region fr-par
Zone fr-par-1

IPs:
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE REGION ZONE
d91ed7cd-e6c2-4678-a502-bf83dd8e04f4 51.158.59.142 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b 9b6a23db-aa5e-413c-af11-da9c1a2a6e97 51-158-59-142.lb.fr-par.scw.cloud fr-par fr-par-1
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE TAGS REGION ZONE
d91ed7cd-e6c2-4678-a502-bf83dd8e04f4 51.158.59.142 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b 9b6a23db-aa5e-413c-af11-da9c1a2a6e97 51-158-59-142.lb.fr-par.scw.cloud - fr-par fr-par-1

LB Instances:
ID STATUS IP ADDRESS CREATED AT UPDATED AT REGION ZONE
Expand Down Expand Up @@ -100,6 +100,7 @@ ID STATUS IP ADDRESS CREATED AT UPDA
"project_id": "ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b",
"lb_id": "9b6a23db-aa5e-413c-af11-da9c1a2a6e97",
"reverse": "51-158-59-142.lb.fr-par.scw.cloud",
"tags": null,
"region": "fr-par",
"zone": "fr-par-1"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Region fr-par
Zone fr-par-1

IPs:
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE REGION ZONE
dd7f7666-b95f-4cb5-8f45-3d338d239ffd 51.159.115.194 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b 21be90ef-67c1-4beb-ad9a-a8b17a72b3c3 51-159-115-194.lb.fr-par.scw.cloud fr-par fr-par-1
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE TAGS REGION ZONE
dd7f7666-b95f-4cb5-8f45-3d338d239ffd 51.159.115.194 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b 21be90ef-67c1-4beb-ad9a-a8b17a72b3c3 51-159-115-194.lb.fr-par.scw.cloud - fr-par fr-par-1

LB Instances:
ID STATUS IP ADDRESS CREATED AT UPDATED AT REGION ZONE
Expand Down Expand Up @@ -100,6 +100,7 @@ abe4e9a8-8217-4bdc-87a5-c4d6d4532a73 pending - few seconds ago few
"project_id": "ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b",
"lb_id": "21be90ef-67c1-4beb-ad9a-a8b17a72b3c3",
"reverse": "51-159-115-194.lb.fr-par.scw.cloud",
"tags": null,
"region": "fr-par",
"zone": "fr-par-1"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Region fr-par
Zone fr-par-1

IPs:
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE REGION ZONE
d4e38545-b7e6-4f3e-82b1-28f6d1c3f9aa 51.158.57.196 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b 77e4cf81-9dd8-4639-ba6c-523b677dbb3b 51-158-57-196.lb.fr-par.scw.cloud fr-par fr-par-1
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE TAGS REGION ZONE
d4e38545-b7e6-4f3e-82b1-28f6d1c3f9aa 51.158.57.196 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b 77e4cf81-9dd8-4639-ba6c-523b677dbb3b 51-158-57-196.lb.fr-par.scw.cloud - fr-par fr-par-1

LB Instances:
ID STATUS IP ADDRESS CREATED AT UPDATED AT REGION ZONE
Expand Down Expand Up @@ -101,6 +101,7 @@ f5c11c83-ca4d-4bd2-bdd4-59c2ee5cf5e2 pending - few seconds ago few
"project_id": "ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b",
"lb_id": "77e4cf81-9dd8-4639-ba6c-523b677dbb3b",
"reverse": "51-158-57-196.lb.fr-par.scw.cloud",
"tags": null,
"region": "fr-par",
"zone": "fr-par-1"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Region fr-par
Zone fr-par-1

IPs:
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE REGION ZONE
d9e14ff0-222e-44c3-b040-02f37db737dc 51.159.114.60 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b 094db171-b4a5-47e8-936c-4995e2a170dc 51-159-114-60.lb.fr-par.scw.cloud fr-par fr-par-1
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE TAGS REGION ZONE
d9e14ff0-222e-44c3-b040-02f37db737dc 51.159.114.60 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b 094db171-b4a5-47e8-936c-4995e2a170dc 51-159-114-60.lb.fr-par.scw.cloud - fr-par fr-par-1

LB Instances:
ID STATUS IP ADDRESS CREATED AT UPDATED AT REGION ZONE
Expand Down Expand Up @@ -101,6 +101,7 @@ ID STATUS IP ADDRESS CREATED AT UPDA
"project_id": "ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b",
"lb_id": "094db171-b4a5-47e8-936c-4995e2a170dc",
"reverse": "51-159-114-60.lb.fr-par.scw.cloud",
"tags": null,
"region": "fr-par",
"zone": "fr-par-1"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Region fr-par
Zone fr-par-1

IPs:
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE REGION ZONE
d2b289c1-facd-49f0-a765-58b2c06bd699 195.154.70.247 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b f3acf7a9-9649-44a6-85cc-b849a003a42f 195-154-70-247.lb.fr-par.scw.cloud fr-par fr-par-1
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE TAGS REGION ZONE
d2b289c1-facd-49f0-a765-58b2c06bd699 195.154.70.247 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b f3acf7a9-9649-44a6-85cc-b849a003a42f 195-154-70-247.lb.fr-par.scw.cloud - fr-par fr-par-1

LB Instances:
ID STATUS IP ADDRESS CREATED AT UPDATED AT REGION ZONE
Expand Down Expand Up @@ -100,6 +100,7 @@ ID STATUS IP ADDRESS CREATED AT UPDA
"project_id": "ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b",
"lb_id": "f3acf7a9-9649-44a6-85cc-b849a003a42f",
"reverse": "195-154-70-247.lb.fr-par.scw.cloud",
"tags": null,
"region": "fr-par",
"zone": "fr-par-1"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Region fr-par
Zone fr-par-1

IPs:
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE REGION ZONE
d2538de2-b2d7-4d7e-bc50-94f92e139f4e 51.159.27.231 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b 659830a7-6036-4337-b149-bf3b6b1e7dd9 51-159-27-231.lb.fr-par.scw.cloud fr-par fr-par-1
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE TAGS REGION ZONE
d2538de2-b2d7-4d7e-bc50-94f92e139f4e 51.159.27.231 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b 659830a7-6036-4337-b149-bf3b6b1e7dd9 51-159-27-231.lb.fr-par.scw.cloud - fr-par fr-par-1

LB Instances:
ID STATUS IP ADDRESS CREATED AT UPDATED AT REGION ZONE
Expand Down Expand Up @@ -100,6 +100,7 @@ b5ec2704-6d69-48d5-a678-df26543fa918 pending - few seconds ago few
"project_id": "ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b",
"lb_id": "659830a7-6036-4337-b149-bf3b6b1e7dd9",
"reverse": "51-159-27-231.lb.fr-par.scw.cloud",
"tags": null,
"region": "fr-par",
"zone": "fr-par-1"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Region fr-par
Zone fr-par-1

IPs:
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE REGION ZONE
d164053a-88da-407a-a9e4-9bf314a63cdd 51.159.8.203 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b 5c504b90-bb22-4ae2-8273-3a1d52258344 51-159-8-203.lb.fr-par.scw.cloud fr-par fr-par-1
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE TAGS REGION ZONE
d164053a-88da-407a-a9e4-9bf314a63cdd 51.159.8.203 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b 5c504b90-bb22-4ae2-8273-3a1d52258344 51-159-8-203.lb.fr-par.scw.cloud - fr-par fr-par-1

LB Instances:
ID STATUS IP ADDRESS CREATED AT UPDATED AT REGION ZONE
Expand Down Expand Up @@ -101,6 +101,7 @@ bd722f0f-5686-4d27-a05c-bd84394314f9 pending - few seconds ago few
"project_id": "ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b",
"lb_id": "5c504b90-bb22-4ae2-8273-3a1d52258344",
"reverse": "51-159-8-203.lb.fr-par.scw.cloud",
"tags": null,
"region": "fr-par",
"zone": "fr-par-1"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Region fr-par
Zone fr-par-1

IPs:
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE REGION ZONE
d1b657fa-7a20-4428-8c2b-3df4f746dae8 195.154.71.33 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b 9b526235-39aa-4dc6-8a5f-a7f633f6d5b3 195-154-71-33.lb.fr-par.scw.cloud fr-par fr-par-1
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE TAGS REGION ZONE
d1b657fa-7a20-4428-8c2b-3df4f746dae8 195.154.71.33 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b 9b526235-39aa-4dc6-8a5f-a7f633f6d5b3 195-154-71-33.lb.fr-par.scw.cloud - fr-par fr-par-1

LB Instances:
ID STATUS IP ADDRESS CREATED AT UPDATED AT REGION ZONE
Expand Down Expand Up @@ -101,6 +101,7 @@ ID STATUS IP ADDRESS CREATED AT UPDA
"project_id": "ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b",
"lb_id": "9b526235-39aa-4dc6-8a5f-a7f633f6d5b3",
"reverse": "195-154-71-33.lb.fr-par.scw.cloud",
"tags": null,
"region": "fr-par",
"zone": "fr-par-1"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Region fr-par
Zone fr-par-1

IPs:
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE REGION ZONE
bf85ad58-3ffa-4d79-950d-57cd1a53e4f3 195.154.71.202 564aa517-68b0-4fd7-8c8c-d21c4bcdcbd5 564aa517-68b0-4fd7-8c8c-d21c4bcdcbd5 abbd0516-349d-4e27-a4ed-f96ba6259f7d 195-154-71-202.lb.fr-par.scw.cloud fr-par fr-par-1
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE TAGS REGION ZONE
bf85ad58-3ffa-4d79-950d-57cd1a53e4f3 195.154.71.202 564aa517-68b0-4fd7-8c8c-d21c4bcdcbd5 564aa517-68b0-4fd7-8c8c-d21c4bcdcbd5 abbd0516-349d-4e27-a4ed-f96ba6259f7d 195-154-71-202.lb.fr-par.scw.cloud - fr-par fr-par-1

LB Instances:
ID STATUS IP ADDRESS CREATED AT UPDATED AT REGION ZONE
Expand Down Expand Up @@ -75,6 +75,7 @@ f0db7c8b-be87-489e-8c1d-200aac84639e ready 10.68.44.31 few seconds ago few
"project_id": "564aa517-68b0-4fd7-8c8c-d21c4bcdcbd5",
"lb_id": "abbd0516-349d-4e27-a4ed-f96ba6259f7d",
"reverse": "195-154-71-202.lb.fr-par.scw.cloud",
"tags": null,
"region": "fr-par",
"zone": "fr-par-1"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Region fr-par
Zone fr-par-1

IPs:
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE REGION ZONE
8bfc3757-bbae-4b52-9325-d4acde51c110 195.154.197.213 564aa517-68b0-4fd7-8c8c-d21c4bcdcbd5 564aa517-68b0-4fd7-8c8c-d21c4bcdcbd5 57c0ad68-037a-4e52-bbaf-d422d4d943fd 195-154-197-213.lb.fr-par.scw.cloud fr-par fr-par-1
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE TAGS REGION ZONE
8bfc3757-bbae-4b52-9325-d4acde51c110 195.154.197.213 564aa517-68b0-4fd7-8c8c-d21c4bcdcbd5 564aa517-68b0-4fd7-8c8c-d21c4bcdcbd5 57c0ad68-037a-4e52-bbaf-d422d4d943fd 195-154-197-213.lb.fr-par.scw.cloud - fr-par fr-par-1

LB Instances:
ID STATUS IP ADDRESS CREATED AT UPDATED AT REGION ZONE
Expand Down Expand Up @@ -51,6 +51,7 @@ ID STATUS IP ADDRESS CREATED AT UPDA
"project_id": "564aa517-68b0-4fd7-8c8c-d21c4bcdcbd5",
"lb_id": "57c0ad68-037a-4e52-bbaf-d422d4d943fd",
"reverse": "195-154-197-213.lb.fr-par.scw.cloud",
"tags": null,
"region": "fr-par",
"zone": "fr-par-1"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Region fr-par
Zone fr-par-1

IPs:
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE REGION ZONE
ce740e29-b1dd-4a88-b213-41bcd5851c78 51.159.204.80 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b e0fc06b9-76cd-408c-a089-765bef963f48 51-159-204-80.lb.fr-par.scw.cloud fr-par fr-par-1
ID IP ADDRESS ORGANIZATION ID PROJECT ID LB ID REVERSE TAGS REGION ZONE
ce740e29-b1dd-4a88-b213-41bcd5851c78 51.159.204.80 ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b e0fc06b9-76cd-408c-a089-765bef963f48 51-159-204-80.lb.fr-par.scw.cloud - fr-par fr-par-1

LB Instances:
ID STATUS IP ADDRESS CREATED AT UPDATED AT REGION ZONE
Expand Down Expand Up @@ -100,6 +100,7 @@ dabec983-4c52-4d72-a0ef-7bcca53bac13 pending - few seconds ago few
"project_id": "ee7bd9e1-9cbd-4724-b2f4-19e50f3cf38b",
"lb_id": "e0fc06b9-76cd-408c-a089-765bef963f48",
"reverse": "51-159-204-80.lb.fr-par.scw.cloud",
"tags": null,
"region": "fr-par",
"zone": "fr-par-1"
}
Expand Down
Loading

0 comments on commit aecb9d7

Please sign in to comment.