Internal package documentation#
skyplane.replicate.replicator_client module#
- class skyplane.replicate.replicator_client.ReplicatorClient(topology, gateway_docker_image='public.ecr.aws/s6m1p0n8/skyplane:edge', aws_instance_class='m5.4xlarge', azure_instance_class='Standard_D2_v5', gcp_instance_class='n2-standard-16', gcp_use_premium_network=True)[source]#
Bases:
object
- monitor_transfer(job, show_spinner=False, log_interval_s=None, log_to_file=True, time_limit_seconds=None, cleanup_gateway=True, save_log=True, write_profile=False, write_socket_profile=False, copy_gateway_logs=False, multipart=False)[source]#
- Return type:
- provision_gateways(reuse_instances=False, log_dir=None, authorize_ssh_pub_key=None, use_bbr=True, use_compression=True, use_e2ee=True, use_socket_tls=False, aws_use_spot_instances=False, azure_use_spot_instances=False, gcp_use_spot_instances=False)[source]#
skyplane.chunk module#
- class skyplane.chunk.Chunk(src_key, dest_key, chunk_id, chunk_length_bytes, md5_hash=None, file_offset_bytes=None, part_number=None, upload_id=None)[source]#
Bases:
object
A Chunk is a contiguous piece of a file (a file may be one or more chunks).
- class skyplane.chunk.ChunkRequest(chunk, src_region, dst_region, src_type, dst_type, src_random_size_mb=None, src_object_store_bucket=None, dst_object_store_bucket=None)[source]#
Bases:
object
A ChunkRequest stores all local state in the Gateway pertaining to a ChunkRequest.
- class skyplane.chunk.ChunkState(value)[source]#
Bases:
Enum
An enumeration.
- download_in_progress = 3#
- download_queued = 2#
- downloaded = 4#
- failed = 8#
- registered = 1#
- upload_complete = 7#
- upload_in_progress = 6#
- upload_queued = 5#
skyplane.config module#
- class skyplane.config.SkyplaneConfig(aws_enabled, azure_enabled, gcp_enabled, azure_principal_id=None, azure_subscription_id=None, azure_client_id=None, gcp_project_id=None, anon_clientid=None)[source]#
Bases:
object
skyplane.exceptions module#
- exception skyplane.exceptions.BadConfigException[source]#
Bases:
Exception
- args#
- with_traceback()#
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception skyplane.exceptions.ChecksumMismatchException[source]#
Bases:
SkyplaneException
- args#
- with_traceback()#
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception skyplane.exceptions.InsufficientVCPUException[source]#
Bases:
SkyplaneException
- args#
- with_traceback()#
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception skyplane.exceptions.MissingBucketException[source]#
Bases:
SkyplaneException
- args#
- with_traceback()#
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception skyplane.exceptions.MissingObjectException[source]#
Bases:
SkyplaneException
- args#
- with_traceback()#
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception skyplane.exceptions.NoSuchObjectException[source]#
Bases:
Exception
- args#
- with_traceback()#
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.