K8s Custom Resource and Operator For TensorFlow jobs

Overview

TFJob provides a Kubernetes custom resource that makes it easy to run distributed or non-distributed TensorFlow jobs on Kubernetes.

• For a complete reference of the custom resource definitions, please refer to the API Definition.
• For details on its design, please refer to the v1alpha2 design doc.
• For details on its obersibility, please refer to the monitoring design doc.

Prerequisites

• Version >= 1.16 of Kubernetes

Installation

Master Branch

kustomize build "github.com/kubeflow/tf-operator.git/manifests/overlays/standalone?ref=master" | kubectl apply -f -

Specific Release

kustomize build "github.com/kubeflow/tf-operator.git/manifests/overlays/standalone?ref=v1.1.0" | kubectl apply -f -

Quick Start

Please refer to the quick-start-v1.md and Kubeflow user guide for more information.

API Documentation

Please refer to API Documentation

Community

You can:

• Join our Slack channel.
• Check out who is using this operator.

This is a part of Kubeflow, so please see readme in kubeflow/kubeflow to get in touch with the community.

Contributing

Please refer to the developer_guide

Change Log

Please refer to CHANGELOG

Version Matrix

The following table lists the most recent few versions of the operator.

Operator Version	API Version	Kubernetes Version
latest (master HEAD)	v1	1.16+
v1.0.x	v1	1.16+