skyplane.api.client

Classes

SkyplaneClient([aws_config, azure_config, ...])

Client for initializing cloud provider configurations.

class skyplane.api.client.SkyplaneClient(aws_config=None, azure_config=None, gcp_config=None, transfer_config=None, log_dir=None)

Bases: object

Client for initializing cloud provider configurations.

Parameters:

• aws_config (class AWSConfig (optional)) – aws cloud configurations

• azure_config (class AzureConfig (optional)) – azure cloud configurations

• gcp_config (class GCPConfig (optional)) – gcp cloud configurations

• transfer_config (class TransferConfig (optional)) – transfer configurations

• log_dir (str (optional)) – path to store transfer logs

copy(src, dst, recursive=False, num_vms=1)

A simple version of Skyplane copy. It automatically waits for transfer to complete (the main thread is blocked) and deprovisions VMs at the end.

Parameters:

• src (str) – Source prefix to copy from

• dst (str) – The destination of the transfer

• recursive (bool) – If true, will copy objects at folder prefix recursively (default: False)

• num_vms (int) – The maximum number of instances to use per region (default: 1)

dataplane(src_cloud_provider, src_region, dst_cloud_provider, dst_region, solver_type='direct', solver_required_throughput_gbits=1, n_vms=1, n_connections=32, debug=False)

Create a dataplane and calculates the transfer topology.

Parameters:

• src_cloud_provider (str) – the name of the source cloud provider

• src_region (str) – the name of the source region bucket

• dst_cloud_provider (str) – the name of the destination cloud provider

• dst_region (str) – the name of the destination region bucket

• type (str) – the type of the solver for calculating the topology (default: “direct”)

• num_vms (int) – The maximum number of instances to use per region (default: 1)

• n_connections (int) – The maximum number of connections to use in topology per region (default: 32)

• debug (bool) – If true, will print debug logs (default: False)

Return type:

Dataplane