Changelog

v1.7.0-rc.0 (2023-07-07)

Full Changelog

Breaking Changes

Upgrade Scheduler Plugins version to v0.25.7 kubeflow/training-operator#1824 (tenzen-y)
Upgrade the kubernetes dependencies to v1.27 kubeflow/training-operator#1834 (tenzen-y)

New features

Make scheduler-plugins the default gang scheduler. #1747 (Syulin7)
Merge kubeflow/common to training-operator #1813 (johnugeorge)
Auto-generate RBAC manifests by the controller-gen #1815 (Syulin7)
Implement suspend semantics #1859 (tenzen-y)
Set up controllers using goroutines to start the manager quickly #1869 (tenzen-y)
Set correct ENV for PytorchJob to support torchrun #1840 (kuizhiqing)

Bug fixes

Fix a bug that XGBoostJob's running condition isn't updated when the job is resumed #1866 (tenzen-y)
Set a Running condition when the XGBoostJob is completed and doesn't have a Running condition #1789 (tenzen-y)
Avoid to depend on local env when installing the code-generators #1810 (tenzen-y)

Misc

Removing reconciler code #1879 (johnugeorge)
Make Condition and ReplicaStatus optional #1862 (tenzen-y)
Use the same reasons for Condition and Event #1854 (tenzen-y)
Fully consolidate tfjob-operator to training-operator #1850 (tenzen-y)
Clean up /pkg/common/util/v1 #1845 (tenzen-y)
Refactoring tests in common/controller.v1 #1843 (tenzen-y)
remove duplicate code of add task spec annotation #1839 (lowang-bh)
fetch volcano log when e2e failed #1837 (lowang-bh)
Add check pods are not scheduled when testing gang-scheduler integrations in e2e #1835 (tenzen-y)
Replace dummy client with fake client #1818 (tenzen-y)
Add default Intel MPI env variables to MPIJob #1804 (tkatila)
Improve E2E tests for the gang-scheduling #1801 (tenzen-y)
xgb yaml container name should be consistent with xgb job default container name #1794 (Crisescode)
make timeout configurable from e2e tests #1787 (nagar-ajay)

v1.6.0 (2023-03-21)

Note: Since scheduler-plugins has changed API from sigs.k8s.io with the x-k8s.io, future releases of training operator(v1.7+) will not support scheduler-plugins v0.24.x or lower. Related: #1769

Note: Latest Python SDK 1.6 version does not support earlier training operator versions. The minimum training operator version required is v1.6.0 release. Related: #1702

Full Changelog

New Features

Support for k8s v1.25 in CI #1684 (johnugeorge)
HPA support for PyTorch Elastic #1701 (johnugeorge)
Adopting coschduling plugin #1724 (tenzen-y)
Support for Paddlepaddle #1675 (kuizhiqing)
Create TFJob and PyTorchJob from Function APIs in the Training SDK #1659 (andreyvelich)
[SDK] Use Training Client without Kube Config #1740 (andreyvelich)
[SDK] Create Unify Training Client #1719 (andreyvelich)

Bug fixes

[SDK] pod has no metadata attr anymore in the get_job_logs() … #1760 (yaobaiwei)
Add PodGroup as controller watch source #1666 (ggaaooppeenngg)
fix infinite loop in init-pytorch container #1756 (kidddddddddddddddddddddd)
Fix the success condition of the job in PyTorchJob's Elastic mode. #1752 (Syulin7)
Fix XGBoost conditions bug #1737 (tenzen-y)
To fix scaledown error, upgrade PyTorch version to v1.13.1 in echo example #1733 (tenzen-y)
fix: support MxNet single host training when update mxJob status #1644 (PeterChg)
fix: fix mxnet failed to update StartTime and CompletionTime #1643 (PeterChg)
Fix the default LeaderElectionID and make it an argument #1639 (goyalankit)
fix: fix wrong parameter for resolveControllerRef #1583 (fighterhit)
fix: tfjob with restartPolicy=ExitCode not work #1562 (cheimu)
fix: Mac M1 compatible Dockerfile and bump TF version #1700 (terrytangyuan)
Fix status lost #1697 (ggaaooppeenngg)
handle all restart policies #1649 (abin-thomas-by)
[chore] fix typo #1648 (tenzen-y)

Misc

Add validation for verifying that the CustomJob (e.g., TFJob) name meets DNS1035 #1748 (tenzen-y)
Configure controller worker threads #1707 (HeGaoYuan)
Validation Spec consistency #1705 (HeGaoYuan)
[SDK] Remove Final Keyword from constants #1676 (andreyvelich)
Fix Python installation in CI #1759 (tenzen-y)
Update mpijob_controller.go #1755 (yshalabi)
Set the default value of CleanPodPolicy to None #1754 (Syulin7)
Update join Slack link #1750 (Syulin7)
Update latest operator image #1742 (johnugeorge)
Run E2E with various Python versions to verify Python SDK #1741 (tenzen-y)
Add Yuki to reviewer group #1739 (johnugeorge)
Trim down CRD descriptions #1735 (tenzen-y)
Add CI to build example images #1731 (tenzen-y)
Fix predicates of paddlepaddle-controller for scheduling.volcano.sh/v1beta1 PodGroup #1730 (tenzen-y)
Fix indents on examples for tensorflow #1726 (tenzen-y)
docs: Update Kubernetes requirement and version matrix #1721 (terrytangyuan)
chore: Update the use of MultiWorkerMirroredStrategy in TF #1715 (terrytangyuan)
Removing deprecated Job Labels #1702 (johnugeorge)
Bump certifi from 2022.9.14 to 2022.12.7 in /py/kubeflow/tf_operator #1699 (dependabot[bot])
Add myself to reviewer. #1689 (kuizhiqing)
Upgrade the envtest version #1687 (tenzen-y)
[chore] Upgrade some actions version #1686 (tenzen-y)
Upgrade Golangci-lint #1685 (johnugeorge)
Make a generic logger instead of the nil logger on dependent update #1680 (ggaaooppeenngg)
Bump protobuf from 3.8.0 to 3.18.3 in /py/kubeflow/tf_operator #1669 (dependabot[bot])
Removed GOARCH dependency for multiarch support #1674 (pranavpandit1)
Update deployment.yaml #1668 (OmriShiv)
Upgrade Go version to v1.19 #1663 (tenzen-y)
Upgrade kubernetes versoin for test #1667 (tenzen-y)
Adding support for linux/ppc64le in github actions for training-operator #1692 (amitmukati-2604)
style: Refine name and signature of 2 replicaName functions #1660 (houz42)
Update training operator sdk version to 1.5.0 #1651 (johnugeorge)
Add finalizers to cluster-role #1646 (ArangoGutierrez)
Update the cmd to support MPI operator in ReadME #1656 (denkensk)

Closed issues:

The default value for CleanPodPolicy is inconsistent. #1753
HPA support for PyTorch Elastic #1751
Bug: allowance of non DNS-1035 compliant PyTorchJob names results in service creation failures and missing state #1745
paddle-operator can not get podgroup status(inqueue) with volcano when enable gang #1729
*job API(master) cannot compatible with old job #1725
Support coscheduling plugin #1722
Number of worker threads used by the controller can't be configured #1706
Conformance: Training tests #1698
PyTorch and MPI Operator pulls hardcoded initContainer #1696
PaddlePaddle Training: why can't find pods #1694
Training-operator pod CrashLoopBackOff in K8s v1.23.6 with kubeflow1.6.1 #1693
[SDK] Create unify client for all Training Job types #1691
Support Kubernetes v1.25 #1682
panic happened when add podgroup watch #1679
OnDependentUpdateFunc for Job will panic when enable volcano scheduler #1678
There is no clusterrole of "MPI Jobs" in kubeflow 1.5. #1670
Change Kubernetes version for test #1665
Support for multiplatform container imege (amd64 and arm64) #1664
Training Operator pod failed to start on OCP 4.10.30 with error "memory limit too low" #1661
After setting hostNetwork to true, mpi does not work #1657
What is the purpose of /examples/pytorch/elastic/etcd.yaml #1655
When will MPIJob support v2beta1 version? #1653
Kubernetes HPA doesn't work with elastic PytorchJob #1645
training-operator can not get podgroup status(inqueue) with volcano when enable gang #1630
Training operator fails to create HPA for TorchElastic jobs #1626
Release v1.5.0 tracking #1622
upgrade client-go #1599
trainning-operator may need to monitor PodGroup #1574
Error: invalid memory address or nil pointer dereference #1553
The pytorchJob training is slow #1532
pytorch elastic scheduler error #1504

v1.4.0-rc.0 (2022-01-26)

Full Changelog

Features and improvements:

Display coverage % in GitHub actions list #1442
Add Go test to CI #1436

Fixed bugs:

[bug] Missing init container in PyTorchJob #1482
Fail to install tf-operator in minikube because of the version of kubectl/kustomize #1381

Closed issues:

Restore KUBEFLOW_NAMESPACE options #1522
Improve test coverage #1497
swagger.json missing Pytorchjob.Spec.ElasticPolicy #1483
PytorchJob DDP training will stop if I delete a worker pod #1478
Write down e2e failure debug process #1467
How can i add the Priorityclass to the TFjob？ #1466
github.com/go-logr/zapr.(*zapLogger).Error #1444
Podgroup is constantly created and deleted after tfjob is success or failure #1426
Cut official release of 1.3.0 #1425
Add "not maintained" notice to other operator repos #1423
Python SDK for Kubeflow Training Operator #1380

Merged pull requests:

Update manifests with latest image tag #1527 (johnugeorge)
add option for mpi kubectl delivery #1525 (zw0610)
restore option namespace in launch arguments #1524 (zw0610)
remove unused scripts #1521 (zw0610)
remove ChanYiLin from approvers #1513 (ChanYiLin)
add StacktraceLevel for zapr #1512 (qiankunli)
add unit tests for tensorflow controller #1511 (zw0610)
add the example of MPIJob #1508 (hackerboy01)
Added 2022 roadmap and migrated previous roadmap from kubeflow/common #1500 (terrytangyuan)
Fix a typo in mpi controller log #1495 (LuBingtan)
feat(pytorch): Add init container config to avoid DNS lookup failure #1493 (gaocegege)
chore: Fix GitHub Actions script #1491 (tenzen-y)
chore: Fix missspell in tfjob #1490 (tenzen-y)
chore: Update OWNERS #1489 (gaocegege)
Bump jinja2 from 2.10.1 to 2.11.3 in /py/kubeflow/tf_operator #1487 (dependabot[bot])
fix comments for mpi-controller #1485 (hackerboy01)
add expectation-related functions for other resources used in mpi-controller #1484 (zw0610)
Add MPI job to README now that it's supported #1480 (terrytangyuan)
add mpi doc #1477 (zw0610)
Set Go version of base image to 1.17 #1476 (tenzen-y)
update label for tf-controller #1474 (zw0610)
Add Akuity to the list of adopters #1473 (terrytangyuan)
Add PR template with doc checklist #1470 (andreyvelich)
Add e2e failure debugging guidance #1469 (Jeffwan)
chore: Add .gitattributes to ignore Jsonnet test code for linguist #1463 (terrytangyuan)
Migrate additional examples from xgboost-operator #1461 (terrytangyuan)
Minor edits to README.md #1460 (terrytangyuan)
add mpi-operator(v1) to the unified operator #1457 (hackerboy01)
fix tfjob status when enableDynamicWorker set true #1455 (zw0610)
feat(pytorch): Support elastic training #1453 (gaocegege)
fix: generate printer columns for job crds #1451 (henrysecond1)
Fix README typo #1450 (davidxia)
consistent naming for better readability #1449 (pramodrj07)
Fix set scheduler error #1448 (qiankunli)
Add CI to run the tests for Go #1440 (tenzen-y)
fix: Add missing retrying package that failed the import #1439 (terrytangyuan)
Generate a single swagger.json file for all frameworks #1437 (alembiewski)
Update links and files with the new URL #1434 (andreyvelich)
chore: update CHANGELOG.md #1432 (Jeffwan)
Add acknowledgement section in README to credit all contributors #1422 (terrytangyuan)
Add Cisco to Adopters List #1421 (andreyvelich)
Add Python SDK for Kubeflow Training Operator #1420 (alembiewski)
docs: Move myself to approvers #1419 (terrytangyuan)
fix hyperlinks in the 'overview' section #1418 (pramodrj07)
docs: Migrate adopters of all operators to this repo #1417 (terrytangyuan)
Feature/support pytorchjob set queue of volcano #1415 (qiankunli)
Bump controller-tools to 0.6.0 and enable GenerateEmbeddedObjectMeta #1409 (Jeffwan)
Update scripts to generate sdk for all frameworks #1389 (Jeffwan)