Skip to content

Commit b24b7a0

Browse files
scaleway-botscaleway-bot
authored
docs: improve visibility for CPU & GPU instances (#1969)
1 parent 50cbd0a commit b24b7a0

File tree

3 files changed

+1536
-760
lines changed

3 files changed

+1536
-760
lines changed

‎packages/clients/src/api/instance/v1/api.gen.ts‎

Lines changed: 54 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -241,8 +241,8 @@ const jsonContentHeaders = {
241241

242242
/**
243243
* Instance API.
244-
*
245-
* This API allows you to manage your Instances.
244+
245+
This API allows you to manage your CPU and GPU Instances.
246246
*/
247247
export class API extends ParentAPI {
248248
/** Lists the available zones of the API. */
@@ -280,8 +280,7 @@ export class API extends ParentAPI {
280280
)
281281

282282
/**
283-
* List Instance types. List available Instance types and their technical
284-
* details.
283+
* List Instance types. List available Instance types and their technical details.
285284
*
286285
* @param request - The request {@link ListServersTypesRequest}
287286
* @returns A Promise of ListServersTypesResponse
@@ -361,8 +360,7 @@ export class API extends ParentAPI {
361360
)
362361

363362
/**
364-
* List all Instances. List all Instances in a specified Availability Zone,
365-
* e.g. `fr-par-1`.
363+
* List all Instances. List all Instances in a specified Availability Zone, e.g. `fr-par-1`.
366364
*
367365
* @param request - The request {@link ListServersRequest}
368366
* @returns A Promise of ListServersResponse
@@ -436,8 +434,7 @@ export class API extends ParentAPI {
436434
)
437435

438436
/**
439-
* List Instance actions. List all actions (e.g. power on, power off, reboot)
440-
* that can currently be performed on an Instance.
437+
* List Instance actions. List all actions (e.g. power on, power off, reboot) that can currently be performed on an Instance.
441438
*
442439
* @param request - The request {@link ListServerActionsRequest}
443440
* @returns A Promise of ListServerActionsResponse
@@ -452,26 +449,22 @@ export class API extends ParentAPI {
452449
)
453450

454451
/**
455-
* Perform action. Perform an action on an Instance. Available actions are:
456-
* `poweron`: Start a stopped Instance. `poweroff`: Fully stop the Instance
457-
* and release the hypervisor slot. `stop_in_place`: Stop the Instance, but
458-
* keep the slot on the hypervisor. `reboot`: Stop the instance and restart
459-
* it. `backup`: Create an image with all the volumes of an Instance.
460-
* `terminate`: Delete the Instance along with its attached volumes, except
461-
* for SBS volumes. `enable_routed_ip`: Migrate the Instance to the new
462-
* network stack.
463-
*
464-
* The `terminate` action will result in the deletion of `l_ssd`, `b_ssd` and
465-
* `scratch` volumes types, `sbs_volume` volumes type will only be detached.
466-
* If you want to preserve your volumes, you should detach them before the
467-
* Instance deletion or `terminate` action.
468-
*
469-
* The `backup` action can be done with: No `volumes` key in the body: an
470-
* image is created with snapshots of all the server volumes, except for the
471-
* `scratch` volumes types. `volumes` key in the body with a dictionary as
472-
* value, in this dictionary volumes UUID as keys and empty dictionaries as
473-
* values : an image is created with the snapshots of the volumes in `volumes`
474-
* key. `scratch` volumes types can't be shapshotted.
452+
* Perform action. Perform an action on an Instance.
453+
Available actions are:
454+
* `poweron`: Start a stopped Instance.
455+
* `poweroff`: Fully stop the Instance and release the hypervisor slot.
456+
* `stop_in_place`: Stop the Instance, but keep the slot on the hypervisor.
457+
* `reboot`: Stop the instance and restart it.
458+
* `backup`: Create an image with all the volumes of an Instance.
459+
* `terminate`: Delete the Instance along with its attached volumes, except for SBS volumes.
460+
* `enable_routed_ip`: Migrate the Instance to the new network stack.
461+
462+
The `terminate` action will result in the deletion of `l_ssd`, `b_ssd` and `scratch` volumes types, `sbs_volume` volumes type will only be detached.
463+
If you want to preserve your volumes, you should detach them before the Instance deletion or `terminate` action.
464+
465+
The `backup` action can be done with:
466+
* No `volumes` key in the body: an image is created with snapshots of all the server volumes, except for the `scratch` volumes types.
467+
* `volumes` key in the body with a dictionary as value, in this dictionary volumes UUID as keys and empty dictionaries as values : an image is created with the snapshots of the volumes in `volumes` key. `scratch` volumes types can't be shapshotted.
475468
*
476469
* @param request - The request {@link ServerActionRequest}
477470
* @returns A Promise of ServerActionResponse
@@ -516,12 +509,12 @@ export class API extends ParentAPI {
516509
})
517510

518511
/**
519-
* Get Instance compatible types. Get compatible commercial types that can be
520-
* used to update the Instance. The compatibility of an Instance offer is
521-
* based on: the CPU architecture the OS type the required l_ssd storage size
522-
* the required scratch storage size If the specified Instance offer is
523-
* flagged as end of service, the best compatible offer is the first
524-
* returned.
512+
* Get Instance compatible types. Get compatible commercial types that can be used to update the Instance. The compatibility of an Instance offer is based on:
513+
* the CPU architecture
514+
* the OS type
515+
* the required l_ssd storage size
516+
* the required scratch storage size
517+
If the specified Instance offer is flagged as end of service, the best compatible offer is the first returned.
525518
*
526519
* @param request - The request {@link GetServerCompatibleTypesRequest}
527520
* @returns A Promise of ServerCompatibleTypes
@@ -607,8 +600,7 @@ export class API extends ParentAPI {
607600
)
608601

609602
/**
610-
* Create an Instance image. Create an Instance image from the specified
611-
* snapshot ID.
603+
* Create an Instance image. Create an Instance image from the specified snapshot ID.
612604
*
613605
* @param request - The request {@link CreateImageRequest}
614606
* @returns A Promise of CreateImageResponse
@@ -690,8 +682,7 @@ export class API extends ParentAPI {
690682
)
691683

692684
/**
693-
* List snapshots. List all snapshots of an Organization in a specified
694-
* Availability Zone.
685+
* List snapshots. List all snapshots of an Organization in a specified Availability Zone.
695686
*
696687
* @param request - The request {@link ListSnapshotsRequest}
697688
* @returns A Promise of ListSnapshotsResponse
@@ -700,9 +691,7 @@ export class API extends ParentAPI {
700691
enrichForPagination('snapshots', this.pageOfListSnapshots, request)
701692

702693
/**
703-
* Create a snapshot from a specified volume or from a QCOW2 file. Create a
704-
* snapshot from a specified volume or from a QCOW2 file in a specified
705-
* Availability Zone.
694+
* Create a snapshot from a specified volume or from a QCOW2 file. Create a snapshot from a specified volume or from a QCOW2 file in a specified Availability Zone.
706695
*
707696
* @param request - The request {@link CreateSnapshotRequest}
708697
* @returns A Promise of CreateSnapshotResponse
@@ -779,8 +768,7 @@ export class API extends ParentAPI {
779768
})
780769

781770
/**
782-
* Export a snapshot. Export a snapshot to a specified Object Storage bucket
783-
* in the same region.
771+
* Export a snapshot. Export a snapshot to a specified Object Storage bucket in the same region.
784772
*
785773
* @param request - The request {@link ExportSnapshotRequest}
786774
* @returns A Promise of ExportSnapshotResponse
@@ -822,8 +810,7 @@ export class API extends ParentAPI {
822810
)
823811

824812
/**
825-
* List volumes. List volumes in the specified Availability Zone. You can
826-
* filter the output by volume type.
813+
* List volumes. List volumes in the specified Availability Zone. You can filter the output by volume type.
827814
*
828815
* @param request - The request {@link ListVolumesRequest}
829816
* @returns A Promise of ListVolumesResponse
@@ -832,8 +819,7 @@ export class API extends ParentAPI {
832819
enrichForPagination('volumes', this.pageOfListVolumes, request)
833820

834821
/**
835-
* Create a volume. Create a volume of a specified type in an Availability
836-
* Zone.
822+
* Create a volume. Create a volume of a specified type in an Availability Zone.
837823
*
838824
* @param request - The request {@link CreateVolumeRequest}
839825
* @returns A Promise of CreateVolumeResponse
@@ -867,9 +853,7 @@ export class API extends ParentAPI {
867853
)
868854

869855
/**
870-
* Update a volume. Replace the name and/or size properties of a volume
871-
* specified by its ID, with the specified value(s). Any volume name can be
872-
* changed, however only `b_ssd` volumes can currently be increased in size.
856+
* Update a volume. Replace the name and/or size properties of a volume specified by its ID, with the specified value(s). Any volume name can be changed, however only `b_ssd` volumes can currently be increased in size.
873857
*
874858
* @param request - The request {@link UpdateVolumeRequest}
875859
* @returns A Promise of UpdateVolumeResponse
@@ -937,8 +921,7 @@ export class API extends ParentAPI {
937921
)
938922

939923
/**
940-
* Create a security group. Create a security group with a specified name and
941-
* description.
924+
* Create a security group. Create a security group with a specified name and description.
942925
*
943926
* @param request - The request {@link CreateSecurityGroupRequest}
944927
* @returns A Promise of CreateSecurityGroupResponse
@@ -957,8 +940,7 @@ export class API extends ParentAPI {
957940
)
958941

959942
/**
960-
* Get a security group. Get the details of a security group with the
961-
* specified ID.
943+
* Get a security group. Get the details of a security group with the specified ID.
962944
*
963945
* @param request - The request {@link GetSecurityGroupRequest}
964946
* @returns A Promise of GetSecurityGroupResponse
@@ -1016,8 +998,7 @@ export class API extends ParentAPI {
1016998
)
1017999

10181000
/**
1019-
* Get default rules. Lists the default rules applied to all the security
1020-
* groups.
1001+
* Get default rules. Lists the default rules applied to all the security groups.
10211002
*
10221003
* @param request - The request {@link ListDefaultSecurityGroupRulesRequest}
10231004
* @returns A Promise of ListSecurityGroupRulesResponse
@@ -1079,10 +1060,7 @@ export class API extends ParentAPI {
10791060
)
10801061

10811062
/**
1082-
* Update all the rules of a security group. Replaces the existing rules of
1083-
* the security group with the rules provided. This endpoint supports the
1084-
* update of existing rules, creation of new rules and deletion of existing
1085-
* rules when they are not passed in the request.
1063+
* Update all the rules of a security group. Replaces the existing rules of the security group with the rules provided. This endpoint supports the update of existing rules, creation of new rules and deletion of existing rules when they are not passed in the request.
10861064
*
10871065
* @param request - The request {@link SetSecurityGroupRulesRequest}
10881066
* @returns A Promise of SetSecurityGroupRulesResponse
@@ -1144,8 +1122,7 @@ export class API extends ParentAPI {
11441122
)
11451123

11461124
/**
1147-
* Update security group rule. Update the properties of a rule from a
1148-
* specified security group.
1125+
* Update security group rule. Update the properties of a rule from a specified security group.
11491126
*
11501127
* @param request - The request {@link UpdateSecurityGroupRuleRequest}
11511128
* @returns A Promise of UpdateSecurityGroupRuleResponse
@@ -1190,8 +1167,7 @@ export class API extends ParentAPI {
11901167
)
11911168

11921169
/**
1193-
* List placement groups. List all placement groups in a specified
1194-
* Availability Zone.
1170+
* List placement groups. List all placement groups in a specified Availability Zone.
11951171
*
11961172
* @param request - The request {@link ListPlacementGroupsRequest}
11971173
* @returns A Promise of ListPlacementGroupsResponse
@@ -1204,8 +1180,7 @@ export class API extends ParentAPI {
12041180
)
12051181

12061182
/**
1207-
* Create a placement group. Create a new placement group in a specified
1208-
* Availability Zone.
1183+
* Create a placement group. Create a new placement group in a specified Availability Zone.
12091184
*
12101185
* @param request - The request {@link CreatePlacementGroupRequest}
12111186
* @returns A Promise of CreatePlacementGroupResponse
@@ -1260,8 +1235,7 @@ export class API extends ParentAPI {
12601235
)
12611236

12621237
/**
1263-
* Update a placement group. Update one or more parameter of the specified
1264-
* placement group.
1238+
* Update a placement group. Update one or more parameter of the specified placement group.
12651239
*
12661240
* @param request - The request {@link UpdatePlacementGroupRequest}
12671241
* @returns A Promise of UpdatePlacementGroupResponse
@@ -1291,8 +1265,7 @@ export class API extends ParentAPI {
12911265
})
12921266

12931267
/**
1294-
* Get placement group servers. Get all Instances belonging to the specified
1295-
* placement group.
1268+
* Get placement group servers. Get all Instances belonging to the specified placement group.
12961269
*
12971270
* @param request - The request {@link GetPlacementGroupServersRequest}
12981271
* @returns A Promise of GetPlacementGroupServersResponse
@@ -1309,8 +1282,7 @@ export class API extends ParentAPI {
13091282
)
13101283

13111284
/**
1312-
* Set placement group servers. Set all Instances belonging to the specified
1313-
* placement group.
1285+
* Set placement group servers. Set all Instances belonging to the specified placement group.
13141286
*
13151287
* @param request - The request {@link SetPlacementGroupServersRequest}
13161288
* @returns A Promise of SetPlacementGroupServersResponse
@@ -1331,8 +1303,7 @@ export class API extends ParentAPI {
13311303
)
13321304

13331305
/**
1334-
* Update placement group servers. Update all Instances belonging to the
1335-
* specified placement group.
1306+
* Update placement group servers. Update all Instances belonging to the specified placement group.
13361307
*
13371308
* @param request - The request {@link UpdatePlacementGroupServersRequest}
13381309
* @returns A Promise of UpdatePlacementGroupServersResponse
@@ -1388,8 +1359,7 @@ export class API extends ParentAPI {
13881359
enrichForPagination('ips', this.pageOfListIps, request)
13891360

13901361
/**
1391-
* Reserve a flexible IP. Reserve a flexible IP and attach it to the specified
1392-
* Instance.
1362+
* Reserve a flexible IP. Reserve a flexible IP and attach it to the specified Instance.
13931363
*
13941364
* @param request - The request {@link CreateIpRequest}
13951365
* @returns A Promise of CreateIpResponse
@@ -1423,8 +1393,7 @@ export class API extends ParentAPI {
14231393
)
14241394

14251395
/**
1426-
* Update a flexible IP. Update a flexible IP in the specified zone with the
1427-
* specified ID.
1396+
* Update a flexible IP. Update a flexible IP in the specified zone with the specified ID.
14281397
*
14291398
* @param request - The request {@link UpdateIpRequest}
14301399
* @returns A Promise of UpdateIpResponse
@@ -1518,8 +1487,7 @@ export class API extends ParentAPI {
15181487
)
15191488

15201489
/**
1521-
* Update a private NIC. Update one or more parameter(s) of a specified
1522-
* private NIC.
1490+
* Update a private NIC. Update one or more parameter(s) of a specified private NIC.
15231491
*
15241492
* @param request - The request {@link UpdatePrivateNICRequest}
15251493
* @returns A Promise of PrivateNIC
@@ -1562,23 +1530,11 @@ export class API extends ParentAPI {
15621530
)
15631531

15641532
/**
1565-
* Get a volume or snapshot's migration plan. Given a volume or snapshot,
1566-
* returns the migration plan but does not perform the actual migration. To
1567-
* perform the migration, you have to call the [Migrate a volume and/or
1568-
* snapshots to
1569-
* SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage)
1570-
* endpoint afterward. The endpoint returns the resources that should be
1571-
* migrated together:
1572-
*
1573-
* - The volume and any snapshots created from the volume, if the call was made
1574-
* to plan a volume migration.
1575-
* - The base volume of the snapshot (if the volume is not deleted) and its
1576-
* related snapshots, if the call was made to plan a snapshot migration. The
1577-
* endpoint also returns the validation_key, which must be provided to the
1578-
* [Migrate a volume and/or snapshots to
1579-
* SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage)
1580-
* endpoint to confirm that all resources listed in the plan should be
1581-
* migrated.
1533+
* Get a volume or snapshot's migration plan. Given a volume or snapshot, returns the migration plan but does not perform the actual migration. To perform the migration, you have to call the [Migrate a volume and/or snapshots to SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) endpoint afterward.
1534+
The endpoint returns the resources that should be migrated together:
1535+
- the volume and any snapshots created from the volume, if the call was made to plan a volume migration.
1536+
- the base volume of the snapshot (if the volume is not deleted) and its related snapshots, if the call was made to plan a snapshot migration.
1537+
The endpoint also returns the validation_key, which must be provided to the [Migrate a volume and/or snapshots to SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) endpoint to confirm that all resources listed in the plan should be migrated.
15821538
*
15831539
* @param request - The request {@link PlanBlockMigrationRequest}
15841540
* @returns A Promise of MigrationPlan
@@ -1597,12 +1553,7 @@ export class API extends ParentAPI {
15971553
)
15981554

15991555
/**
1600-
* Migrate a volume and/or snapshots to SBS (Scaleway Block Storage). To be
1601-
* used, the call to this endpoint must be preceded by a call to the [Get a
1602-
* volume or snapshot's migration
1603-
* plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. To
1604-
* migrate all resources mentioned in the migration plan, the validation_key
1605-
* returned in the plan must be provided.
1556+
* Migrate a volume and/or snapshots to SBS (Scaleway Block Storage). To be used, the call to this endpoint must be preceded by a call to the [Get a volume or snapshot's migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. To migrate all resources mentioned in the migration plan, the validation_key returned in the plan must be provided.
16061557
*
16071558
* @param request - The request {@link ApplyBlockMigrationRequest}
16081559
*/

0 commit comments

Comments
 (0)