murano-agent/README.rst
Flavio Percoco 882c393fc4 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

https://gist.github.com/8bb2dd01d11f527ab55ff4909d7c4adf

Change-Id: I63bf675b5711b9c9bf9c2ae388d52b2b48753d7f
2016-11-25 15:52:18 +01:00

57 lines
1.7 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: http://governance.openstack.org/badges/murano-agent.svg
:target: http://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
Murano Agent
============
Murano Agent is a VM-side guest agent that accepts commands from Murano engine
and executes them.
Image building using DiskImage-Builder
--------------------------------------
Folder, named *contrib/elements* contains
`diskimage-builder <https://git.openstack.org/cgit/openstack/diskimage-builder>`_
elements to build an image which contains the Murano Agent required to use Murano.
Ubuntu based image containing the agent can be built and uploaded
to Glance with the following commands:
::
$ git clone https://git.openstack.org/openstack/diskimage-builder.git
$ git clone https://git.openstack.org/openstack/murano-agent.git
$ export ELEMENTS_PATH=murano-agent/contrib/elements
$ export DIB_CLOUD_INIT_DATASOURCES=OpenStack
$ diskimage-builder/bin/disk-image-create vm ubuntu \
murano-agent -o ubuntu-murano-agent.qcow2
$ glance image-create --disk-format qcow2 --container-format bare \
--name ubuntu-murano --file ubuntu-murano.qcow2 \
--property murano_image_info='{"title": "Ubuntu for Murano", "type": "linux"}'
Project Resources
-----------------
Project status, bugs, and blueprints are tracked on Launchpad:
https://launchpad.net/murano
Developer documentation can be found here:
http://docs.openstack.org/developer/murano/
Additional resources are linked from the project wiki page:
https://wiki.openstack.org/wiki/Murano
License
-------
Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0