github.com/NVIDIA/aistore@v1.3.23-0.20240517131212-7df6609be51d/docs/docs.md (about)

     1  ---
     2  layout: post
     3  title: DOCUMENTATION
     4  permalink: /docs
     5  redirect_from:
     6   - /docs.md/
     7   - /docs/docs.md/
     8  ---
     9  
    10  ### Introduction
    11  
    12  - [Brief overview](/README.md)
    13  - [In-depth overview](/docs/overview.md)
    14  - [Getting started](/docs/getting_started.md)
    15  - [CLI: overview, getting started](/docs/cli.md)
    16  - [CLI: reference guide](https://github.com/NVIDIA/aistore/blob/main/docs/cli.md#cli-reference)
    17  - [Blogs](https://aiatscale.org/blog)
    18  - [Deployment](https://github.com/NVIDIA/aistore/tree/main/deploy)
    19  
    20  ## Guides and References
    21  
    22  - [Getting Started](/docs/getting_started.md)
    23  - [Technical Blog](https://aiatscale.org/blog)
    24  - API and SDK
    25    - [Go (language) API](https://github.com/NVIDIA/aistore/tree/main/api)
    26    - [Python SDK](https://github.com/NVIDIA/aistore/tree/main/python/aistore), and also:
    27      - [pip package](https://pypi.org/project/aistore/)
    28      - [reference guide](/docs/python_sdk.md)
    29    - [REST API](/docs/http_api.md)
    30      - [Easy URL](/docs/easy_url.md)
    31  - Amazon S3
    32    - [`s3cmd` client](/docs/s3cmd.md)
    33    - [S3 compatibility](/docs/s3compat.md)
    34    - [Presigned S3 requests](/docs/s3compat.md#presigned-s3-requests)
    35    - [Boto3 support](https://github.com/NVIDIA/aistore/tree/main/python/aistore/botocore_patch)
    36  - [CLI](/docs/cli.md)
    37    - [`ais help`](/docs/cli/help.md)
    38    - [Reference guide](https://github.com/NVIDIA/aistore/blob/main/docs/cli.md#cli-reference)
    39    - [Monitoring](/docs/cli/show.md)
    40      - [`ais show cluster`](/docs/cli/show.md)
    41      - [`ais show performance`](/docs/cli/show.md)
    42      - [`ais show job`](/docs/cli/show.md)
    43    - [Cluster and node management](/docs/cli/cluster.md)
    44    - [Mountpath (disk) management](/docs/cli/storage.md)
    45    - [Attach, detach, and monitor remote clusters](/docs/cli/cluster.md)
    46    - [Start, stop, and monitor downloads](/docs/cli/download.md)
    47    - [Distributed shuffle](/docs/cli/dsort.md)
    48    - [User account and access management](/docs/cli/auth.md)
    49    - [Jobs](/docs/cli/job.md)
    50  - Security and Access Control
    51    - [Authentication Server (AuthN)](/docs/authn.md)
    52  - Tutorials
    53    - [Tutorials](/docs/tutorials/README.md)
    54    - [Videos](/docs/videos.md)
    55  - Power tools and extensions
    56    - [Reading, writing, and listing *archives*](/docs/archive.md)
    57    - [Distributed Shuffle](/docs/dsort.md)
    58    - [Downloader](/docs/downloader.md)
    59    - [Extract, Transform, Load](/docs/etl.md)
    60    - [Tools and utilities](/docs/tools.md)
    61  - Benchmarking and tuning Performance
    62    - [AIS Load Generator: integrated benchmark tool](/docs/aisloader.md)
    63    - [How to benchmark](/docs/howto_benchmark.md)
    64    - [Performance tuning and testing](/docs/performance.md)
    65    - [Performance monitoring](/docs/cli/performance.md)
    66  - Buckets and Backend Providers
    67    - [Backend providers](/docs/providers.md)
    68    - [Buckets](/docs/bucket.md)
    69  - Storage Services
    70    - [CLI: `ais show storage` and subcommands](/docs/cli/show.md)
    71    - [CLI: `ais storage` and subcommands](/docs/cli/storage.md)
    72    - [Storage Services](/docs/storage_svcs.md)
    73    - [Checksumming: brief theory of operations](/docs/checksum.md)
    74    - [S3 compatibility](/docs/s3compat.md)
    75  - Cluster Management
    76    - [Node lifecycle: maintenance mode, rebalance/rebuild, shutdown, decommission](/docs/lifecycle_node.md)
    77    - [CLI: `ais cluster` and subcommands](/docs/cli/show.md)
    78    - [Joining AIS cluster](/docs/join_cluster.md)
    79    - [Leaving AIS cluster](/docs/leave_cluster.md)
    80    - [Global Rebalance](/docs/rebalance.md)
    81    - [Troubleshooting](/docs/troubleshooting.md)
    82  - Configuration
    83    - [Configuration](/docs/configuration.md)
    84    - [Environment variables](/docs/environment-vars.md)
    85    - [CLI: `ais config`](/docs/cli/config.md)
    86    - [Feature flags](/docs/feature_flags.md)
    87  - Observability
    88    - [Observability](/docs/metrics.md)
    89    - [Prometheus](/docs/prometheus.md)
    90    - [CLI: `ais show performance`](/docs/cli/show.md)
    91  - For users and developers
    92    - [Getting started](/docs/getting_started.md)
    93    - [Docker](/docs/docker_main.md)
    94    - [Useful scripts](/docs/development.md)
    95    - Profiling, race-detecting, and more
    96  - Batch jobs
    97    - [Batch operations](/docs/batch.md)
    98    - [eXtended Actions (xactions)](/xact/README.md)
    99    - [CLI: `ais job`](/docs/cli/job.md) and [`ais show job`](/docs/cli/show.md)
   100  - Assorted Topics
   101    - [System files](/docs/sysfiles.md)
   102    - [Switching cluster between HTTP and HTTPS](/docs/switch_https.md)
   103    - [TLS: testing with self-signed certificates](/docs/getting_started.md#tls-testing-with-self-signed-certificates)
   104    - [Feature flags](/docs/feature_flags.md)
   105    - [`aisnode` command line](/docs/command_line.md)
   106    - [Traffic patterns](/docs/traffic_patterns.md)
   107    - [Highly available control plane](/docs/ha.md)
   108    - [Start/stop maintenance mode, shutdown, decommission, and related operations](/docs/lifecycle_node.md)
   109    - [Downloader](/docs/downloader.md)
   110    - [On-disk layout](/docs/on_disk_layout.md)
   111    - [Buckets: definition, operations, properties](https://github.com/NVIDIA/aistore/blob/main/docs/bucket.md#bucket)
   112    - [Out of band updates](/docs/out_of_band.md)