Skip to main content

CLI tool for K8sVMGr - Kubernetes VM Manager

Project description

k8s-agent

CLI tool for K8sVMGr - Kubernetes VM Manager

Installation

pip install k8s-agent

Quick Start

Authentication

# Login to your K8sVMGr account
k8s-agent login

# Check who you're logged in as
k8s-agent whoami

# Logout
k8s-agent logout

VM Management

# List all VMs
k8s-agent list

# Create a CPU VM
k8s-agent create --cpu 16

# Create a GPU VM
k8s-agent create --gpu 2 --gpu-model A800-80G-R

# Check availability before creating
k8s-agent create --gpu 4 --gpu-model A800-80G-R --check

# Delete a VM
k8s-agent delete <vm-id>

# Force delete (skip backup)
k8s-agent delete <vm-id> --force

VM Inspection

# View VM events
k8s-agent events <vm-id>

# View VM logs
k8s-agent logs <vm-id>
k8s-agent logs <vm-id> --tail 100

# View VM dashboard with visual metrics
k8s-agent dashboard <vm-id>

VM Operations

# Interconnect all running VMs for SSH access
k8s-agent interconnect

Features

  • 🔐 OAuth 2.0 Device Flow Authentication - Secure login via web browser
  • 📊 Visual Dashboard - Beautiful ASCII charts showing GPU/CPU metrics
  • 🚀 VM Lifecycle Management - Create, delete, and monitor VMs
  • 📈 Resource Monitoring - Real-time metrics with gauges and sparklines
  • 🔗 VM Interconnection - Setup SSH between VMs for distributed computing
  • 🎯 Tab Completion - Fast command completion (future feature)

Configuration

k8s-agent stores authentication tokens in ~/.k8s-agent/config.json.

You can override the API URL with the --api-url flag or set the K8S_AGENT_API_URL environment variable.

Requirements

  • Python 3.8+
  • Access to a K8sVMGr backend instance

Development

# Clone the repository
git clone https://github.com/yourusername/k8s-agent.git
cd k8s-agent

# Install in development mode
pip install -e .

# Run tests
pytest

License

MIT License

Support

For issues and feature requests, please visit: https://github.com/yourusername/k8s-agent/issues

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

k8s_agent-0.3.0.tar.gz (18.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

k8s_agent-0.3.0-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

Details for the file k8s_agent-0.3.0.tar.gz.

File metadata

  • Download URL: k8s_agent-0.3.0.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.6

File hashes

Hashes for k8s_agent-0.3.0.tar.gz
Algorithm Hash digest
SHA256 8cd442b67a7a7778d9ef51674d56a7c26bf8bd67633dd78ee14f7f344a72347f
MD5 22aa0283862bc74fc82b18e0735754e5
BLAKE2b-256 e72161aab882e4666da5cbbd4eae86f39ed57e3921fb5577c25dfec8760beb71

See more details on using hashes here.

File details

Details for the file k8s_agent-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: k8s_agent-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 19.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.6

File hashes

Hashes for k8s_agent-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 672cedfae9b964e81d4eba01fc6a5f1bef12bb592135c3aa78ca53550f3794ab
MD5 7aaf9a533c394a672c0f2893e793a266
BLAKE2b-256 1254a7934caf01ca33f895d39586d376a4ed9a7c1d20afa52eb599dd0594ea06

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page