skypilot-nightly 1.0.0.dev20250509__py3-none-any.whl → 1.0.0.dev20251107__py3-none-any.whl

sky/ssh_node_pools/__init__.py

@@ -0,0 +1 @@
+"""SSH Node Pool management package."""

sky/ssh_node_pools/core.py

@@ -0,0 +1,135 @@
+"""SSH Node Pool management core functionality."""
+import os
+from pathlib import Path
+from typing import Any, Dict, List
+
+import yaml
+
+from sky.utils import yaml_utils
+
+
+class SSHNodePoolManager:
+    """Manager for SSH Node Pool configurations."""
+
+    def __init__(self):
+        self.config_path = Path.home() / '.sky' / 'ssh_node_pools.yaml'
+        self.keys_dir = Path.home() / '.sky' / 'ssh_keys'
+        self.keys_dir.mkdir(parents=True, exist_ok=True)
+
+    def get_all_pools(self) -> Dict[str, Any]:
+        """Read all SSH Node Pool configurations from YAML file."""
+        if not self.config_path.exists():
+            return {}
+
+        try:
+            with open(self.config_path, 'r', encoding='utf-8') as f:
+                return yaml_utils.safe_load(f) or {}
+        except Exception as e:
+            raise RuntimeError(
+                f'Failed to read SSH Node Pool config: {e}') from e
+
+    def save_all_pools(self, pools_config: Dict[str, Any]) -> None:
+        """Write SSH Node Pool configurations to YAML file."""
+        try:
+            self.config_path.parent.mkdir(parents=True, exist_ok=True)
+            with open(self.config_path, 'w', encoding='utf-8') as f:
+                yaml.dump(pools_config, f, default_flow_style=False)
+        except Exception as e:
+            raise RuntimeError(
+                f'Failed to save SSH Node Pool config: {e}') from e
+
+    def update_pools(self, pools_config: Dict[str, Any]) -> None:
+        """Update SSH Node Pool configurations."""
+        all_pools = self.get_all_pools()
+        all_pools.update(pools_config)
+        self.save_all_pools(all_pools)
+
+    def add_or_update_pool(self, pool_name: str,
+                           pool_config: Dict[str, Any]) -> None:
+        """Add or update a single SSH Node Pool configuration."""
+        # Validate pool configuration
+        self._validate_pool_config(pool_config)
+
+        all_pools = self.get_all_pools()
+        all_pools[pool_name] = pool_config
+        self.save_all_pools(all_pools)
+
+    def delete_pool(self, pool_name: str) -> bool:
+        """Delete a SSH Node Pool configuration."""
+        all_pools = self.get_all_pools()
+        if pool_name in all_pools:
+            del all_pools[pool_name]
+            self.save_all_pools(all_pools)
+            return True
+        return False
+
+    def save_ssh_key(self, key_name: str, key_content: str) -> str:
+        """Save SSH private key to ~/.sky/ssh_keys/ directory."""
+        # Validate key name
+        if not key_name or '/' in key_name or key_name.startswith('.'):
+            raise ValueError('Invalid key name')
+
+        key_path = self.keys_dir / key_name
+        try:
+            with open(key_path, 'w', encoding='utf-8') as f:
+                f.write(key_content)
+            os.chmod(key_path, 0o600)  # Set secure permissions
+            return str(key_path)
+        except Exception as e:
+            raise RuntimeError(f'Failed to save SSH key: {e}') from e
+
+    def list_ssh_keys(self) -> List[str]:
+        """List available SSH key files."""
+        if not self.keys_dir.exists():
+            return []
+        try:
+            return [f.name for f in self.keys_dir.iterdir() if f.is_file()]
+        except Exception:  # pylint: disable=broad-except
+            return []
+
+    def _validate_pool_config(self, config: Dict[str, Any]) -> None:
+        """Validate SSH Node Pool configuration."""
+        if 'hosts' not in config:
+            raise ValueError('Pool configuration must include `hosts`')
+
+        if not isinstance(config['hosts'], list) or not config['hosts']:
+            raise ValueError('`hosts` must be a non-empty list')
+
+        # Validate user field
+        if not config.get('user', '').strip():
+            raise ValueError('Pool configuration must include `user`')
+
+        # Validate authentication - must have either identity_file or password
+        if not config.get('identity_file') and not config.get('password'):
+            raise ValueError('Pool configuration must include '
+                             'either `identity_file` or `password`')
+
+
+def get_all_pools() -> Dict[str, Any]:
+    """Get all SSH Node Pool configurations."""
+    manager = SSHNodePoolManager()
+    return manager.get_all_pools()
+
+
+def update_pools(pools_config: Dict[str, Any]) -> None:
+    """Update SSH Node Pool configurations."""
+    manager = SSHNodePoolManager()
+    manager.update_pools(pools_config)
+
+
+def delete_pool(pool_name: str) -> bool:
+    """Delete a SSH Node Pool configuration."""
+    manager = SSHNodePoolManager()
+    return manager.delete_pool(pool_name)
+
+
+def upload_ssh_key(key_name: str, key_content: str) -> str:
+    """Upload SSH private key."""
+    manager = SSHNodePoolManager()
+    return manager.save_ssh_key(key_name, key_content)
+
+
+def list_ssh_keys() -> List[str]:
+    """List available SSH keys."""
+    manager = SSHNodePoolManager()
+    return manager.list_ssh_keys()

sky/ssh_node_pools/server.py

@@ -0,0 +1,233 @@
+"""SSH Node Pool management API endpoints."""
+import re
+from typing import Any, Dict, List
+
+import fastapi
+
+from sky import core as sky_core
+from sky.server.requests import executor
+from sky.server.requests import payloads
+from sky.server.requests import request_names
+from sky.server.requests import requests as requests_lib
+from sky.ssh_node_pools import core as ssh_node_pools_core
+from sky.utils import common_utils
+
+router = fastapi.APIRouter()
+
+
+@router.get('')
+def get_ssh_node_pools() -> Dict[str, Any]:
+    """Get all SSH Node Pool configurations."""
+    try:
+        return ssh_node_pools_core.get_all_pools()
+    except Exception as e:
+        raise fastapi.HTTPException(
+            status_code=500,
+            detail=
+            f'Failed to get SSH Node Pools: {common_utils.format_exception(e)}')
+
+
+@router.post('')
+def update_ssh_node_pools(pools_config: Dict[str, Any]) -> Dict[str, str]:
+    """Update SSH Node Pool configurations."""
+    try:
+        ssh_node_pools_core.update_pools(pools_config)
+        return {'status': 'success'}
+    except Exception as e:
+        raise fastapi.HTTPException(status_code=400,
+                                    detail=f'Failed to update SSH Node Pools:'
+                                    f' {common_utils.format_exception(e)}')
+
+
+@router.delete('/{pool_name}')
+def delete_ssh_node_pool(pool_name: str) -> Dict[str, str]:
+    """Delete a SSH Node Pool configuration."""
+    try:
+        if ssh_node_pools_core.delete_pool(pool_name):
+            return {'status': 'success'}
+        else:
+            raise fastapi.HTTPException(
+                status_code=404,
+                detail=f'SSH Node Pool `{pool_name}` not found')
+    except fastapi.HTTPException:
+        raise
+    except Exception as e:
+        raise fastapi.HTTPException(status_code=500,
+                                    detail='Failed to delete SSH Node Pool: '
+                                    f'{common_utils.format_exception(e)}')
+
+
+@router.post('/keys')
+async def upload_ssh_key(request: fastapi.Request) -> Dict[str, str]:
+    """Upload SSH private key."""
+    try:
+        form = await request.form()
+        key_name = form.get('key_name')
+        key_file = form.get('key_file')
+
+        if not key_name or not key_file:
+            raise fastapi.HTTPException(status_code=400,
+                                        detail='Missing key_name or key_file')
+
+        key_content = await key_file.read()
+        key_path = ssh_node_pools_core.upload_ssh_key(key_name,
+                                                      key_content.decode())
+
+        return {'status': 'success', 'key_path': key_path}
+    except fastapi.HTTPException:
+        raise
+    except Exception as e:
+        raise fastapi.HTTPException(
+            status_code=500,
+            detail=
+            f'Failed to upload SSH key: {common_utils.format_exception(e)}')
+
+
+@router.get('/keys')
+def list_ssh_keys() -> List[str]:
+    """List available SSH keys."""
+    try:
+        return ssh_node_pools_core.list_ssh_keys()
+    except Exception as e:
+        exception_msg = common_utils.format_exception(e)
+        raise fastapi.HTTPException(
+            status_code=500, detail=f'Failed to list SSH keys: {exception_msg}')
+
+
+@router.post('/{pool_name}/deploy')
+async def deploy_ssh_node_pool(request: fastapi.Request,
+                               pool_name: str) -> Dict[str, str]:
+    """Deploy SSH Node Pool using existing ssh_up functionality."""
+    try:
+        ssh_up_body = payloads.SSHUpBody(infra=pool_name, cleanup=False)
+        await executor.schedule_request_async(
+            request_id=request.state.request_id,
+            request_name=request_names.RequestName.SSH_NODE_POOLS_UP,
+            request_body=ssh_up_body,
+            func=sky_core.ssh_up,
+            schedule_type=requests_lib.ScheduleType.LONG,
+        )
+
+        return {
+            'status': 'success',
+            'request_id': request.state.request_id,
+            'message': f'SSH Node Pool `{pool_name}` deployment started'
+        }
+    except Exception as e:
+        raise fastapi.HTTPException(status_code=500,
+                                    detail=f'Failed to deploy SSH Node Pool: '
+                                    f'{common_utils.format_exception(e)}')
+
+
+@router.post('/deploy')
+async def deploy_ssh_node_pool_general(
+        request: fastapi.Request,
+        ssh_up_body: payloads.SSHUpBody) -> Dict[str, str]:
+    """Deploys all SSH Node Pools."""
+    try:
+        await executor.schedule_request_async(
+            request_id=request.state.request_id,
+            request_name=request_names.RequestName.SSH_NODE_POOLS_UP,
+            request_body=ssh_up_body,
+            func=sky_core.ssh_up,
+            schedule_type=requests_lib.ScheduleType.LONG,
+        )
+
+        pool_name = ssh_up_body.infra or 'default'
+        return {
+            'status': 'success',
+            'request_id': request.state.request_id,
+            'message': f'SSH Node Pool `{pool_name}` deployment started'
+        }
+    except Exception as e:
+        raise fastapi.HTTPException(status_code=500,
+                                    detail=f'Failed to deploy SSH Node Pool: '
+                                    f'{common_utils.format_exception(e)}')
+
+
+@router.post('/{pool_name}/down')
+async def down_ssh_node_pool(request: fastapi.Request,
+                             pool_name: str) -> Dict[str, str]:
+    """Cleans up a SSH Node Pools."""
+    try:
+        ssh_up_body = payloads.SSHUpBody(infra=pool_name, cleanup=True)
+        await executor.schedule_request_async(
+            request_id=request.state.request_id,
+            request_name=request_names.RequestName.SSH_NODE_POOLS_DOWN,
+            request_body=ssh_up_body,
+            func=sky_core.ssh_up,  # Reuse ssh_up function with cleanup=True
+            schedule_type=requests_lib.ScheduleType.LONG,
+        )
+
+        return {
+            'status': 'success',
+            'request_id': request.state.request_id,
+            'message': f'SSH Node Pool `{pool_name}` teardown started'
+        }
+    except Exception as e:
+        raise fastapi.HTTPException(
+            status_code=500,
+            detail=f'Failed to tear down SSH Node Pool: '
+            f'{common_utils.format_exception(e)}')
+
+
+@router.post('/down')
+async def down_ssh_node_pool_general(
+        request: fastapi.Request,
+        ssh_up_body: payloads.SSHUpBody) -> Dict[str, str]:
+    """Cleans up all SSH Node Pools."""
+    try:
+        # Set cleanup=True for down operation
+        ssh_up_body.cleanup = True
+        await executor.schedule_request_async(
+            request_id=request.state.request_id,
+            request_name=request_names.RequestName.SSH_NODE_POOLS_DOWN,
+            request_body=ssh_up_body,
+            func=sky_core.ssh_up,  # Reuse ssh_up function with cleanup=True
+            schedule_type=requests_lib.ScheduleType.LONG,
+        )
+
+        pool_name = ssh_up_body.infra or 'default'
+        return {
+            'status': 'success',
+            'request_id': request.state.request_id,
+            'message': f'SSH Node Pool `{pool_name}` teardown started'
+        }
+    except Exception as e:
+        raise fastapi.HTTPException(
+            status_code=500,
+            detail=f'Failed to tear down SSH Node Pool: '
+            f'{common_utils.format_exception(e)}')
+
+
+@router.get('/{pool_name}/status')
+def get_ssh_node_pool_status(pool_name: str) -> Dict[str, str]:
+    """Get the status of a specific SSH Node Pool."""
+    try:
+        # Call ssh_status to check the context
+        context_name = f'ssh-{pool_name}'
+        is_ready, reason = sky_core.ssh_status(context_name)
+
+        # Strip ANSI escape codes from the reason text
+        def strip_ansi_codes(text):
+            if not text:
+                return text
+            # Remove ANSI escape sequences (color codes, formatting, etc.)
+            text = re.sub(r'\x1b\[[0-9;]*m', '', text)
+            # Remove 'disabled. Reason: ' prefix if present
+            text = text.replace('disabled. Reason: ', '')
+            return text
+
+        cleaned_reason = strip_ansi_codes(reason) if reason else reason
+
+        return {
+            'pool_name': pool_name,
+            'context_name': context_name,
+            'status': 'Ready' if is_ready else 'Not Ready',
+            'reason': cleaned_reason
+        }
+    except Exception as e:
+        raise fastapi.HTTPException(
+            status_code=500,
+            detail=f'Failed to get SSH Node Pool status: '
+            f'{common_utils.format_exception(e)}')