Metadata-Version: 2.4
Name: paralleliq-skypilot-plugin
Version: 0.1.0
Summary: SkyPilot AdminPolicy that surfaces piqc GPU waste scanning when a GPU workload is launched on Kubernetes
Author-email: Paralleliq <engineering@paralleliq.ai>
License: Apache-2.0
Keywords: gpu,inference,kubernetes,paralleliq,piqc,skypilot
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.11
Requires-Dist: skypilot>=0.7.0
Description-Content-Type: text/markdown

# paralleliq-skypilot-plugin

A SkyPilot [AdminPolicy](https://docs.skypilot.co/en/latest/cloud-setup/policy.html) that surfaces [piqc](https://github.com/paralleliq/piqc) — Paralleliq's GPU waste scanner — when a GPU workload is launched on a Kubernetes cluster.

## What it does

When you run `sky launch` with GPU accelerators targeting a Kubernetes cluster, the policy prints instructions to run a free piqc scan on your cluster before the job starts.

## Install

```bash
pip install paralleliq-skypilot-plugin
```

## Configure

Add one line to `~/.sky/config.yaml`:

```yaml
admin_policy: paralleliq_skypilot_plugin.ParalleliqPolicy
```

## Usage

Run any GPU workload as normal:

```bash
sky launch -c my-cluster task.yaml
```

If the task requests GPU accelerators on a Kubernetes backend, you will see:

```
  Paralleliq — GPU workload detected on Kubernetes.
  Run a free GPU waste scan on this cluster before launching:

    kubectl apply -f https://raw.githubusercontent.com/paralleliq/piqc/main/deploy/rbac.yaml
    kubectl apply -f https://raw.githubusercontent.com/paralleliq/piqc/main/deploy/scan-job.yaml
    kubectl logs -n kube-system job/piqc-scan

  github.com/paralleliq/piqc  ·  paralleliq.ai
```

## License

Apache-2.0
