Update Tacker README.rst with new project scope and pointers

Change-Id: I61171b08ab58e3769e9dd1ab01c474727efe9cad
This commit is contained in:
Sridhar Ramaswamy 2015-08-06 17:50:06 -07:00
parent 30f3d39d38
commit 0b422aa7ad

View File

@ -1,19 +1,42 @@
Welcome!
========
Tacker is an OpenStack based VNF Manager service and a framework used to
deploy and operate Virtual Network Functions (VNFs) on an OpenStack
based NFV Platform.
Tacker is an OpenStack based NFV Orchestrator service with built-in general
purpose VNF Manager to deploy and operate Virtual Network Functions (VNFs)
on an OpenStack based NFV Platform. It is based on ETSI MANO Architectural
Framework and provides full functional stack to orchestrate VNFs end-to-end.
Installation:
=============
Installation instructions:
https://wiki.openstack.org/wiki/Tacker/Installation
**MUST READ: Important Note:**
Tacker code base currently ONLY works with OpenStack stable/kilo release
components (including devstack, nova, neutron, etc). Please follow the
instructions in the above wiki for a successful installation.
Code:
=====
Tacker code is available in following repositories:
* **Tacker server:** http://git.openstack.org/cgit/stackforge/tacker
* **Tacker Python client:** http://git.openstack.org/cgit/stackforge/python-tackerclient
* **Tacker Horizon UI:** http://git.openstack.org/cgit/stackforge/tacker-horizon
Bugs:
=====
Please report bugs at: https://bugs.launchpad.net/tacker
External Resources:
===================
The homepage for Tacker is: http://launchpad.net/tacker. Use this
site for asking for help, and filing bugs. Code is available on
git.openstack.org at <http://git.openstack.org/cgit/stackforge/tacker>.
Tacker Wiki:
https://wiki.openstack.org/wiki/Tacker
For help on usage and hacking of Tacker, please send mail to
<mailto:openstack-dev@lists.openstack.org> with [tacker] tag.
<mailto:openstack-dev@lists.openstack.org> with [Tacker] tag.