x/shovel
Code Issues Proposed changes

Update README.md

Browse Source
This commit is contained in:
Andre Keedy 2015-12-29 15:49:22 -05:00
parent aaf1c5da7d
commit 6e591d59b7
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,18 +1,18 @@
# Shovel(RackHD/OpenStack Coordinator) # Shovel(RackHD/OpenStack Coordinator)
## Description ## Description
Shovel is an application that provides a service with a set of APIs that wraps around RackHD/Ironic existing APIs allowing Users to find Baremetal Compute nodes dynamically discovered by RackHD and register/unregister them with Ironic (OpenStack Bare Metal Provisioning Program).Shovel also Provides poller service that monitor compute nodes and log the error from SEL into Ironic Database. Shovel is an application that provides a service with a set of APIs that wraps around RackHD/Ironic existing APIs allowing users to find Baremetal Compute nodes dynamically discovered by RackHD and register/unregister them with Ironic (OpenStack Bare Metal Provisioning Program).Shovel also provides poller service that monitors compute nodes and logs the errors from SEL into Ironic Database.
This Code also provides a Shovel Horizon plugin that interface with Shovel service. The Plugin adds a new Panel to the admin Dashboard called rackhd that displays a table of all the Baremetal systems Discovered by RackHD. It also allow the user to see the node catalog in a nice table View, Register/Unregister node in ironic, Display node SEL and Enable/register a failover node. A Shovel Horizon plugin is also provided to interface with the Shovel service. The plugin adds a new Panel to the admin Dashboard called rackhd that displays a table of all the Baremetal systems discovered by RackHD. It also allows the user to see the node catalog in a nice table View, Register/Unregister node in Ironic, display node SEL and enable/register a failover node.
## Instructions ## Instructions
- Use [RackHD: Quick Setup](http://rackhd.readthedocs.org/en/latest/getting_started.html) to install [RackHD](https://github.com/RackHD/RackHD). - Use [RackHD: Quick Setup](http://rackhd.readthedocs.org/en/latest/getting_started.html) to install [RackHD](https://github.com/RackHD/RackHD).
- You can use Devstack to [Deploy Openstack](http://docs.openstack.org/developer/ironic/dev/dev-quickstart.html#deploying-ironic-with-devstack) to a single machine. - Use Devstack to [Deploy Openstack](http://docs.openstack.org/developer/ironic/dev/dev-quickstart.html#deploying-ironic-with-devstack) to a single machine.
- Shovel-Horizon consists of two reposotories: - Shovel-Horizon consists of two repositories:
- Service Application called [Shovel](https://github.com/keedya/Shovel-horizon/tree/master/Shovel), serves as [RackHD](https://github.com/RackHD/RackHD)/[Ironic](https://wiki.openstack.org/wiki/Ironic) coordinator (find Readme [Instructions](https://github.com/keedya/Shovel-horizon/blob/master/Shovel/README.md) to setup the service). - Service Application called [Shovel](https://github.com/keedya/Shovel-horizon/tree/master/Shovel), serves as [RackHD](https://github.com/RackHD/RackHD)/[Ironic](https://wiki.openstack.org/wiki/Ironic) coordinator (fReadme [Instructions](https://github.com/keedya/Shovel-horizon/blob/master/Shovel/README.md) to setup the service.
- [Shovel Horizon](https://github.com/keedya/Shovel-horizon/tree/master/Horizon) Plug-in (Follow [Instructions](https://github.com/keedya/Shovel-horizon/blob/master/Horizon/README.md) to Deploy plug-in to Horizon interface). - [Shovel Horizon](https://github.com/keedya/Shovel-horizon/tree/master/Horizon) Plug-in ( [Instructions](https://github.com/keedya/Shovel-horizon/blob/master/Horizon/README.md) to Deploy plug-in to Horizon interface).
## Licencing ## Licensing
## Support ## Support
Please file bugs and issues at the GitHub issues page. Please file bugs and issues at the GitHub issues page.