skypilot-nightly 1.0.0.dev2024053101__py3-none-any.whl → 1.0.0.dev2025022801__py3-none-any.whl

sky/provision/vast/utils.py

@@ -0,0 +1,162 @@
+# pylint: disable=assignment-from-no-return
+#
+# The pylint exception above is an accomodation for
+# false positives generated by pylint for the Vast
+# python sdk.
+#
+"""Vast library wrapper for SkyPilot."""
+from typing import Any, Dict, List
+
+from sky import sky_logging
+from sky.adaptors import vast
+
+logger = sky_logging.init_logger(__name__)
+
+
+def list_instances() -> Dict[str, Dict[str, Any]]:
+    """Lists instances associated with API key."""
+    instances = vast.vast().show_instances()
+
+    instance_dict: Dict[str, Dict[str, Any]] = {}
+    for instance in instances:
+        instance['id'] = str(instance['id'])
+        info = instance
+
+        if isinstance(instance['actual_status'], str):
+            info['status'] = instance['actual_status'].upper()
+        else:
+            info['status'] = 'UNKNOWN'
+        info['name'] = instance['label']
+
+        instance_dict[instance['id']] = info
+
+    return instance_dict
+
+
+def launch(name: str, instance_type: str, region: str, disk_size: int,
+           image_name: str, preemptible: bool) -> str:
+    """Launches an instance with the given parameters.
+
+    Converts the instance_type to the Vast GPU name, finds the specs for the
+    GPU, and launches the instance.
+
+    Notes:
+
+      *  `georegion`: This is a feature flag to provide an additional
+         scope of geographical specificy while maintaining backward
+         compatibility.
+
+      *  `chunked`: This is a feature flag to give breadth to the
+         snowflake nature of the vast catalog marketplace. It rounds
+         down various specifications of machines to emulate an instance
+         type and make them more interchangeable.
+
+      *  `disk_size`: We look for instances that are of the requested
+         size or greater than it. For instance, `disk_size=100` might
+         return something with `disk_size` at 102 or even 1000.
+
+         The disk size {xx} GB is not exactly matched the requested
+         size {yy} GB. It is possible to charge extra cost on disk.
+
+      *  `geolocation`: Geolocation on Vast can be as specific as the
+         host chooses to be. They can say, for instance, "Yutakachō,
+         Shinagawa District, Tokyo, JP." Such a specific geolocation
+         as ours would fail to return this host in a simple string
+         comparison if a user searched for "JP".
+
+         Since regardless of specificity, all our geolocations end
+         in two-letter country codes we just snip that to conform
+         to how many providers state their geolocation.
+
+      *  Since the catalog is cached, we can't gaurantee availability
+         of any machine at the point of inquiry.  As a consequence we
+         search for the machine again and potentially return a failure
+         if there is no availability.
+
+	  *  We pass in the cpu_ram here as a guarantor to make sure the
+		 instance we match with will be compliant with the requested
+		 amount of memory.
+
+      *  Vast instance types are an invention for skypilot. Refer to
+         service_catalog/vast_catalog.py for the current construction
+         of the type.
+
+    """
+    cpu_ram = float(instance_type.split('-')[-1]) / 1024
+    gpu_name = instance_type.split('-')[1].replace('_', ' ')
+    num_gpus = int(instance_type.split('-')[0].replace('x', ''))
+
+    query = ' '.join([
+        'chunked=true',
+        'georegion=true',
+        f'geolocation="{region[-2:]}"',
+        f'disk_space>={disk_size}',
+        f'num_gpus={num_gpus}',
+        f'gpu_name="{gpu_name}"',
+        f'cpu_ram>="{cpu_ram}"',
+    ])
+
+    instance_list = vast.vast().search_offers(query=query)
+
+    if isinstance(instance_list, int) or len(instance_list) == 0:
+        raise RuntimeError('Failed to create instances, could not find an '
+                           f'offer that satisfies the requirements "{query}".')
+
+    instance_touse = instance_list[0]
+
+    launch_params = {
+        'id': instance_touse['id'],
+        'direct': True,
+        'ssh': True,
+        'env': '-e __SOURCE=skypilot',
+        'onstart_cmd': ';'.join([
+            'touch ~/.no_auto_tmux',
+            f'echo "{vast.vast().api_key_access}" > ~/.vast_api_key',
+        ]),
+        'label': name,
+        'image': image_name,
+        'disk': disk_size
+    }
+
+    if preemptible:
+        launch_params['min_bid'] = instance_touse['min_bid']
+
+    new_instance_contract = vast.vast().create_instance(**launch_params)
+
+    new_instance = vast.vast().show_instance(
+        id=new_instance_contract['new_contract'])
+
+    return new_instance['id']
+
+
+def start(instance_id: str) -> None:
+    """Starts the given instance."""
+    vast.vast().start_instance(id=instance_id)
+
+
+def stop(instance_id: str) -> None:
+    """Stops the given instance."""
+    vast.vast().stop_instance(id=instance_id)
+
+
+def remove(instance_id: str) -> None:
+    """Terminates the given instance."""
+    vast.vast().destroy_instance(id=instance_id)
+
+
+def get_ssh_ports(cluster_name: str) -> List[int]:
+    """Gets the SSH ports for the given cluster."""
+    logger.debug(f'Getting SSH ports for cluster {cluster_name}.')
+
+    instances = list_instances()
+    possible_names = [f'{cluster_name}-head', f'{cluster_name}-worker']
+
+    ssh_ports = []
+
+    for instance in instances.values():
+        if instance['name'] in possible_names:
+            ssh_ports.append(instance['ssh_port'])
+    assert ssh_ports, (
+        f'Could not find any instances for cluster {cluster_name}.')
+
+    return ssh_ports

sky/provision/vsphere/common/vim_utils.py

@@ -56,7 +56,7 @@ def get_hosts_by_cluster_names(content, vcenter_name, cluster_name_dicts=None):
             'name': cluster.name
         } for cluster in cluster_view.view]
         cluster_view.Destroy()
-        if len(cluster_name_dicts) == 0:
+        if not cluster_name_dicts:
             logger.warning(f'vCenter \'{vcenter_name}\' has no clusters')
 
     # Retrieve all cluster names from the cluster_name_dicts

sky/provision/vsphere/instance.py

@@ -1,12 +1,9 @@
 """Vsphere instance provisioning."""
 import json
-import os
 import typing
 from typing import Any, Dict, List, Optional
 
-from sky import exceptions
 from sky import sky_logging
-from sky import status_lib
 from sky.adaptors import common as adaptors_common
 from sky.adaptors import vsphere as vsphere_adaptor
 from sky.clouds.service_catalog.common import get_catalog_path
@@ -18,6 +15,7 @@ from sky.provision.vsphere.common.vim_utils import poweroff_vm
 from sky.provision.vsphere.common.vim_utils import wait_for_tasks
 from sky.provision.vsphere.common.vim_utils import wait_internal_ip_ready
 from sky.provision.vsphere.vsphere_utils import VsphereClient
+from sky.utils import status_lib
 
 if typing.TYPE_CHECKING:
     import pandas as pd
@@ -30,7 +28,6 @@ TAG_SKYPILOT_CLUSTER_NAME = 'skypilot-cluster-name'
 TAG_SKYPILOT_HEAD_NODE = 'skypilot-head-node'
 HEAD_NODE_VALUE = '1'
 WORKER_NODE_VALUE = '0'
-PUBLIC_SSH_KEY_PATH = '~/.ssh/sky-key.pub'
 
 
 def run_instances(region: str, cluster_name: str,
@@ -162,7 +159,7 @@ def _create_instances(
     if not gpu_instance:
         # Find an image for CPU
         images_df = images_df[images_df['GpuTags'] == '\'[]\'']
-        if len(images_df) == 0:
+        if not images_df:
             logger.error(
                 f'Can not find an image for instance type: {instance_type}.')
             raise Exception(
@@ -185,7 +182,7 @@ def _create_instances(
         image_instance_mapping_df = image_instance_mapping_df[
             image_instance_mapping_df['InstanceType'] == instance_type]
 
-        if len(image_instance_mapping_df) == 0:
+        if not image_instance_mapping_df:
             raise Exception(f"""There is no image can match instance type named
                 {instance_type}
                 If you are using CPU-only instance, assign an image with tag
@@ -218,10 +215,9 @@ def _create_instances(
     hosts_df = hosts_df[(hosts_df['AvailableCPUs'] /
                          hosts_df['cpuMhz']) >= cpus_needed]
     hosts_df = hosts_df[hosts_df['AvailableMemory(MB)'] >= memory_needed]
-    assert len(hosts_df) > 0, (
-        f'There is no host available to create the instance '
-        f'{vms_item["InstanceType"]}, at least {cpus_needed} '
-        f'cpus and {memory_needed}MB memory are required.')
+    assert hosts_df, (f'There is no host available to create the instance '
+                      f'{vms_item["InstanceType"]}, at least {cpus_needed} '
+                      f'cpus and {memory_needed}MB memory are required.')
 
     # Sort the hosts df by AvailableCPUs to get the compatible host with the
     # least resource
@@ -303,13 +299,7 @@ def _create_instances(
 
     # Create the customization spec
     # Set up the VM's authorized_keys with customization spec
-    ssh_key_path = os.path.expanduser(PUBLIC_SSH_KEY_PATH)
-    if not os.path.exists(ssh_key_path):
-        logger.error('SSH pubic key does not exist.')
-        raise exceptions.ResourcesUnavailableError(
-            'SSH pubic key does not exist.')
-    with open(ssh_key_path, 'r', encoding='utf-8') as f:
-        ssh_public_key = f.read()
+    ssh_public_key = config.authentication_config['ssh_public_key']
 
     # Create a custom script to inject the ssh public key into the instance
     vm_user = config.authentication_config['ssh_user']
@@ -365,7 +355,7 @@ def _choose_vsphere_cluster_name(config: common.ProvisionConfig, region: str,
     skypilot framework-optimized availability_zones"""
     vsphere_cluster_name = None
     vsphere_cluster_name_str = config.provider_config['availability_zone']
-    if len(vc_object.clusters) > 0:
+    if vc_object.clusters:
         for optimized_cluster_name in vsphere_cluster_name_str.split(','):
             if optimized_cluster_name in [
                     item['name'] for item in vc_object.clusters

sky/provision/vsphere/vsphere_utils.py

@@ -257,7 +257,7 @@ class VsphereClient:
         # hard code here. should support configure later.
         profile_name = 'skypilot_policy'
         storage_profile_id = None
-        if len(profile_ids) > 0:
+        if profile_ids:
             profiles = pm.PbmRetrieveContent(profileIds=profile_ids)
             for profile in profiles:
                 if profile_name in profile.name: