Unified Compute Framework¶
Introduction¶
UCF Registry¶
Prerequisites¶
Getting Started¶
UCF Microservice Specification¶
- UCF Microservice
- UCF Application
- Microservice Builder Input Specification
- Input Directory Structure
- Manifest file -
manifest.yaml - Configs Directory -
configs - Scripts Directory -
scripts - Container Configs Directory -
containers - Endpoint Definition Files Directory -
endpoints - 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
- UCF Microservice Compliance
- Secrets Management
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
- Final Application Graph File
- Parameters File
- Using UCF Studio
- Using Textual Representation and CLI Tools
- Building an Application
- Deploy an Application
- Adding Monitoring to UCF Applications
- Log Management for UCF Applications
- Exporting an Application as UCF Microservice
Microservice Development¶
- Creating a Microservice
- Building a microservice
- 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
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
- Sharing Storage between Pod Replicas
- Partial Redeployment of App
- 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
- UCX support in UCF
Tools Reference¶
- UCF Studio
- Remote Access
- 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
- UCF Microservice Builder CLI
- UCF Application Builder CLI
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 UCF Studio
- Can I change the default paths for registry and config?
- CLI
service listoperations do not seem to do anything - CLI
service synccommand fails with error “An unhandled error occured!” repo syncoperation fails for local repository- Parameters file exported from UCF Studio does not work
- Uninstall UCF Tools