https://github.com/theracetrack/racetrack
An opinionated framework for deploying, managing, and serving application workloads
https://github.com/theracetrack/racetrack
deployment kubernetes machine-learning microservice mlops model-management racetrack
Last synced: 9 months ago
JSON representation
An opinionated framework for deploying, managing, and serving application workloads
- Host: GitHub
- URL: https://github.com/theracetrack/racetrack
- Owner: TheRacetrack
- License: apache-2.0
- Created: 2022-08-03T13:43:33.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-06-16T09:37:59.000Z (9 months ago)
- Last Synced: 2025-06-16T10:46:56.438Z (9 months ago)
- Topics: deployment, kubernetes, machine-learning, microservice, mlops, model-management, racetrack
- Language: Python
- Homepage: https://theracetrack.github.io/racetrack/
- Size: 6.44 MB
- Stars: 30
- Watchers: 5
- Forks: 6
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Racetrack
[](https://github.com/TheRacetrack/racetrack)
[](https://pypi.org/project/racetrack-client/)
[](https://theracetrack.github.io/racetrack)
[](https://github.com/TheRacetrack/racetrack/actions?query=workflow%3Atest)
[](https://join.slack.com/t/theracetrack/shared_invite/zt-26gv32boy-rT974~WV9WqDeJypE8ECzA)
Racetrack is a framework for deploying, managing, and serving application workloads.
## Features
Racetrack uses the notion of conventions to allow domain experts to produce
operationally sound and effective workloads without understanding the underlying
infrastructure.
It makes extensive use of plugins. Thus, the type of code which it can accept is
broad and covers languages such as Python 3 or Go,
and actual applications such as Sphinx, Drupal or even Quake 3.
These "jobs", in Racetrack lingo, can be deployed to different
"infrastructure targets". We currently support Kubernetes and Docker. This is
also pluggable and can be extended.
Code deployed via Racetrack gets free Swagger pages and Prometheus metrics endpoints.
What distinguishes Racetrack is:
- You only supply your **function's logic**. No need to write repetitive API code, setting up
webservers, creating dockerfiles, kubernetes YAMLs, and so on. Racetrack takes care of that for you.
- **Language agnostic**. Deploy code written in Python 3, Go, Rust,
or anything else encapsulated in a Dockerfile.
- **Infrastructure independent**. Deploy to either a Kubernetes cluster
or a Docker environment in a single transparent step.
## Example usage
Given a Python file like this:
```python
class Meow:
def perform(self, a, b):
"""Add numbers"""
return a + b
```
And a YAML file like this:
```yaml
name: adder
owner_email: meowmeow@example.com
jobtype: python3:latest
git:
remote: https://www.github.com/path/to-repo.git
python:
entrypoint_path: 'adder.py'
entrypoint_class: 'Meow'
```
You can
```bash
racetrack deploy
```
And the result is a micro-service with an API:
which can be monitored on a dashboard:
or called with a curl command:
[//]: # (created with https://carbon.now.sh/?bg=rgba%28255%2C255%2C255%2C1%29&t=material&wt=boxy&l=application%2Fx-sh&width=812&ds=true&dsyoff=20px&dsblur=68px&wc=true&wa=false&pv=56px&ph=56px&ln=false&fl=1&fm=Hack&fs=14px&lh=133%25&si=false&es=2x&wm=false&code=%2524%2520curl%2520-X%2520POST%2520%2522http%253A%252F%252Flocalhost%253A7005%252Fpub%252Fjob%252Fadder%252Flatest%252Fapi%252Fv1%252Fperform%2522%2520%255C%250A%2520%2520-H%2520%2522X-Racetrack-Auth%253A%2520eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZWVkIjoiY2UwODFiMDUtYTRhMC00MTRhLThmNmEtODRjMDIzMTkxNmE2Iiwic3ViamVjdCI6ImFkbWluIiwic3ViamVjdF90eXBlIjoidXNlciIsInNjb3BlcyI6bnVsbH0.xDUcEmR7USck5RId0nwDo_xtZZBD6pUvB2vL6i39DQI%2522%2520%255C%250A%2520%2520-H%2520%2522Content-Type%253A%2520application%252Fjson%2522%2520%255C%250A%2520%2520-d%2520%27%257B%2522a%2522%253A%252040%252C%2520%2522b%2522%253A%25202%257D%27%250A42)
## Getting started
Depending on your role, you may be insterested in different documents:
* Racetrack User:
- [Quickstart](docs/quickstart.md)
- [User Manual](docs/user/user-guide-1.md)
- [User Guide - Deploying a Job](docs/user/user-guide-2.md)
- [Available plugins](docs/user/available-plugins.md)
- [Installing plugins](docs/user/using-plugins.md)
- [Job Manifest File Schema](docs/manifest-schema.md)
- [Glossary](docs/glossary.md)
* Racetrack Admin:
- [Local Kubernetes Setup](docs/deployment/local-kubernetes-setup.md)
- [Installation to standalone host](docs/deployment/standalone-host.md)
- [Installation to Kubernetes](docs/deployment/k8s-installation.md)
* Racetrack Developer:
- [Developing plugins](docs/development/developing-plugins.md)
- [Job type plugins](docs/development/plugins-job-types.md)
- [Developer manual](docs/development/develop.md)
See the [Documentation Pages](https://theracetrack.github.io/racetrack/) for more details.
## Currently supported
### What can we deploy?
* [Python 3](https://github.com/TheRacetrack/plugin-python-job-type)
* [Go](https://github.com/TheRacetrack/plugin-go-job-type)
* [Rust](https://github.com/TheRacetrack/plugin-rust-job-type)
* [Any language wrapped in a Dockerfile](https://github.com/TheRacetrack/plugin-docker-proxy-job-type)
* [HUGO framework](https://github.com/TheRacetrack/plugin-hugo-job-type)
* [Drupal](https://github.com/TheRacetrack/plugin-docker-proxy-job-type/tree/master/sample/drupal)
* [Sphinx](https://github.com/TheRacetrack/plugin-docker-proxy-job-type/tree/master/sample/sphinx)
* [Quake III](https://github.com/iszulcdeepsense/racetrack-quake)
### Where can we deploy to?
* [local Kubernetes](https://github.com/TheRacetrack/plugin-kubernetes-infrastructure)
* [local Docker](https://github.com/TheRacetrack/plugin-docker-infrastructure)
* [remote Docker Daemon](https://github.com/TheRacetrack/plugin-remote-docker)
* [remote Kubernetes](https://github.com/TheRacetrack/plugin-remote-kubernetes)
## About
This software is copyright Erhvervsstyrelsen.
It is published under the [Apache 2.0 License](./LICENSE).
See [Copyright Notices](./docs/license/copyright-notices.md).
This project is a collaboration between [The Danish Business Authority](https://www.erhvervsstyrelsen.dk) and [deepsense.ai](https://deepsense.ai).