#housingproject Projects are homeless - give them a chance with a housing project...

var council = require('housingproject');

// make a new housing project pointing to a JSON DB file
var project = council.openProject({
	file:'/tmp/towerblocks.json'
});

// get a list of the servers in our current project
var servers = project.listHomes();

// we are going to build some homes - get a contractor for the contract
var rackspace = council.contractor('rackspace', {
	username:'...',
	apiKey:'...'
});

// make a new home (with the default flavour)
project.buildHome({
	name:'Nice home with lots of Memory',
	contractor:rackspace
}, function(error, server){

	// we have built a new server and the housingproject has given us the keys
	var ipAddress = server.ip;
	var privateKey = server.privateKey;

	// the home is saved into the project and we are done!
});

Installation

$ npm install housingproject

Features

• Creates an inventory of all your servers and manages it in a tree
• Plug-and-play contractor library means you are not locked into one hosting provider
• Automatically builds new servers and handles the security of SSH key access

Philosophy

Housing project exists to give orphan code the chance it deserves in life and to run
in a nice new home build just for it.

The project looks after what code is living in what home and can very quickly build
new homes.

It exists to make the job of cloud server provisioning simples.

Running Tests

To run the test suite first invoke the following command within the repo, installing the development dependencies:

$ npm install

then run the tests:

$ make test

License

(The MIT License)

Copyright (c) 2006-2012 jQuarry <[email protected]>

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.