This cookbook installs and configures a devpi server. Devpi is a PyPI-compatible Python Index server that acts as both a freestanding Python Index as well as a pull-through cache of the official Python Package Index.
- Python Versions: Python 2.6 amd 2.7
- Operating Systems: Debian/Ubuntu, Enterprise Linux/CentOS
| Key | Type | Description | Default |
|---|---|---|---|
| [:devpiserver][:admin_group] | String | This group can administer the devpi server. This group will be created if it does not exist. | devpi |
| [:devpiserver][:server_root] | String | Store server data in this directory. This directory will be created if it does not exist. | /opt/devpi-server/data |
| [:devpiserver][:server_port] | Integer | Port number that the server will listen on. | 3141 |
| [:devpiserver][:daemon_user] | String | Run the daemon as this user. This user will be created if it does not exist. | devpi |
| [:devpiserver][:version] | String or nil | Install this version of the devpi-server package. Set this attribute to nil to install the latest version. | nil |
| [:devpiserver][:virtualenv] | Path | Install Python virtual environment here | /opt/devpi-server |
Include recipes from this cookbook to install the devpi server as a daemon and, optionally, expose the server via an nginx endpoint. This cookbook supports a few different use cases.
- Install devpi without additional support.
- Manage devpi with either supervisor or runit.
- Expose an installed devpi instance using nginx.
The first use case is easy, add the devpi::server recipe
to your run_list. The second use case is simple as well. Include the
appropriate recipe and it will install devpi and configure it to run in
the chosen environment. The final use case requires that you choose how
you want devpi to run by selecting one of the other recipes and adding it
to the node's run_list before you include devpi::nginx.
Include this recipe in the run_list to install the devpi server. It
will also create the daemon user and administrative group if necessary.
Include this recipe to manage the devpi server using supervisor. It will install supervisor globally if necessary and add the devpi server job. This recipe assumes that the server recipe is already present in the run list.
Include this recipe to manage the devpi server using a runit script. It will install runit globally if necessary and configure a devpi server job.
Include this recipe to expose the devpi-server using nginx as a front-end server.
- Fork the repository on Github
- Create a feature branch named "feature/my_feature" from
development - Edit README.md to describe your feature
- Write integration tests that verify your feature, run them with
rake integration-test-- they should fail - Implement your feature in its default configuration. You should not modify anything outside if the recipe at this point. Keep iterating until the integration tests pass.
- Implement unit tests to cover any configuration or platform details.
Add attributes as needed at this point. Run unit tests with
rake unit-test. - Run the static analysis tasks using
rake lint. Fix any problems that they find. - Update README.md to mention any new attributes and add yourself to the AUTHORS list.
- Issue a pull-request on Github.
HACKING.md contains additional details about developing in this cookbook.
- Dave Shawley
Copyright (C) 2013-2014 Dave Shawley
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.