STRATISYSTEM API GUIDE
API guide for StratiSTOR, StratiSERV, and HyperSERV.
There are several API which govern the management and operation of the StratiSYSTEM OS.
CLUSTERED STORAGE SERVICE API (REST)
StratiSTOR provides RESTful APIs and command-line tools (like ceph, rados, rbd, and cephfs) to manage and monitor storage clusters. It supports object, block, and file storage and is used to build scalable, fault-tolerant storage infrastructures.
Purpose: Distributed, software-defined storage platform that supports object, block, and file interfaces.
API Interface: RESTful (Ceph Manager modules), CLI tools (ceph, rados, rbd, cephfs), and libraries.
Typical Operations:
- Cluster Management: Add/remove OSDs, monitor health, rebalance data.
- Block Storage (RBD): Create/delete RBD images, snapshot/clone, map/unmap devices.
- Object Storage (RGW): S3/Swift-compatible operations like uploading objects, creating buckets.
- File System (CephFS): Mount CephFS, create directories, manage quotas and permissions.
- Monitoring and Metrics: Query cluster usage, pool stats, I/O performance, and alerts.
- Authentication: Manage user keys and access rights.
API documentation can be found here: Ceph RESTful API
VM HYPERVISOR API
Libvirt exposes a stable C-based API (also accessible via bindings like Python, Go) for managing virtual machines and virtualization platforms like KVM, QEMU, and Xen. It provides control over VM lifecycle, storage, networking, and resource usage.
Purpose: Unified API to manage virtualization platforms such as KVM, QEMU, and Xen.
API Interface: Native C API, exposed over a daemon (libvirtd), accessible via CLI (virsh) and language bindings.
Typical Operations:
- VM Lifecycle: Create, start, stop, pause, resume, reboot, and destroy VMs.
- Resource Allocation: Assign CPU, memory, disk, and network interfaces to VMs.
- Storage Management: Create and manage virtual disk volumes and pools.
- Network Configuration: Define virtual bridges, NAT, and isolated networks.
- Snapshots: Take live snapshots of VMs, revert to previous states.
- Monitoring: Retrieve VM metrics like CPU, memory, and I/O usage.
- Remote Access: Connect to and control VMs on remote hosts.
API documentation can be found here: Libvirt API Reference Manual
OPENSTACK API (REST)
OpenStack offers a suite of RESTful APIs (e.g., Nova, Neutron, Cinder, Glance) that collectively manage compute, networking, block storage, image services, identity, and orchestration in cloud environments. Each component has its own API for modular control.
Purpose: Modular cloud computing platform for managing compute, storage, and networking resources.
API Interface: RESTful APIs for each component (Nova, Neutron, Cinder, Glance, Keystone, etc.)
Typical Operations:
- Compute (Nova):
- Boot, stop, resize, migrate virtual machines.
- Schedule VMs on specific hosts or availability zones.
- Networking (Neutron):
- Create and manage networks, subnets, routers, floating IPs, and security groups.
- Block Storage (Cinder):
- Create, attach, detach, and snapshot block volumes.
- Image Management (Glance):
- Upload, list, and manage VM images.
- Identity (Keystone):
- Manage users, projects (tenants), roles, and authentication tokens.
- Orchestration (Heat):
- Deploy infrastructure as code using templates (stacks).
- Dashboard (Horizon):
- GUI-based access to most OpenStack services.
API documentation can be found here: OpenStack API Reference
KUBERNETES API (REST)
API Summary:
Kubernetes exposes a RESTful API that serves as the control plane for managing containerized workloads. It enables CRUD operations on resources like Pods, Deployments, Services, and more. The API is used by kubectl, operators, and other integrations.
Purpose: Container orchestration platform for automating deployment, scaling, and management of containerized applications.
API Interface: RESTful API server (kube-apiserver) with CLI (kubectl), client libraries, and operator pattern.
Typical Operations:
- Workload Management:
- Create and manage Pods, Deployments, StatefulSets, DaemonSets, and CronJobs.
- Service Discovery and Networking:
- Define Services, Ingress rules, and Network Policies.
- Storage Integration:
- Create Persistent Volumes (PVs) and Persistent Volume Claims (PVCs).
- Dynamically provision storage using StorageClasses.
- Configuration and Secrets:
- Manage ConfigMaps, Secrets, and environment variables.
- Scaling and Auto-healing:
- Scale applications up/down, use Horizontal Pod Autoscalers.
- Automatically replace failed containers.
- Monitoring and Logging:
- Integrate with Prometheus, Grafana, and EFK/ELK stacks.
- Role-Based Access Control (RBAC):
- Define access policies per user, group, or service account.
- Custom Resources and Operators:
- Extend Kubernetes with CRDs (Custom Resource Definitions) and custom controllers.
API documentation can be found here: Kubernetes API Guide
STRATISYSTEM CLUSTER API (REST)
The StratiSYSTEM OS API provides a unified interface for managing compute, storage, networking, and service orchestration across the distributed cluster. It is the central control point for automation, integration, and direct manipulation of cluster resources and operations within the StratiSERV and StratiSTOR environments.
The latest API/SDK can be found here: /files/stratisystem_api_sdk_guide.pdf