Logo
V-IPU Administrator Guide
Version: latest
  • 1. Introduction
    • 1.1. Terminology and concepts
    • 1.2. Scope of the document
    • 1.3. Structure of the document
  • 2. Concepts and architecture
    • 2.1. Architecture
  • 3. Installation
    • 3.1. V-IPU agents
    • 3.2. V-IPU controller
      • 3.2.1. Initialisation
      • 3.2.2. Service execution
      • 3.2.3. Upgrading
    • 3.3. V-IPU admin client
    • 3.4. Installation script
      • 3.4.1. Uninstall
  • 4. Securing the installation
    • 4.1. Enabling mutual TLS
    • 4.2. Decoupling user and admin API end points
  • 5. Users and allocations
    • 5.1. Users
    • 5.2. Allocations
  • 6. Clusters
    • 6.1. Overview
    • 6.2. Cluster entities
      • 6.2.1. Agent entity
        • Agent auto-discovery
      • 6.2.2. Clusters
        • IPU-Link Domains
      • 6.2.3. Allocations
      • 6.2.4. Partitions
    • 6.3. Cluster topologies
      • 6.3.1. IPU-Link topologies
        • Mesh
        • Torus
      • 6.3.2. GW-Link topologies
        • Looped
        • Switched
    • 6.4. Cluster tests
      • 6.4.1. List of cluster tests
        • Sync test
        • IPU-Link training test
        • Traffic test
        • GW traffic test
        • GW-Link test
        • Version consistency test
        • Cabling test
        • PFC-settings test
      • 6.4.2. Cluster tests dependencies
  • 7. V-IPU monitoring
    • 7.1. Expose monitoring metrics in V-IPU
      • 7.1.1. V-IPU exporter
      • 7.1.2. V-IPU exporter metrics description
    • 7.2. V-IPU controller
    • 7.3. Example V-IPU / Prometheus integration
      • 7.3.1. Prometheus configuration
      • 7.3.2. V-IPU controller / Prometheus integration
      • 7.3.3. Using Grafana for visualization
  • 8. Admin command line reference
    • 8.1. Global options
      • 8.1.1. Using a configuration file
      • 8.1.2. Using environment variables
    • 8.2. Script generation
      • 8.2.1. Generate a Bash completion script
        • Supported options
      • 8.2.2. Generate a Zsh completion script
        • Supported options
    • 8.3. Create entities
      • 8.3.1. Create an agent
        • Supported options
      • 8.3.2. Create an allocation
        • Supported options
      • 8.3.3. Create a cluster
        • Supported options
      • 8.3.4. Create a partition
        • IPUoF configuration file
        • Supported options
      • 8.3.5. Create a user
        • Supported options
    • 8.4. Discover entities
      • 8.4.1. Discover agents
        • Supported options
    • 8.5. List entities
      • 8.5.1. List connected agents
        • Supported options
      • 8.5.2. List allocations
        • Supported options
      • 8.5.3. List available clusters
        • Supported options
      • 8.5.4. List IPUs
        • Supported options
      • 8.5.5. List IPU attributes
        • Supported options
      • 8.5.6. List partitions in an allocation
        • Supported options
      • 8.5.7. List active users
        • Supported options
    • 8.6. Get info about an entity
      • 8.6.1. Get info for an agent
        • Supported options
      • 8.6.2. Get allocation
        • Supported options
      • 8.6.3. Get info for a cluster
        • Supported options
      • 8.6.4. Get info for a partition
        • Supported options
    • 8.7. Remove entities
      • 8.7.1. Remove an agent
        • Supported options
      • 8.7.2. Remove an allocation
        • Supported options
      • 8.7.3. Remove a cluster
        • Supported options
      • 8.7.4. Remove a partition
        • Supported options
      • 8.7.5. Remove a user
        • Supported options
    • 8.8. Rename entities
      • 8.8.1. Rename an agent
        • Supported options
      • 8.8.2. Rename a cluster
        • Supported options
    • 8.9. Reset entities
      • 8.9.1. Reset a partition
        • Supported options
    • 8.10. Test entities
      • 8.10.1. Test a cluster
        • Supported options
  • 9. Server command line reference
    • 9.1. Global options
      • 9.1.1. Using a configuration file
      • 9.1.2. Using environment variables
  • 10. Legal notices
V-IPU Administrator Guide

10. Legal notices

Graphcloud®, Graphcore® and Poplar® are registered trademarks of Graphcore Ltd.

Bow™, Bow-2000™, Bow Pod™, Colossus™, In-Processor-Memory™, IPU-Core™, IPU-Exchange™, IPU-Fabric™, IPU-Link™, IPU-M2000™, IPU-Machine™, IPU-POD™, IPU-Tile™, PopART™, PopDist™, PopLibs™, PopRun™, PopVision™, PopTorch™, Streaming Memory™ and Virtual-IPU™ are trademarks of Graphcore Ltd.

All other trademarks are the property of their respective owners.

Copyright © 2016-2020 Graphcore Ltd. All rights reserved.

Previous

Revision 73f8874d.

Read the Docs v: latest