Update README.md * Added a note to use phase1 branch * Updated links to the docs * Updated Roadmap section to accurately reflect the finished and upcoming features. * Added links to MesosCon 2015 talk on Myriad.
Project: http://git-wip-us.apache.org/repos/asf/incubator-myriad/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-myriad/commit/f745825c Tree: http://git-wip-us.apache.org/repos/asf/incubator-myriad/tree/f745825c Diff: http://git-wip-us.apache.org/repos/asf/incubator-myriad/diff/f745825c Branch: refs/heads/phase1 Commit: f745825cb2a1ce0c4ccc217205807d48ecd1fde6 Parents: 3dffd1d Author: Santosh Marella <smare...@maprtech.com> Authored: Thu Sep 10 11:21:05 2015 -0700 Committer: Santosh Marella <smare...@maprtech.com> Committed: Thu Sep 10 11:21:05 2015 -0700 ---------------------------------------------------------------------- README.md | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-myriad/blob/f745825c/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index c4c4241..ce80063 100644 --- a/README.md +++ b/README.md @@ -2,36 +2,42 @@ [![Build Status](https://travis-ci.org/mesos/myriad.svg)](https://travis-ci.org/mesos/myriad) -Myriad is a mesos framework designed for scaling a YARN cluster on Mesos. Myriad can expand or shrink the resources managed by a YARN cluster in response to events as per configured rules and policies. +Myriad is a Mesos framework designed for scaling a YARN cluster on Mesos. Myriad can expand or shrink the resources managed by a YARN cluster in response to events as per configured rules and policies. -The name _Myriad_ means, _countless or extremely great number_. In context of the project, it allows one to expand overall resources managed by Mesos, even when the cluster under mesos management runs other cluster managers like YARN. +The name _Myriad_ means, _countless or extremely great number_. In context of the project, it allows one to expand overall resources managed by Mesos, even when the cluster under Mesos management runs other cluster managers like YARN. -**Please note: Myriad is a work in progress, and should not be used in production at this point.** +**Please note: Myriad is not yet production ready. However, the project is rapidly progressing with some very useful features.** + +**If you are an admin/developer interested to try out Myriad, please clone the git repo and use [phase1 branch](https://github.com/mesos/myriad/tree/phase1).** ## Getting started * [How Myriad works](docs/how-it-works.md) * [Developing Myriad](docs/myriad-dev.md) -* [Deploying the Myriad Resource-Manger using Docker](docker/README.md) * [Local vagrant setup guide](docs/vagrant.md) * [Myriad REST API](docs/API.md) -* [Auto-scaling YARN cluster](docs/control-plane-algorithm.md) -* [Mesos, YARN and cgroups](docs/cgroups.md) * [Myriad Dashboard Development](docs/myriad-dashboard.md) +* [Distribution of Node Manager Binaries](docs/myriad-remote-distribution-configuration.md) +* [Fine Grained Scaling](docs/myriad-fine-grained-scaling.md) +* [Deploying the Myriad Resource-Manger using Docker](docker/README.md) +* [Mesos, YARN and cgroups](docs/cgroups.md) ## Roadmap -Myriad is a work in progress, please keep checking this section for updates. +Please keep checking this section for updates. -- [x] Custom Executor for managing NodeManager -- [x] Support unique constraint to let only one node-manager run on a slave -- [x] Framework checkpointing - [x] NodeManager Profiles -- [ ] High Availability mode for framework -- [ ] Framework re-conciliation -- [ ] Fine-grained scaling -- [ ] Support multi-tenancy for node-managers +- [x] Scale up/down Node Managers via REST API/Web UI +- [x] Framework re-conciliation & HA +- [x] ResourceManager failover/discovery using Marathon/Mesos-DNS +- [x] Fine-grained scaling +- [x] Remote distribution of NodeManager binaries +- [x] Framework checkpointing +- [ ] Launch Job History Server +- [ ] Constraints based Node Manager placement +- [ ] Support multi-tenancy for Node Managers - [ ] Configuration store for storing rules and policies for clusters managed by Myriad ## Videos and Slides * MesosCon 2014 - Running YARN alongside Mesos [(video)](https://www.youtube.com/watch?v=d7vZWm_xS9c) [(slides)](https://speakerdeck.com/mohit/running-yarn-alongside-mesos-mesoscon-2014) * Mesos User Group, March 2015 - Myriad: Integrating Hadoop into the Datacenter [(video)](http://www.youtube.com/watch?v=UMu9n4f62GI) +* MesosCon, Seattle 2015 - Resource Sharing Beyond Boundaries [(video)](https://www.youtube.com/watch?v=lU2VE08fOD4) [(slides)](http://events.linuxfoundation.org/sites/events/files/slides/Apache_Myriad_MesosCon_2015.pdf)