Cloud Functions Developer Documentation

Cloud Functions

• Overview
  
  • Function Types
  • Getting Started
• Quickstart
  
  • Clone, Build and Push the Docker Image to NGC Private Registry
  • Create & Deploy the Function Using the Cloud Functions UI
  • Create & Deploy the Function Using the Cloud Functions API
  • Create & Deploy the Function Using the NGC CLI
  • Invoke the Function
• API
  
  • OpenAPI Specification
  • Authorization
    
    • Generate an NGC Personal API Key
    • API Key Scopes and Domains
    • JWT Based Authorization
  • Using the NVCF Invocation API
    
    • HTTP (Polling)
      
      • Polling After Initial Invocation
      • Large Responses (302 Status Code)
    • HTTP Streaming
      
      • Advantages of HTTP Streaming
    • gRPC
  • Statuses and Errors
    
    • Inference Container Status Codes and Responses
    • NVCF API Status Codes
    • Common Function Invocation Errors
• Function Lifecycle
  
  • Key Concepts
  • Function States
  • Workflow
  • Function Lifecycle Endpoints
    
    • Function Creation, Management & Deployment
      
      • Function Metadata
    • Function Invocation
    • Asset Management
    • Visibility, Cluster Groups & GPUs
• Function Creation
  
  • Working with NGC Private Registry
    
    • Generate an NGC Personal API Key
    • Download & Configure the NGC CLI
    • Authenticate with NGC Docker Registry
    • (Optional) Push a Container to NGC Private Registry
  • Container-Based Function Creation
    
    • Resources
    • Container Endpoints
    • Composing a FastAPI Container
      
      • Create the “requirements.txt” File
      • Implement the Server
      • Create the Dockerfile
      • Build the Container & Create the Function
    • Composing a PyTriton Container
      
      • Create the “requirements.txt” File
      • Create the “run.py” File
      • Create the “Dockerfile”
      • Build the Docker Image
      • Push the Docker Image
      • Create the Function
      • Additional Examples
    • Triton-based Container Configuration
      
      • Configuration
    • Creating Functions with NGC Models & Resources
    • Creating gRPC-based Functions
      
      • Prerequisites
      • gRPC Function Creation via UI
      • gRPC Function Creation via CLI
      • gRPC Function Creation via API
      • gRPC Function Invocation
    • Available Container Variables
    • Adding Partial Response (Progress)
      
      • Storing Partial and Complete Outputs
      • Creating a Progress File
      • Best Practices
  • Model-Only Function Creation
    
    • Model Creation Resources
    • Upload the Model
    • Create a Model-Only Function
  • Helm-Based Function Creation
    
    • Prerequisites
    • Secret Management
    • Create a Helm-based Function
    • Limitations
    • Helm Chart Overrides
• Function Deployment
  
  • Deployment Validation
  • Deploying a Function
    
    • Key Concepts
    • Deploy via the UI
    • Deploy via API
    • Deploy via CLI
    • Delete a Deployment
  • Deployment Failures
• Function Management
  
  • Function Versioning
  • Shared & Public Functions
  • Function Debugging
  • Logging and Metrics
    
    • Emit and View Inference Container Logs
      
      • How to Add Logs to Your Inference Container
    • View Function Metrics
• Function Permissions
  
  • Listing Functions via API
• Asset Management
  
  • Creating an Asset Id and Pre-signed Upload URL
  • Uploading Assets to Cloud Storage
  • Listing Assets
  • Deleting Assets
  • Specifying Assets when invoking a Function
  • Using Assets with Custom Containers
  • Retrieving Asset Directory and Asset ID in Triton Python Backend
• Cluster Setup & Management
  
  • Prerequisites
    
    • Supported Kubernetes Versions
    • Considerations
  • Register the Cluster
    
    • Configuration
    • Advanced Settings
      
      • Caching Support
    • Install the Cluster Agent
  • View & Validate Cluster Setup
    
    • Verify Cluster Agent Installation via UI
    • Verify Cluster Agent Installation via Terminal
  • Cluster Agent Monitoring and Reliability
    
    • Monitoring Data
      
      • Metrics
      • Logs
      • Tracing
    • Cluster Key Rotation
  • Advanced: NVCA Operator Configuration Options
    
    • NVCA Operator Parameters
    • NGC Configuration
    • Node Selector Configuration
    • OpenTelemetry Configuration
  • Advanced: Manual Instance Configuration