DOCUMENTATION

Introduction

• Brief overview
• In-depth overview
• Getting started
• CLI: overview, getting started
• CLI: reference guide
• Blogs
• Deployment

Guides and References

• Getting Started
• Technical Blog
• API and SDK
  • Go (language) API
  • Python SDK, and also:
    • pip package
    • reference guide
  • REST API
    • Easy URL
• Amazon S3
  • s3cmd client
  • S3 compatibility
  • Presigned S3 requests
  • Boto3 support
• CLI
  • ais help
  • Reference guide
  • Monitoring
    • ais show cluster
    • ais show performance
    • ais show job
  • Cluster and node management
  • Mountpath (disk) management
  • Attach, detach, and monitor remote clusters
  • Start, stop, and monitor downloads
  • Distributed shuffle
  • User account and access management
  • Jobs
• Security and Access Control
  • Authentication Server (AuthN)
• Power tools and extensions
  • Reading, writing, and listing archives
  • Distributed Shuffle (dsort)
  • Initial Sharding utility (ishard)
  • Downloader
  • Extract, Transform, Load
  • Tools and utilities
• Benchmarking and tuning Performance
  • AIS Load Generator: integrated benchmark tool
  • How to benchmark
  • Performance tuning and testing
  • Performance monitoring
• Buckets and Backend Providers
  • Backend providers
  • Buckets
• Storage Services
  • CLI: ais show storage and subcommands
  • CLI: ais storage and subcommands
  • Storage Services
  • Checksumming: brief theory of operations
  • S3 compatibility
• Cluster Management
  • Node lifecycle: maintenance mode, rebalance/rebuild, shutdown, decommission
  • CLI: ais cluster and subcommands
  • Joining AIS cluster
  • Leaving AIS cluster
  • Global Rebalance
  • Troubleshooting
• Configuration
  • Configuration
  • Environment variables
  • CLI: ais config
  • Feature flags
• Observability
  • Prometheus
    • Reference: all supported metrics
  • Observability overview: StatsD and Prometheus, logs, and CLI
  • CLI: ais show performance
• For users and developers
  • Getting started
  • Docker
  • Useful scripts
  • Profiling, race-detecting and more
• Batch jobs
  • Batch operations
  • eXtended Actions (xactions)
  • CLI: ais job and ais show job, including:
    • prefetch remote datasets
    • copy (list, range, and/or prefix) selected objects or entire (in-cluster or remote) buckets
    • download remote BLOBs
    • promote NFS or SMB share
• Assorted Topics
  • Virtual directories
  • System files
  • HTTPS: loading, reloading, and generating certificates; switching cluster between HTTP and HTTPS
    • Managing TLS Certificates
  • Feature flags
  • aisnode command line
  • Traffic patterns
  • Highly available control plane
  • Start/stop maintenance mode, shutdown, decommission, and related operations
  • Downloader
  • On-disk layout
  • Buckets: definition, operations, properties
  • Out-of-band updates