Ubuntu Juju interface for node.js
Make sure you have the latest Juju installed. At this time Juju is only available for Linux and Mac OSX. Install from npm or clone from github
npm install juju
It's recommended that before you use node-juju you perform tests to insure compatibility between releases of Juju have not broken.
npm test
This will provide unit and functional tests.
node-juju incorporates all commands from the Juju CLI with the exception of
- debug-log
- debug-hooks
- open-tunnel
- scp
- ssh
These subcommands all require some interaction which isn't appropriate for this project.
Node-juju also providers the following extra commands:
- watch
- layout
Which are documented below under extras
var Juju = require('juju');
// process.env.HOME + "/.juju/environments.yaml" needs to exist with valid
// Juju environments outlined in it.
hpcloud = new Juju('hp-cloud');
hpcloud.bootstrap(function(err) {
console.log(this.environment + " bootstrapped!");
});
hpcloud.deploySync('mysql');
hpcloud.deploy('wordpress', {n: 2}, function(err) {
this.add_relation('wordpress', 'mysql');
this.expose('wordpress');
});Creates a new Juju object for the provided environment. Optional parameters include:
- REQUIRED STRING
environment- The environment name in HOME/.juju/environments.yaml - OPTIONAL STRING
format- [json, yaml, png, svg, dot] the default being json - OPTIONAL OBJECT
env- Environment over-rides, the most common being HOME, see process.env and environ(7)
Example:
var Juju = require('juju');
my_juju = new Juju('my-juju-environment', 'json', {"HOME": "/tmp/juju"});Add additional n units
- REQUIRED
Bootstrap the selected environment.
- OPTIONAL OBJECT
opts- This is a key: pair of additional command line arguments for Juju. - OPTIONAL FUNCTION
cb-Callback(error)
Example:
my_juju.bootstrap(function(err) {
if(err) {
console.log('Oh no!', err);
} else {
console.log('Bootstrapped!');
}
});Deploy a new charm to the environment
- REQUIRED STRING
charm- Name of the charm - OPTIONAL STRING
service_name- Name of the service to be deployed - OPTIONAL OBJECT
opts- Extra command-line options for Juju - OPTOINAL FUNCTION
cb-Callback(error)
Examples:
my.juju.deploy('wordpress', 'my-blog', {'constraints': 'instance-type=f1.fake'}, function(err) {
if(err) {
console.log('Deploy failed', err);
}
});
my_juju.deploy('mysql', function(err) {
if(err) {
console.log('NO MYSQL FOR YOU', err);
}
});Destory the environment.
- REQUIRED FUNCTION
cb-Callback(error)
Example:
my_juju.destroy(function(err) {
if(err) {
console.log("This didn't work!", err);
} else {
console.log('The environment was destroyed');
}
});Get the configuration options for a deployed service
- REQUIRED STRING
service- Name of the deployed service - OPTIONAL OBJECT
opts- Extra command-line options for Juju - REQUIRED FUNCTION
cb-Callback(error, results)
Example:
my_juju.get('wordpress', function(err, data) {
if(err) {
console.log('Oh dear!', err);
} else {
console.log(data); // Data will be in the `format` from `new Juju()`
}
});Expose a service
- REQUIRED STRING
service- Name of the deployed service - OPTIONAL FUNCTION
cb-Callback(error)
Example:
my_juju.expose('wordpress', function(err) {
if(err) {
console.log('Dun dun dunnn', err);
}
});The status of the Juju environment
- OPTIONAL OBJECT
opts- Extra command-line options for Juju - REQUIRED FUNCTION
cb-Callback(error, results)
Results are returned in a wrapper, in future versions this may become an option to preserve the raw results. The wrapper look like this:
{
services: INT,
units: INT,
bootstrapped: BOOL,
data: JSON STRING
}Example:
my_juju.status(function(err, data) {
if(err) {
console.log('Yikes!', err);
} else {
if(data.bootstrapped) {
console.log('We are strapped');
console.log(JSON.parse(data.data));
} else {
console.log('Not bootstrapped yet...');
}
}
});Please make contributions in the form of the pull requests in the form of a rebased single commit per feature/bug.