Initial copy of project files from Heat
Initial copy of project files from Heat.
This commit is contained in:
parent
4732854d10
commit
def656514a
16
CONTRIBUTING.rst
Normal file
16
CONTRIBUTING.rst
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
If you would like to contribute to the development of OpenStack,
|
||||||
|
you must follow the steps in this page:
|
||||||
|
|
||||||
|
http://docs.openstack.org/infra/manual/developers.html
|
||||||
|
|
||||||
|
Once those steps have been completed, changes to OpenStack
|
||||||
|
should be submitted for review via the Gerrit tool, following
|
||||||
|
the workflow documented at:
|
||||||
|
|
||||||
|
http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||||
|
|
||||||
|
Pull requests submitted through GitHub will be ignored.
|
||||||
|
|
||||||
|
Bugs should be filed on Launchpad, not GitHub:
|
||||||
|
|
||||||
|
https://bugs.launchpad.net/senlin
|
43
HACKING.rst
Normal file
43
HACKING.rst
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
Senlin Style Commandments
|
||||||
|
=========================
|
||||||
|
|
||||||
|
- Step 1: Read the OpenStack Style Commandments
|
||||||
|
http://docs.openstack.org/developer/hacking/
|
||||||
|
- Step 2: Read on
|
||||||
|
|
||||||
|
Senlin Specific Commandments
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
None so far
|
||||||
|
|
||||||
|
Creating Unit Tests
|
||||||
|
-------------------
|
||||||
|
For every new feature, unit tests should be created that both test and
|
||||||
|
(implicitly) document the usage of said feature. If submitting a patch for a
|
||||||
|
bug that had no unit test, a new passing unit test should be added. If a
|
||||||
|
submitted bug fix does have a unit test, be sure to add a new one that fails
|
||||||
|
without the patch and passes with the patch.
|
||||||
|
|
||||||
|
For more information on creating unit tests and utilizing the testing
|
||||||
|
infrastructure in OpenStack Senlin, please read senlin/tests/testing-overview.txt.
|
||||||
|
|
||||||
|
|
||||||
|
Running Tests
|
||||||
|
-------------
|
||||||
|
The testing system is based on a combination of tox and testr. The canonical
|
||||||
|
approach to running tests is to simply run the command `tox`. This will
|
||||||
|
create virtual environments, populate them with dependencies and run all of
|
||||||
|
the tests that OpenStack CI systems run. Behind the scenes, tox is running
|
||||||
|
`testr run --parallel`, but is set up such that you can supply any additional
|
||||||
|
testr arguments that are needed to tox. For example, you can run:
|
||||||
|
`tox -- --analyze-isolation` to cause tox to tell testr to add
|
||||||
|
--analyze-isolation to its argument list.
|
||||||
|
|
||||||
|
It is also possible to run the tests inside of a virtual environment
|
||||||
|
you have created, or it is possible that you have all of the dependencies
|
||||||
|
installed locally already. In this case, you can interact with the testr
|
||||||
|
command directly. Running `testr run` will run the entire test suite. `testr
|
||||||
|
run --parallel` will run it in parallel (this is the default incantation tox
|
||||||
|
uses.) More information about testr can be found at:
|
||||||
|
http://wiki.openstack.org/testr
|
||||||
|
|
22
README.rst
Normal file
22
README.rst
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
======
|
||||||
|
SENLIN
|
||||||
|
======
|
||||||
|
|
||||||
|
Senlin is a service to orchestrate multiple composite cloud applications using
|
||||||
|
templates.
|
||||||
|
|
||||||
|
Getting Started
|
||||||
|
---------------
|
||||||
|
|
||||||
|
If you'd like to run from the master branch, you can clone the git repo:
|
||||||
|
|
||||||
|
git clone git@github.com:openstack/senlin.git
|
||||||
|
|
||||||
|
|
||||||
|
* Wiki: http://wiki.openstack.org/Senlin
|
||||||
|
* Developer docs: http://docs.openstack.org/developer/senlin
|
||||||
|
|
||||||
|
|
||||||
|
Python client
|
||||||
|
-------------
|
||||||
|
https://github.com/openstack/python-senlinclient
|
Loading…
Reference in New Issue
Block a user