V-IPU Administrator Guide

• 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
    • 6.2.2. Clusters
    • 6.2.3. Allocations
    • 6.2.4. Partitions
  • 6.3. Cluster topologies
    • 6.3.1. IPU-Link topologies
    • 6.3.2. GW-Link topologies
  • 6.4. Cluster tests
    • 6.4.1. List of cluster tests
    • 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
    • 8.2.2. Generate a Zsh completion script
  • 8.3. Create entities
    • 8.3.1. Create an agent
    • 8.3.2. Create an allocation
    • 8.3.3. Create a cluster
    • 8.3.4. Create a partition
    • 8.3.5. Create a user
  • 8.4. Discover entities
    • 8.4.1. Discover agents
  • 8.5. List entities
    • 8.5.1. List connected agents
    • 8.5.2. List allocations
    • 8.5.3. List available clusters
    • 8.5.4. List IPUs
    • 8.5.5. List IPU attributes
    • 8.5.6. List partitions in an allocation
    • 8.5.7. List active users
  • 8.6. Get info about an entity
    • 8.6.1. Get info for an agent
    • 8.6.2. Get allocation
    • 8.6.3. Get info for a cluster
    • 8.6.4. Get info for a partition
  • 8.7. Remove entities
    • 8.7.1. Remove an agent
    • 8.7.2. Remove an allocation
    • 8.7.3. Remove a cluster
    • 8.7.4. Remove a partition
    • 8.7.5. Remove a user
  • 8.8. Rename entities
    • 8.8.1. Rename an agent
    • 8.8.2. Rename a cluster
  • 8.9. Reset entities
    • 8.9.1. Reset a partition
  • 8.10. Test entities
    • 8.10.1. Test a cluster
• 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