x/scalpels
Code Issues Proposed changes

mv readme.md to readme.rst

Browse Source 
Change-Id: Id48b6403fea09d01dde030aec8e25437df967fa7
This commit is contained in:
Kun Huang 2015-11-11 00:46:48 +08:00
parent c7d9e0020b
commit fa34d04420
2 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md → README.rst
View File

@ -1,25 +1,31 @@
# Scalpels
Scalpels
========
Scalpels is distributed tracing or digging system for OpenStack.
## Background
Background
==========
OpenStack is made of multiple Python-based projects. Each project has similiar but different architecture. Scalpels gathers useful scripts or 3rd tools to help operator find what happen in your cloud.
## Contribute
Contribute
==========
This project is prototype now and under development. If you have interests in this work, please contact @kun_huang, at #openstack-chinese channel.
## Single Node Architecture
Single Node Architecture
========================
This type of deployment is used as POC in OpenStack community CI.
.. image:: doc/source/images/allinone.png
:alt: All-in-One deployment
## Multiple Node Architecture
Multiple Node Architecture
==========================
This is under Designing:
.. image:: doc/source/images/multiple.png
:alt: Multiple deployment
## Ideas
Ideas
=====
Each project will have scripts working:
* on python calls

2
setup.cfg
View File

@ -1,7 +1,7 @@
[metadata]
name = scalpels
summary = OpenStack digging system
description-file = README.md
description-file = README.rst
author = Kun Huang
author-email = academicgareth@gmail.com
maintainer = Kun Huang