Skip to content

docs(instance): hide block migration from documentation #499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 23, 2024
Merged

docs(instance): hide block migration from documentation #499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions scaleway-async/scaleway_async/instance/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4094,7 +4094,7 @@ async def plan_block_migration(
) -> MigrationPlan:
"""
Get a volume or snapshot's migration plan.
Given a volume or snapshot, returns the migration plan for a call to the RPC ApplyBlockMigration. This plan will include zero or one volume, and zero or more snapshots, which will need to be migrated together. This RPC does not perform the actual migration itself, ApplyBlockMigration must be used. The validation_key value returned by this call must be provided to the ApplyBlockMigration call to confirm that all resources listed in the plan should be migrated.
Given a volume or snapshot, returns the migration plan for a call to the "Apply a migration plan" endpoint. This plan will include zero or one volume, and zero or more snapshots, which will need to be migrated together. This endpoint does not perform the actual migration itself, the "Apply a migration plan" endpoint must be used. The validation_key value returned by this endpoint must be provided to the call to the "Apply a migration plan" endpoint to confirm that all resources listed in the plan should be migrated.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param volume_id: The volume for which the migration plan will be generated.
One-Of ('resource'): at most one of 'volume_id', 'snapshot_id' could be set.
Expand Down Expand Up @@ -4136,12 +4136,12 @@ async def apply_block_migration(
) -> None:
"""
Migrate a volume and/or snapshots to SBS (Scaleway Block Storage).
To be used, this RPC must be preceded by a call to PlanBlockMigration. To migrate all resources mentioned in the MigrationPlan, the validation_key returned in the MigrationPlan must be provided.
:param validation_key: A value to be retrieved from a call to PlanBlockMigration, to confirm that the volume and/or snapshots specified in said plan should be migrated.
To be used, the call to this endpoint must be preceded by a call to the "Plan a migration" endpoint. To migrate all resources mentioned in the migration plan, the validation_key returned in the plan must be provided.
:param validation_key: A value to be retrieved from a call to the "Plan a migration" endpoint, to confirm that the volume and/or snapshots specified in said plan should be migrated.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param volume_id: The volume to migrate, along with potentially other resources, according to the migration plan generated with a call to PlanBlockMigration.
:param volume_id: The volume to migrate, along with potentially other resources, according to the migration plan generated with a call to the "Plan a migration" endpoint.
One-Of ('resource'): at most one of 'volume_id', 'snapshot_id' could be set.
:param snapshot_id: The snapshot to migrate, along with potentially other resources, according to the migration plan generated with a call to PlanBlockMigration.
:param snapshot_id: The snapshot to migrate, along with potentially other resources, according to the migration plan generated with a call to the "Plan a migration" endpoint.
One-Of ('resource'): at most one of 'volume_id', 'snapshot_id' could be set.

Usage:
Expand Down
4 changes: 2 additions & 2 deletions scaleway-async/scaleway_async/instance/v1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1491,7 +1491,7 @@ class SecurityGroupTemplate:
class ApplyBlockMigrationRequest:
validation_key: str
"""
A value to be retrieved from a call to PlanBlockMigration, to confirm that the volume and/or snapshots specified in said plan should be migrated.
A value to be retrieved from a call to the "Plan a migration" endpoint, to confirm that the volume and/or snapshots specified in said plan should be migrated.
"""

zone: Optional[Zone]
Expand Down Expand Up @@ -3004,7 +3004,7 @@ class MigrationPlan:

validation_key: str
"""
A value to be passed to ApplyBlockMigrationRequest, to confirm that the execution of the plan is being requested.
A value to be passed to the call to the "Apply a migration plan" endpoint, to confirm that the execution of the plan is being requested.
"""

volume: Optional[Volume]
Expand Down
10 changes: 5 additions & 5 deletions scaleway/scaleway/instance/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4094,7 +4094,7 @@ def plan_block_migration(
) -> MigrationPlan:
"""
Get a volume or snapshot's migration plan.
Given a volume or snapshot, returns the migration plan for a call to the RPC ApplyBlockMigration. This plan will include zero or one volume, and zero or more snapshots, which will need to be migrated together. This RPC does not perform the actual migration itself, ApplyBlockMigration must be used. The validation_key value returned by this call must be provided to the ApplyBlockMigration call to confirm that all resources listed in the plan should be migrated.
Given a volume or snapshot, returns the migration plan for a call to the "Apply a migration plan" endpoint. This plan will include zero or one volume, and zero or more snapshots, which will need to be migrated together. This endpoint does not perform the actual migration itself, the "Apply a migration plan" endpoint must be used. The validation_key value returned by this endpoint must be provided to the call to the "Apply a migration plan" endpoint to confirm that all resources listed in the plan should be migrated.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param volume_id: The volume for which the migration plan will be generated.
One-Of ('resource'): at most one of 'volume_id', 'snapshot_id' could be set.
Expand Down Expand Up @@ -4136,12 +4136,12 @@ def apply_block_migration(
) -> None:
"""
Migrate a volume and/or snapshots to SBS (Scaleway Block Storage).
To be used, this RPC must be preceded by a call to PlanBlockMigration. To migrate all resources mentioned in the MigrationPlan, the validation_key returned in the MigrationPlan must be provided.
:param validation_key: A value to be retrieved from a call to PlanBlockMigration, to confirm that the volume and/or snapshots specified in said plan should be migrated.
To be used, the call to this endpoint must be preceded by a call to the "Plan a migration" endpoint. To migrate all resources mentioned in the migration plan, the validation_key returned in the plan must be provided.
:param validation_key: A value to be retrieved from a call to the "Plan a migration" endpoint, to confirm that the volume and/or snapshots specified in said plan should be migrated.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param volume_id: The volume to migrate, along with potentially other resources, according to the migration plan generated with a call to PlanBlockMigration.
:param volume_id: The volume to migrate, along with potentially other resources, according to the migration plan generated with a call to the "Plan a migration" endpoint.
One-Of ('resource'): at most one of 'volume_id', 'snapshot_id' could be set.
:param snapshot_id: The snapshot to migrate, along with potentially other resources, according to the migration plan generated with a call to PlanBlockMigration.
:param snapshot_id: The snapshot to migrate, along with potentially other resources, according to the migration plan generated with a call to the "Plan a migration" endpoint.
One-Of ('resource'): at most one of 'volume_id', 'snapshot_id' could be set.

Usage:
Expand Down
4 changes: 2 additions & 2 deletions scaleway/scaleway/instance/v1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1491,7 +1491,7 @@ class SecurityGroupTemplate:
class ApplyBlockMigrationRequest:
validation_key: str
"""
A value to be retrieved from a call to PlanBlockMigration, to confirm that the volume and/or snapshots specified in said plan should be migrated.
A value to be retrieved from a call to the "Plan a migration" endpoint, to confirm that the volume and/or snapshots specified in said plan should be migrated.
"""

zone: Optional[Zone]
Expand Down Expand Up @@ -3004,7 +3004,7 @@ class MigrationPlan:

validation_key: str
"""
A value to be passed to ApplyBlockMigrationRequest, to confirm that the execution of the plan is being requested.
A value to be passed to the call to the "Apply a migration plan" endpoint, to confirm that the execution of the plan is being requested.
"""

volume: Optional[Volume]
Expand Down