kserve-storage 0.18.0rc0

KServe Storage Handler. This module is responsible to download the models from the provided source

kserve-storage

A Python module for handling model storage and retrieval for KServe. This package provides a unified API to download models from various storage backends including cloud providers, file systems, and model hubs.

Features

• Support for multiple storage backends:
  • Local file system
  • Google Cloud Storage (GCS)
  • Amazon S3
  • Azure Blob Storage
  • Azure File Share
  • HTTP/HTTPS URLs
  • HDFS/WebHDFS
  • Hugging Face Hub
• Automatic extraction of compressed files (zip, tar.gz, tgz)
• Configuration via environment variables
• Logging and error handling

Installation

pip install kserve-storage

Or with Poetry:

uv add kserve-storage

Usage

The main entry point is the Storage class which provides a download method:

from kserve_storage import Storage

# Download from GCS to a temporary directory
model_dir = Storage.download("gs://your-bucket/model")

# Download from S3 to a specific directory
model_dir = Storage.download("s3://your-bucket/model", "/path/to/destination")

Supported Storage Providers

Local File System

model_dir = Storage.download("file:///path/to/model")
# or using direct path
model_dir = Storage.download("/path/to/model")

Google Cloud Storage

model_dir = Storage.download("gs://bucket-name/model-path")

Amazon S3

model_dir = Storage.download("s3://bucket-name/model-path")

Azure Blob Storage

model_dir = Storage.download("https://account-name.blob.core.windows.net/container-name/model-path")

Azure File Share

model_dir = Storage.download("https://account-name.file.core.windows.net/share-name/model-path")

HTTP/HTTPS URLs

model_dir = Storage.download("https://example.com/path/to/model.zip")

HDFS

model_dir = Storage.download("hdfs://path/to/model")
# or WebHDFS
model_dir = Storage.download("webhdfs://path/to/model")

Hugging Face Hub

model_dir = Storage.download("hf://org-name/model-name")
# With specific revision
model_dir = Storage.download("hf://org-name/model-name:revision")

Environment Variables

Hugging Face Hub Configuration

These are all handled by the huggingface_hub package, you can see all the available environment variables here.

AWS/S3 Configuration / Environments variables

• AWS_ENDPOINT_URL: Custom endpoint URL for S3-compatible storage
• AWS_ACCESS_KEY_ID: Access key for S3
• AWS_SECRET_ACCESS_KEY: Secret access key for S3
• AWS_DEFAULT_REGION: AWS region
• AWS_CA_BUNDLE: Path to custom CA bundle
• S3_VERIFY_SSL: Enable/disable SSL verification
• S3_USER_VIRTUAL_BUCKET: Use virtual hosted-style URLs
• S3_USE_ACCELERATE: Use transfer acceleration
• S3_MAX_FILE_CONCURRENCY: Number of files to download in parallel
• S3_CONNECT_TIMEOUT: Connection timeout in seconds (default: 15)
• S3_READ_TIMEOUT: Read timeout in seconds (default: 30)
• S3_MAX_ATTEMPTS: Maximum retry attempts for S3 operations (default: 3)
• awsAnonymousCredential: Use unsigned requests for public access

Azure Configuration

• AZURE_STORAGE_ACCESS_KEY: Storage account access key
• AZ_TENANT_ID / AZURE_TENANT_ID: Azure AD tenant ID
• AZ_CLIENT_ID / AZURE_CLIENT_ID: Azure AD client ID
• AZ_CLIENT_SECRET / AZURE_CLIENT_SECRET: Azure AD client secret
• AZURE_MAX_FILE_CONCURRENCY: number of files to download parallel (blob only)
• AZURE_MAX_CHUNK_CONCURRENCY: number of chunks for each file to download parallel (blob only)

HDFS Configuration

• HDFS_SECRET_DIR: Directory containing HDFS configuration files
• HDFS_NAMENODE: HDFS namenode address
• USER_PROXY: User proxy for HDFS
• HDFS_ROOTPATH: Root path in HDFS
• KERBEROS_PRINCIPAL: Kerberos principal for authentication
• KERBEROS_KEYTAB: Path to Kerberos keytab file
• TLS_CERT, TLS_KEY, TLS_CA: TLS configuration files
• TLS_SKIP_VERIFY: Skip TLS verification
• N_THREADS: Number of download threads

Git Configuration (HTTPS-only)

• GIT_USERNAME, GIT_PASSWORD: Git HTTPS authentication (optional; username also parsed from url)

Storage Configuration

Storage configuration can be provided through environment variables:

• STORAGE_CONFIG: JSON string containing storage configuration
• STORAGE_OVERRIDE_CONFIG: JSON string to override storage configuration

License

Apache License 2.0 - See LICENSE for details.