Skip to main content
Ctrl+K
OSMO Documentation - Home OSMO Documentation - Home

OSMO Documentation

  • User Guide
  • Deployment Guide
main release/6.0 release/6.1 release/6.2 release/6.3 release/6.4
  • GitHub
OSMO Documentation - Home OSMO Documentation - Home

OSMO Documentation

  • User Guide
  • Deployment Guide
main release/6.0 release/6.1 release/6.2 release/6.3 release/6.4
  • GitHub

Table of Contents

Introduction

  • Overview
  • Architecture
  • What’s Next

Requirements

  • Cloud
  • Tools
  • Networking
  • Instances

Getting Started

  • Setup Infrastructure
  • Create Data Storage
    • AWS S3
    • Azure Blob Storage
    • Google Cloud Storage
    • Torch Object Storage
  • Deploy Service

Bring Your Own Compute (BYOC)

  • Create K8s Cluster
    • Cloud Provider
    • On-Premise
  • Install Dependencies
  • Deploy Backend Operator
  • Run Workflows
  • Add Observability (Optional)

Advanced Configuration

  • Overview
  • Resource Pools
  • Resource Validation
  • Pod Templates
  • Group Templates
  • Scheduler Configuration
  • Rsync Configuration
  • Workload Identity for Workflow Pods
  • Workflow Labels
  • MCP

References

  • Configuration API
    • /api/configs/service
    • /api/configs/workflow
    • /api/configs/backend
    • /api/configs/pool
    • /api/configs/pod_template
    • /api/configs/group_template
    • /api/configs/resource_validation
    • /api/configs/role
  • Configuration CLI
    • osmo config show
    • osmo config update
    • osmo config list
    • osmo config history
    • osmo config diff
    • osmo config delete
    • osmo config set
    • osmo config rollback
    • osmo config tag
  • User CLI
    • osmo user list
    • osmo user create
    • osmo user get
    • osmo user update
    • osmo user delete
    • osmo token set
    • osmo token list
    • osmo token roles
    • osmo token delete

Additional Resources

  • Quickstart
  • Single-plane Deployment
  • Understanding Task Execution
  • Keycloak as a sample IdP
  • Authentication and Authorization
    • Authentication Flow
    • Roles and Policies
    • Creating Users and Assigning Roles
    • Identity Provider (IdP) Setup
    • IdP Role Mapping and Sync Modes
    • Service Accounts
  • Deployment Guide
  • Tools

Tools#

Helm CLI

Package manager for Kubernetes.

Required for deploying OSMO service and backend operator.

https://helm.sh/docs/intro/install
kubectl

Kubernetes command-line tool.

Required for managing and inspecting cluster resources.

https://kubernetes.io/docs/tasks/tools/install-kubectl/
OSMO Client

OSMO client.

Required for accessing the OSMO service.

Install Client

previous

Cloud

next

Networking

NVIDIA NVIDIA
Privacy Policy | Manage My Privacy | Do Not Sell or Share My Data | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2025 NVIDIA CORPORATION & AFFILIATES.

Last updated on Sep 03, 2026.