RETIRED, JavaScript API library for OpenStack.
Go to file
Jenkins 8828ec6382 Merge "Support names and ids for users, projects and domains in Keystone" 2016-10-17 21:49:20 +00:00
doc Added jsdoc3 output to doc generation 2016-08-30 14:26:10 -07:00
src Merge "Support names and ids for users, projects and domains in Keystone" 2016-10-17 21:49:20 +00:00
test Merge "Support names and ids for users, projects and domains in Keystone" 2016-10-17 21:49:20 +00:00
.babelrc Use babel-plugin-transform-runtime instead of babel-polyfill 2016-09-05 19:25:18 +03:00
.editorconfig Initial commit of project. 2016-05-20 12:12:21 -07:00
.eslintignore Added jasmine-based testing harness. 2016-07-14 13:12:09 +03:00
.eslintrc Updates linting rules 2016-09-23 13:46:04 -04:00
.gitignore Added jsdoc3 output to doc generation 2016-08-30 14:26:10 -07:00
.gitreview Update .gitreview 2016-05-20 12:23:44 -07:00
.istanbul.yml Created Version Class 2016-08-15 13:25:38 -07:00
.nsprc Added node-security-project checks 2016-06-23 12:53:07 +00:00
LICENSE Initial commit of project. 2016-05-20 12:12:21 -07:00
README.rst Add README 2016-10-17 14:41:36 +00:00
Vagrantfile Added vagrant file for devstack bootstrap 2016-07-24 07:46:14 -07:00
bindep.txt Added oslo-sphinx to bindep.txt 2016-08-17 09:35:34 -07:00
configure-devstack.js Added Neutron Service 2016-09-26 14:05:34 -04:00
karma.conf.babel.js Add functional tests for devstack gate 2016-08-05 13:27:17 -04:00
karma.conf.js Added Karma integration 2016-07-19 12:19:35 -07:00
package.json AbstractService will try to detect the versions resource in more places. 2016-09-22 07:36:39 -07:00
vagrant.sh Added networkList() method to neutron API 2016-10-05 15:58:42 -04:00
webpack.config.babel.js Add functional tests for devstack gate 2016-08-05 13:27:17 -04:00

README.rst

JS-OpenStack-lib

JS-OpenStack-lib is a Javascript library for interacting with OpenStack clouds. The project aims to provide a constistent and complete set of interactions with OpenStack's many services, along with documentations, examples, and tools. This library is compatible with both browser and server side Javascript.

Example

The following example simply connects to an OpenStack cloud and list flavors in the Compute service:

import OpenStack from 'js-openstack-lib';

// Initialize cloud
// cloudConfig is a JSON object corresponding to clouds.yaml
// (It is your responsibility to load and parse it)
const openStack = new OpenStack({
  region_name: 'Region1',
  auth: {
    username: 'user',
    password: 'pass',
    project_name: 'js-openstack-lib',
    auth_url: 'http://192.168.99.99/'
  }
});
// List all flavors
openStack.networkList()
  .then((networks) => {
    console.log(networks);
  });

Documentation

Coming soon

Contributing

If you're interested in contributing, the following will help you get started:

Bug Tracker

https://storyboard.openstack.org/#!/project/844

Code Hosting

https://git.openstack.org/cgit/openstack/js-openstack-lib

Code Review

https://review.openstack.org/#/q/status:open+project:openstack/js-openstack-lib,n,z

Please read Developer's Guide before sending your first patch for review

License

Apache 2.0