nodepool/README.rst
Monty Taylor d85fb24734 Update devstack settings and docs for opendev
The most important thing is that the URL for glean is actually
wrong, which causes jobs to fail.

Also, change documentation while we're changing things.

Depends-On: https://review.opendev.org/655133
Change-Id: I127a33bfc4a3e33249120dcc7ef6142ce4e52a97
2019-04-23 13:03:21 +00:00

59 lines
1.7 KiB
ReStructuredText

Nodepool
========
Nodepool is a system for managing test node resources. It supports launching
single-use test nodes from cloud providers as well as managing access to
pre-defined pre-existing nodes. Nodepool is part of a suite of tools that form
a comprehensive test system, including Zuul.
The latest documentation for Nodepool is published at:
https://zuul-ci.org/docs/nodepool/
The latest documentation for Zuul is published at:
https://zuul-ci.org/docs/zuul/
Getting Help
------------
There are two Zuul-related mailing lists:
`zuul-announce <http://lists.zuul-ci.org/cgi-bin/mailman/listinfo/zuul-announce>`_
A low-traffic announcement-only list to which every Zuul operator or
power-user should subscribe.
`zuul-discuss <http://lists.zuul-ci.org/cgi-bin/mailman/listinfo/zuul-discuss>`_
General discussion about Zuul, including questions about how to use
it, and future development.
You will also find Zuul developers in the `#zuul` channel on Freenode
IRC.
Contributing
------------
To browse the latest code, see: https://opendev.org/zuul/nodepool
To clone the latest code, use `git clone https://opendev.org/zuul/nodepool`
Bugs are handled at: https://storyboard.openstack.org/#!/project/zuul/nodepool
Code reviews are handled by gerrit at https://review.opendev.org
After creating a Gerrit account, use `git review` to submit patches.
Example::
# Do your commits
$ git review
# Enter your username if prompted
Join `#zuul` on Freenode to discuss development or usage.
License
-------
Nodepool is free software, licensed under the Apache License, version 2.0.
Python Version Support
----------------------
Nodepool requires Python 3. It does not support Python 2.