Unified Cloud Services Tools (UCS Tools)

Introduction

• Overview
  • Concepts
    • Microservice Specification
    • Microservice
    • Application
    • Microservice Registry
  • UCS Tools
    • UCS Studio
    • Microservice Builder CLI
    • Application Builder CLI
• Release Content
• Acronyms and Terms
• Release Notes
  • 2.8.1 on November 15, 2024
    • New Features
    • Bug Fixes
  • 2.6.0-rc1
    • Bug Fixes
    • New Featuers
  • 2024.08.0
    • Bug Fixes
    • New Features
  • 24.06.5
    • New Features
  • 2024.03 2.5 (24.03.5)
    • Bug Fixes
    • New Features
  • 2023.10 2.0
    • UCS Microservice Builder CLI
    • UCS Application Builder CLI
  • 2023.09 2.0
    • UCS Microservice Builder CLI
    • UCS Application Builder CLI
    • OV based NVIDIA UCS Studio

Registry

• UCS Tools Registry
  • Microservice Contents
  • Local Repository
  • NGC Repository

Prerequisites

• Development System
  • Install the Ubuntu Operating System
  • Install CUDA Drivers
  • Install Docker CE
  • Install NVIDIA Container Toolkit
  • Install Helm
• Prerequisites
• Create Your NGC Personal Key
  • Deployment System
    • MicroK8s for Developer System
      • Install MicroK8s
      • Enable Addons
    • NVIDIA Cloud Native Stack for Developer System
      • Install the Ubuntu Operating System
    • Install CUDA Drivers
      • Install Docker CE
      • Install NVIDIA Container Toolkit
      • Install Containerd
      • Install Kubernetes
      • Disable swap
      • Intialize Kubernetes
      • Install the latest version of Helm
      • Add additional node
      • Install GPU Operator
      • Validating the GPU Operator
    • NVIDIA Cloud Native Stack for AWS
      • EC2 Instance Configuration
      • Installing Containerd
      • Install Kubernetes
      • Install Helm
      • Install GPU Operator
    • AWS Elastic Kubernetes Service (AWS EKS)
      • Start Holoscan Ready EKS Cluster
      • Install NVIDIA Cloud Native Add-On Pack on AWS EKS (Optional)
        • Connect with AWS Managed Services
      • Troubleshooting
      • Delete Holoscan Ready EKS Cluster
    • Azure Kubernetes Service (Microsoft AKS)
      • Start Holoscan Ready AKS Cluster
      • Install NVIDIA Cloud Native Add-On Pack on Azure AKS (Optional)
        • Connect with Azure Managed Services
      • Troubleshooting
      • Delete Holoscan Ready AKS Cluster
    • Google Kubernetes Engine (GCP GKE)
      • Start Holoscan Ready GKE Cluster
      • Install NVIDIA Cloud Native Add-On Pack on GKE (Optional)
        • Connect with GCP Managed Services
      • Troubleshooting
      • Delete Holoscan Ready GKE Cluster

Getting Started

• Install UCS Tools
  • Debian Installation
  • UCS Tools Container Image
  • Verify the installation
    • MS Builder
    • App Builder
• Launch UCS Studio
  • Repo Setup
  • Sync Microservices
• Create an Reference Application
  • Prerequisites
  • Create New Graph
    • Search for Microservices and their Details
  • Add Microservices
  • Connect Microservices
  • Configure Microservices
  • Save the Graph
• Build the Reference Application
• Update the Reference Application
  • Open Existing Graph
  • Add / Replace Microservices
  • Connect Microservices
  • Load Parameters
  • Update Application Information
  • Save and Build the Application
• Deploy the Reference Application
  • Deploy on local MicroK8S cluster
  • Deploy application on AWS
  • Interact with the Reference Application
    • UCS Text Bot Application
    • UCS Speech Bot
• Migrating from UCS Tools 1.1
  • For Microservices
  • For Applications

Microservice Specification

• UCS Microservice
  • Creating a Microservice
  • Microservice location
  • Viewing Microservice Information
    • Basic Information
    • Ingress Endpoints
    • Egress Endpoints
    • Parameters
    • Secrets
    • External Files
    • Metrics
    • Compliance
    • Documentation
• UCS Tools Application
  • Creating an Application
  • Sample Application - Visual Format
    • Basic Information
    • Dependencies
    • Components
    • Connections
    • Secrets
    • Application Features
• Microservice Builder Input Specification
  • Input Directory Structure
  • Manifest file - manifest.yaml
    • Basic Information
    • Ingress Endpoints
    • Egress Endpoints
    • Parameters
    • Secrets
    • External Files
    • Metrics
    • Tests
    • Spec
      • Components
      • Adding components to the spec
  • Configs Directory - configs
  • Scripts Directory - scripts
  • Container Configs Directory - containers
  • Endpoint Definition Files Directory - endpoints
  • Customized Helm Template Directory - templates
  • Manual Compliance Test Results - manual_compliance_test_results.yaml
  • Documentation - README.md
  • License - LICENSE.txt
  • Changelog - changelog.txt
  • Tests Directory - tests
  • Values file values.yaml
• Endpoints
  • Ingress Endpoints
  • Egress Endpoints
  • UCS Endpoint Schemes
    • HTTP
    • gRPC
    • AsyncIO
    • RTSP
    • RESP
    • UCX
    • MongoDB Wire
    • Raw UDP / TCP
  • Endpoint Connections & Validation
  • Egress Endpoint with Multiple Connections
  • External Endpoints
• UCS Microservice Compliance
  • View Microservice Compliance - CLI Tools
  • View Microservice Compliance - UCS Studio
  • UCS Microservice Compliance Rules
    • Summary
    • Details
• Secrets Management
  • Specifying secret requirements in Microservice
  • Viewing secrets requirements of a microservice
    • Using CLI Tools
    • Using UCS Studio
  • Fulfill the secrets in an UCS Application
    • Using UCS Studio
    • Using Textual Representation and CLI Tools
  • Supported Secret Management Types
    • Using Kubernetes Secret
    • Using Vault secrets
    • Using Secrets Store CSI Driver
    • Using cert-manager Certificate
  • Application Information - Secrets
• UCS Microservice Additional Features
  • Horizontal Pod Autoscaler (HPA) support

Application Development

• Creating an Application
  • Using Textual Representation and CLI Tools
    • Set the NGC API Key
    • List Available Microservices
    • View Information of Microservices
    • Create Application Boilerplate
    • Update App Information
    • Update Dependencies
    • Add and Configure Microservices
    • Implicitly Added Parameters
    • Configuring Secrets
    • Connect Microservice Endpoints
    • Add Detailed Documentation
    • Value Spec File for Deployment
  • Using UCS Studio
• Building an Application
  • Using CLI Tools
    • Parameter files
    • Value spec file
  • Using UCS Studio
  • Build Output
• Deploy an Application with Helm
• Deploy an Application to NVCF
  • Create the App Manifest
  • Create the NVCF Configuration file for UCS Tools
  • Deploy the UCS App to NVCF
• Adding Monitoring to UCS Tools Applications
  • Prerequisites
  • PodMonitor resources
  • Custom labels for the PodMonitor resource
  • Verify the pods are being scraped
  • Application Information - Metrics
• Log Management for UCS Tools Applications
  • Prerequisites
  • Enable Logging in MicroK8s Cluster
    • Enable the EFK stack
    • Create a new index pattern
    • View logs
• Exporting an Application as UCS Microservice
  • Using CLI Tools
    • Export App as Microservice
    • Using the new microservice in an application
    • Export Information File Format
  • Using Studio
    • Export App as Microservice
    • Using the new microservice in an application
• Additional Application Features
  • Using The Same Microservice Component Multiple Times In an App
  • Interfacing with the NVIDIA K8s RAG Operator

Microservice Development

• Creating a Microservice
  • Generate scaffolding
    • Pre-built Container Images
    • Container Build Config
    • Pre-built Helm Chart
  • Updating Microservice Builder Input
    • Update configs
    • Update scripts
    • Adding Container Build config files to containers
    • Update endpoints
    • Update manual_compliance_test_results.yaml
    • Add tests
    • Update values.yaml
    • Update Documentation
  • Updating Manifest file manifest.yaml
    • Spec
      • Components
      • Commonly used components
      • Adding components to the spec
      • Using container builder config
• Building a microservice
  • Build Output
• Microservice Builder Components
  • Deployment
  • Container
  • Init Container
  • Volume
  • Volume Claim Template
  • Default Volume Mount
  • Persistent Volume Claim
  • Service
  • Image Pull Secret
  • ConfigMap
  • Pod Annotations
  • Pod Labels
  • Pod Security Context
  • Container Restart Policy
  • Pod DNS Policy
  • PVC Retention Policy
  • Pod Management Policy
  • Job Options
  • Job Deadline
  • CronJob Schedule
  • Restart Pod On Config Changes
  • Ingress
  • Application Workload
  • UCX Configuration
  • Custom Metadata
  • Pod Scheduling Specification
  • Service Account Specification
  • Pod Monitor Custom Resource Definition

Tutorials

• Hello World
  • Housekeeping
  • Introduction
  • Creating a Microservice
  • Building Microservices with ucf_ms_builder_cli
  • Creating Applications using Microservices - CLI Tools and Textual Format
  • Building Applications with ucf_app_builder_cli
  • Creating and Building Application using Studio
  • Deploying and Running Microservices and Applications
  • Inspecting and Debugging Microservices and Applications
  • Stopping and Cleaning up Microservices and Applications
• Connecting Microservices
  • Housekeeping
  • Introduction
  • Defining Microservices using Ingress/Egress Endpoints
  • Creating the Application:
  • Building Microservices and Applications
  • Creating and Building Application using Studio
  • Deploying and Running Microservices and Application
  • Inspecting and Debugging Microservices and Applications
  • Stopping and Cleaning up Microservices and Applications
• Adding Storage
  • Housekeeping
  • Introduction
  • Local Path Provisioner
  • Defining and Adding PVs and PVCs to Microservices
  • Building Microservices and Applications and Deploying them
  • Inspecting and Debugging Microservices and Application
  • Stopping and Cleaning up Microservices and Applications
• Sharing Storage between Pod Replicas
  • Housekeeping
  • Introduction
  • Updating the microservices and application
  • Building Microservices and Applications and Deploying them
  • Inspecting and Debugging Microservices and Application
  • Stopping and Cleaning up Microservices and Applications
  • Some Notes
• Partial Redeployment of App
  • Housekeeping
  • Introduction
  • Updating the microservices and application
  • Building Microservices and Applications and Deploying them
  • Inspecting and Debugging Microservices and Application
  • Redeploying the application
  • Stopping and Cleaning up Microservices and Applications
  • Some Notes
• Restarting Pods on Config Changes
  • Housekeeping
  • Introduction
  • Inspect current microservices and resources
  • Updating the parameters in the application
  • Building the Application and Partial Redeployment
  • Inspecting the Microservices and Application
  • Adding Dependency on configmaps
  • Rebuild and Redeploy the Microservice and Application
  • Inspect the Redeployed Application
  • Update the Config Param and Rebuild and Redeploy the application
  • Rebuild and Redeploy the Application
  • Inspect the Redeployed Application
  • Stopping and Cleaning up Microservices and Applications
  • Some Notes
• Passing files to a Microservice
  • Housekeeping
  • Introduction
  • Updating the microservices and application
  • Updating the parameters in the application
  • Building Microservices and Applications and Deploying them
  • Inspecting the Microservices and Application
  • Stopping and Cleaning up Microservices and Applications
  • Some Notes
• UCX support in UCS Tools
  • Sample UCX Server Microservice
  • Sample UCX Client Microservice
  • Adding and connecting microservices with UCX endpoints in UCS Application
  • Deploying UCS Applications with UCX
    • Hardware requirements
    • Pre-requisites
      • Network Operator
      • Multus Service Controller
      • Disable the coredns cache
    • Deploying the application

Reference

• UCS Studio
  • Remote Access
    • Comparison of available options
      • Omniverse Streaming Client
    • Installation and Usage
    • Configuration
    • Server
    • Client
      • WebRTC streaming
    • Current Limitations:
  • Repo Sync
  • Create a New Graph
  • Add and Remove Microservices
  • Multiple Selection
  • Connect and Disconnect Microservices
  • Copy/Cut/Paste a Service
  • Undo and redo
  • Canvas Pan and Zoom
  • Node Collapse and Expansion
  • Graph Layout and Focus
  • Inspect and Change Service Properties
  • Save and Load a Graph
  • Import and Export Parameters
  • Build the App and Generate Helm Charts
• UCS Microservice Builder CLI
  • Basic Operations
    • Viewing Help
    • Checking the Tool Version
  • Service Command service
    • Create Microservice Scaffolding
    • Building a Microservice
    • List Available Microservices
    • List Available Microservice Versions
    • View Microservice Information
    • Synchronize a Microservice
  • Registry Command registry
    • Set NGC API Key
    • List Available Repositories
    • View Information for a Repository
    • Synchronize All Microservices in a Repository
    • Clear Local Repository
    • Set the Registry Cache Path
    • View the Registry Cache Path
    • Clear the Registry Cache
  • Component Command component
    • List Components
    • View Information for a Component
    • Add Custom Components
• UCS Application Builder CLI
  • Basic Operations
    • Viewing Help
    • Checking the Tool Version
  • Application Command app
    • Create Application Boilerplate
    • Building an Application
    • Exporting an Application as a microservice
  • Service Command service
    • List Available Microservices
    • List Available Microservice Versions
    • View Microservice Information
    • Synchronize a Microservice
  • Registry Command registry
    • Set NGC API Key
    • List Available Repositories
    • View Information for a Repository
    • Synchronize All Microservices in a Repository
    • Clear Local Repository
    • Set the Registry Cache Path
    • View the Registry Cache Path
    • Clear the Registry Cache

Frequently Asked Questions

• FAQ
  • The app build command seems to be stuck?
  • Failed to load/export parameters of a graph
  • Unable to delete a backdrop
  • Graph is broken after sync up from the registry
  • Application builder CLI hangs
  • Unable to run WebSocket streaming with UCS Studio
  • Can I change the default paths for registry and config?
  • CLI service list operations do not seem to do anything
  • CLI service sync command fails with error “An unhandled error occured!”
  • repo sync operation fails for local repository
  • Parameters file exported from UCS Studio does not work
  • Uninstall UCS Tools

Licenses

• Licenses