Skip to content
General-Purpose Kubernetes Pod Controller
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
build
cmd
doc
example
hack
pkg
vendor
.gitignore
Gopkg.lock Initial FrameworkController: General-Purpose Kubernetes Pod Controller Oct 22, 2018
Gopkg.toml
LICENSE
README.md

README.md

FrameworkController

FrameworkController is built to orchestrate all kinds of applications on Kubernetes by a single controller.

These kinds of applications include but not limited to:

  • Stateless and Stateful Service (Nginx, TensorFlow Serving, HBase, Kafka, etc)
  • Stateless and Stateful Batch (KD-Tree Building, Batch Data Processing, etc)
  • Any combination of above applications (Distributed TensorFlow Training, Stream Data Processing, etc)

Why Need It

Problem

In the open source community, there are so many specialized Kubernetes Pod controllers which are built for a specific kind of application, such as Kubernetes StatefulSet Controller, Kubernetes Job Controller, KubeFlow TFJob Operator. However, no one is built for all kinds of applications and combination of the existing ones still cannot support some kinds of applications. So, we have to learn, use, develop, deploy and maintain so many Pod controllers.

Solution

Build a General-Purpose Kubernetes Pod Controller: FrameworkController.

And then we can get below benefits from it:

Architecture

Architecture

Feature

Framework Feature

A Framework represents an application with a set of Tasks:

  1. Executed by Kubernetes Pod
  2. Partitioned to different heterogeneous TaskRoles which share the same lifecycle
  3. Ordered in the same homogeneous TaskRole by TaskIndex
  4. With consistent identity {FrameworkName}-{TaskRoleName}-{TaskIndex} as PodName
  5. With fine grained RetryPolicy for each Task and the whole Framework
  6. With fine grained FrameworkAttemptCompletionPolicy for each TaskRole
  7. Guarantees at most one instance of a specific Task is running at any point in time
  8. Guarantees at most one instance of a specific Framework is running at any point in time

Controller Feature

  1. Highly generalized as it is built for all kinds of applications
  2. Light-weight as it is only responsible for Pod orchestration
  3. Tolerate Pod/ConfigMap unexpected deletion, Node/Network/FrameworkController/Kubernetes failure
  4. Well-defined Framework consistency, state machine and failure model
  5. Idiomatic with Kubernetes official controllers, such as Pod Spec
  6. Compatible with other Kubernetes features, such as Kubernetes Service, Gpu Scheduling, Volume, Logging
  7. Aligned with Kubernetes Controller Design Guidelines and API Conventions

Prerequisite

  1. A Kubernetes cluster, v1.10 or above, on-cloud or on-premise.

Quick Start

  1. Run Controller
  2. Submit Framework

Doc

  1. User Manual
  2. Known Issue and Upcoming Feature
  3. FAQ
  4. Release Note

Official Image

Related Project

Third Party Controller Wrapper

A specialized wrapper can be built on top of FrameworkController to optimize for a specific kind of application:

Similar Offering On Other Cluster Manager

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

You can’t perform that action at this time.