DOCUMENTATION
AIStore documentation is organized by task: getting started, accessing AIS via CLI/API/SDK, managing storage and clusters, deploying in production, and exploring advanced features.
Core Documentation
- Main README
- In-depth Overview
- Terminology and core abstractions
- Getting Started
- Networking model
- Buckets: design, operations, namespaces, and system buckets
- Observability overview
- CLI overview
- Production deployment
- Technical Blog
APIs, SDKs, and Compatibility
Command-Line Interface
- CLI overview
ais help- CLI reference guide
- Bucket operations
- Cluster and remote-cluster management
- Storage and mountpath management
- Monitoring and
ais show - Downloads
- Jobs
- Authentication and access control
- Configuration via CLI
- ETL CLI
- Distributed shuffle CLI
- ML / get-batch CLI
- GCP credentials
- TLS certificate management
Storage and Data Management
- Storage services
- Buckets: design, operations, namespaces, and system buckets
- Bucket lifecycle
- Native Bucket Inventory (NBI)
- Backend providers
- On-disk layout
- Virtual directories
- System files
- Evicting remote buckets and cached data
Cluster Operations
- Node lifecycle: maintenance, shutdown, decommission
- Joining a cluster
- Leaving a cluster
- Global rebalance
- Resilver
- Highly available control plane
- Information Center (IC)
- Out-of-band updates
- Troubleshooting
Configuration and Security
- Configuration
- Environment variables
- Feature flags
- AuthN and access control
- Authentication validation
- HTTPS and certificates
ETL and Advanced Workflows
- ETL overview
- ETL CLI docs
- ETL Python SDK examples
- Custom transformers
- ETL Python webserver SDK
- ETL Go webserver package
- Archives: read, write, and list
- Distributed shuffle (
dsort) - Initial sharding utility (
ishard) - Downloader
- Blob Downloader
- Batch object retrieval (get-batch)
- Batch operations
- Tools and utilities
- Extended actions (xactions)
Observability, Monitoring, and Performance
- Observability overview
- Monitoring with CLI
- Logs
- Prometheus integration
- Metrics reference
- Grafana dashboards
- Kubernetes monitoring
- Distributed tracing
- Monitoring get-batch
- AIS load generator (
aisloader) - Benchmarking AIStore
- Performance tuning and testing
- Performance monitoring via CLI
- Rate limiting
- Checksumming
- Filesystem Health Checker (FSHC)
- Traffic patterns
Networking
- Networking: multi-homing, network separation, IPv6
- HTTPS configuration
- Switching to HTTPS
- Idle connections
- MessagePack protocol
Deployment
- AIStore on Kubernetes
- Kubernetes Operator
- Ansible playbooks
- Helm charts
- Deployment monitoring
- Docker