Developer Guide

This section provides comprehensive resources for developers who want to contribute to OME, extend its functionality, or integrate it with other systems.

Getting Started

Contributing to OME

Learn how to set up your development environment, follow coding guidelines, and submit contributions to the OME project.

Key Topics:

• Development environment setup
• Building and testing OME
• IDE configuration (VS Code, GoLand)
• Pull request process
• OME Enhancement Proposals (OEPs)

Architecture & Internals

Controller Architecture

Deep dive into OME’s controller architecture, including the controller manager, model controller, and model agent components.

API Design

Understanding OME’s API design principles, CRD structure, and how to extend the API.

Serving Runtime Development

Learn how to create custom serving runtimes for new inference engines or specialized deployment patterns.

Development Tools

Local Development Setup

Set up a local development environment for rapid iteration and testing.

Testing Strategies

Comprehensive guide to testing OME components, including unit tests, integration tests, and end-to-end testing.

Debugging Guide

Troubleshooting techniques and debugging tools for OME development.

Integration & Extension

Custom Resource Development

How to extend OME with custom resources and controllers for specialized use cases.

Webhook Development

Implementing admission webhooks for validation and mutation of OME resources.

Plugin Architecture

Understanding OME’s plugin system and how to develop custom plugins.

API Reference

Go Client Libraries

Using OME’s Go client libraries for programmatic interaction with the system.

REST API Reference

Complete REST API documentation for external integrations.

Prometheus Metrics

Available metrics for monitoring and observability integration.

Advanced Topics

Performance Optimization

Guidelines for optimizing OME performance and resource utilization.

Security Considerations

Security best practices for OME development and deployment.

Multi-Node Networking

Deep dive into OME’s multi-node networking capabilities and RDMA integration.

Release & Deployment

Release Process

Understanding OME’s release cycle and contribution to releases.

Container Image Management

Building, tagging, and managing OME container images.

Helm Chart Development

Contributing to and extending OME’s Helm charts.

Community & Governance

Development Roadmap

Current development priorities and future plans for OME.

Governance Model

Understanding OME’s governance structure and decision-making process.

Community Guidelines

Code of conduct and community interaction guidelines.

Quick References

Environment Variables

Complete list of environment variables used by OME components.

Make Targets

Reference for all available Makefile targets and their purposes.

Configuration Schema

JSON Schema references for all OME configuration files.

Examples & Tutorials

End-to-End Development Example

Complete walkthrough of implementing a new feature from concept to deployment.

Integration Examples

Real-world examples of integrating OME with other systems and tools.

Best Practices

Collected wisdom and patterns for effective OME development.