diff --git a/docs/README.md b/docs/README.md index 855f78407..2d2a4bfe0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -30,11 +30,11 @@ If a service does not have at least two providers, it is considered a *beta* int * [Openstack](providers/openstack/storage.md) * [Rackspace](providers/rackspace/storage.md) * **Databases** - * [HP](providers/hp/database.md) + * [HP](providers/hp/databases.md) * [IrisCouch](providers/iriscouch.md) * [MongoLab](providers/mongolab.md) - * [Openstack](providers/openstack/database.md) - * [Rackspace](providers/rackspace/database.md) + * [Openstack](providers/openstack/databases.md) + * [Rackspace](providers/rackspace/databases.md) * [MongoHQ](providers/mongohq.md) * [RedisToGo](providers/redistogo.md) * **DNS** *(beta)* diff --git a/docs/providers/compute-commonality.md b/docs/providers/compute-commonality.md index 08820ff98..73ab5ff78 100644 --- a/docs/providers/compute-commonality.md +++ b/docs/providers/compute-commonality.md @@ -8,7 +8,7 @@ The following table outlines the methods that are available on the different com AWS Azure Joyent -Openstack +OpenStack RAX DigitalOcean @@ -44,4 +44,4 @@ The following table outlines the methods that are available on the different com -*Note: There are a few I haven't listed yet that I know exist on Rackspace/Openstack, but I lack the awareness of the other providers.* +*Note: There are a few I haven't listed yet that I know exist on Rackspace/OpenStack, but I lack the awareness of the other providers.* diff --git a/docs/providers/hp/compute.md b/docs/providers/hp/compute.md index 8b4a32261..18982a3a2 100644 --- a/docs/providers/hp/compute.md +++ b/docs/providers/hp/compute.md @@ -1,6 +1,6 @@ ![HP Helion icon](http://www8.hp.com/hpnext/sites/default/files/content/documents/HP%20Helion%20Logo_Cloud_Martin%20Fink_New%20Style%20of%20IT_Hewlett-Packard.PNG) -##Using the HP Helion Cloud Compute provider +## Using the HP Helion Cloud Compute provider Creating a client is straight-forward: @@ -79,7 +79,7 @@ Returns a list of all possible server flavors available in the callback `f(err, flavors)` #### client.getFlavor(flavor, callback) -Returns the specified HP flavor of Openstack Images by ID or flavor +Returns the specified HP flavor of OpenStack Images by ID or flavor object in the callback `f(err, flavor)` **images** diff --git a/docs/providers/hp/databases.md b/docs/providers/hp/databases.md index 5f3b91353..0779c47cb 100644 --- a/docs/providers/hp/databases.md +++ b/docs/providers/hp/databases.md @@ -1,4 +1,4 @@ -##Using the HP Helion Database provider +## Using the HP Helion Database provider Creating a client is straight-forward: diff --git a/docs/providers/hp/network.md b/docs/providers/hp/network.md index 1d39eec70..664c97bf5 100644 --- a/docs/providers/hp/network.md +++ b/docs/providers/hp/network.md @@ -1,6 +1,6 @@ ![HP Helion icon](http://www8.hp.com/hpnext/sites/default/files/content/documents/HP%20Helion%20Logo_Cloud_Martin%20Fink_New%20Style%20of%20IT_Hewlett-Packard.PNG) -##Using the HP Cloud Network provider +## Using the HP Cloud Network provider Creating a client is straight-forward: @@ -177,7 +177,7 @@ Takes port or portId as an argument and returns the id of the destroyed port in **Security Groups** #### client.getSecurityGroups(callback) -Lists all security groups that are available to use on your Openstack account +Lists all security groups that are available to use on your OpenStack account Callback returns `f(err, securityGroups)` where `securityGroups` is an `Array` @@ -209,7 +209,7 @@ Takes securityGroup or securityGroupId as an argument and returns the id of the **Security Group Rules** #### client.getSecurityGroupRules(callback) -Lists all security group rules that are available to use on your Openstack account +Lists all security group rules that are available to use on your OpenStack account Callback returns `f(err, securityGroupRules)` where `securityGroupRules` is an `Array` diff --git a/docs/providers/openstack/README.md b/docs/providers/openstack/README.md index 13d5629a3..8a21a7ceb 100644 --- a/docs/providers/openstack/README.md +++ b/docs/providers/openstack/README.md @@ -1,4 +1,4 @@ -## Using the Openstack provider in pkgcloud +## Using the OpenStack provider in pkgcloud The OpenStack provider in pkgcloud supports the following services: @@ -16,7 +16,7 @@ We've provided a [simple compute example](getting-started-compute.md) where it c ### Authentication -For all of the Openstack services, you create a client with the same options: +For all of the OpenStack services, you create a client with the same options: ```javascript var openstack = pkgcloud.storage.createClient({ @@ -32,7 +32,7 @@ For all of the Openstack services, you create a client with the same options: ### Authentication Endpoints and Regions -All of the Openstack `createClient` calls have a few options that can be provided: +All of the OpenStack `createClient` calls have a few options that can be provided: #### region @@ -52,4 +52,4 @@ var client = require('pkgcloud').compute.createClient({ #### Tokens and Expiration -When you make your first call to a Openstack provider, your client is authenticated transparent to your API call. Openstack will issue you a token, with an expiration. When that token expires, the client will automatically re-authenticate and retrieve a new token. The caller shouldn't have to worry about this happening. +When you make your first call to a OpenStack provider, your client is authenticated transparent to your API call. OpenStack will issue you a token, with an expiration. When that token expires, the client will automatically re-authenticate and retrieve a new token. The caller shouldn't have to worry about this happening. diff --git a/docs/providers/openstack/blockstorage.md b/docs/providers/openstack/blockstorage.md index 60073e582..ee1b43966 100644 --- a/docs/providers/openstack/blockstorage.md +++ b/docs/providers/openstack/blockstorage.md @@ -1,4 +1,4 @@ -##Using the Openstack Block Storage provider +## Using the OpenStack Block Storage provider #### BETA - This API may change as additional providers for block storage are added to pkgcloud @@ -77,7 +77,7 @@ A VolumeType for BlockStorage has the following properties: ### Volume APIs #### client.getVolumes(options, callback) -Lists all volumes that are available to use on your Openstack account +Lists all volumes that are available to use on your OpenStack account Callback returns `f(err, volumes)` where `volumes` is an `Array`. `options` is an optional `boolean` which will return the full volume details if true. @@ -116,7 +116,7 @@ Returns callback with a confirmation ### Snapshot APIs #### client.getSnapshots(options, callback) -Lists all snapshots that are available to use on your Openstack account +Lists all snapshots that are available to use on your OpenStack account Callback returns `f(err, snapshots)` where `snapshots` is an `Array`. `options` is an optional `boolean` which will return the full snapshot details if true. @@ -156,7 +156,7 @@ Returns callback with a confirmation Volume types are used to define which kind of new volume to create. #### client.getVolumeTypes(callback) -Lists all volumeTypes that are available to use on your Openstack account +Lists all volumeTypes that are available to use on your OpenStack account Callback returns `f(err, volumeTypes)` where `volumeTypes` is an `Array`. diff --git a/docs/providers/openstack/cdn.md b/docs/providers/openstack/cdn.md index 62bf2764d..1c8936c46 100644 --- a/docs/providers/openstack/cdn.md +++ b/docs/providers/openstack/cdn.md @@ -1,4 +1,4 @@ -##Using the Openstack CDN provider +## Using the OpenStack CDN provider Creating a client is straight-forward: diff --git a/docs/providers/openstack/compute.md b/docs/providers/openstack/compute.md index d687f9530..fc428c76d 100644 --- a/docs/providers/openstack/compute.md +++ b/docs/providers/openstack/compute.md @@ -1,4 +1,4 @@ -##Using the Openstack Compute provider +##Using the OpenStack Compute provider Creating a client is straight-forward: @@ -20,7 +20,7 @@ Creating a client is straight-forward: **Servers** #### client.getServers(callback) -Lists all servers that are available to use on your Openstack account +Lists all servers that are available to use on your OpenStack account Callback returns `f(err, servers)` where `servers` is an `Array` @@ -99,7 +99,7 @@ Returns a list of all possible server flavors available in the callback `f(err, flavors)` #### client.getFlavor(flavor, callback) -Returns the specified flavor of Openstack Images by ID or flavor +Returns the specified flavor of OpenStack Images by ID or flavor object in the callback `f(err, flavor)` **images** diff --git a/docs/providers/openstack/databases.md b/docs/providers/openstack/databases.md index 3669ea150..1c5cd768f 100644 --- a/docs/providers/openstack/databases.md +++ b/docs/providers/openstack/databases.md @@ -1,4 +1,4 @@ -##Using the Openstack Database provider +## Using the OpenStack Database provider Creating a client is straight-forward: @@ -15,7 +15,7 @@ Creating a client is straight-forward: ### Creating a MySQL Database -The steps for provision a MySQL database from Openstack cloud databases are: +The steps for provision a MySQL database from OpenStack cloud databases are: 1. Choose a flavor (memory RAM size) 2. Create an instance of a database server. diff --git a/docs/providers/openstack/getting-started-compute.md b/docs/providers/openstack/getting-started-compute.md index fea7f9ddd..bad2400f1 100644 --- a/docs/providers/openstack/getting-started-compute.md +++ b/docs/providers/openstack/getting-started-compute.md @@ -1,8 +1,8 @@ -# Getting started with pkgcloud & Openstack +# Getting started with pkgcloud & OpenStack -The Openstack node.js SDK is available as part of `pkgcloud`, a multi-provider cloud provisioning package +The OpenStack node.js SDK is available as part of `pkgcloud`, a multi-provider cloud provisioning package -Pkgcloud currently supports Openstack Nova (compute) and Openstack Swift (storage). +Pkgcloud currently supports OpenStack Nova (compute) and OpenStack Swift (storage). To install `pkgcloud` from the command line: @@ -14,7 +14,7 @@ Don't have `npm` or `node` yet? [Get it now](http://nodejs.org/download). ## Using pkgcloud -In this example, we're going to create a Openstack compute client, create two servers, and then output their details to the command line. +In this example, we're going to create a OpenStack compute client, create two servers, and then output their details to the command line. *Note: We're going to use [lodash.js](https://lodash.com) for some convenience functions.* *Note: For DevStack, change AuthUrl to http://:5000* diff --git a/docs/providers/openstack/network.md b/docs/providers/openstack/network.md index 2716113f9..3df2a0b58 100644 --- a/docs/providers/openstack/network.md +++ b/docs/providers/openstack/network.md @@ -1,4 +1,4 @@ -##Using the Openstack Network provider +##Using the OpenStack Network provider Creating a client is straight-forward: @@ -18,7 +18,7 @@ Creating a client is straight-forward: **Networks** #### client.getNetworks(callback) -Lists all networks that are available to use on your Openstack account +Lists all networks that are available to use on your OpenStack account Callback returns `f(err, networks)` where `networks` is an `Array` @@ -67,7 +67,7 @@ Takes network or networkId as an argument and returns the id of the destroyed n **Subnets** #### client.getSubnets(callback) -Lists all subnets that are available to use on your Openstack account +Lists all subnets that are available to use on your OpenStack account Callback returns `f(err, subnets)` where `subnets` is an `Array` @@ -120,7 +120,7 @@ Takes subnet or subnetId as an argument and returns the id of the destroyed sub **Ports** #### client.getPorts(callback) -Lists all ports that are available to use on your Openstack account +Lists all ports that are available to use on your OpenStack account Callback returns `f(err, ports)` where `ports` is an `Array` @@ -177,7 +177,7 @@ Takes port or portId as an argument and returns the id of the destroyed port in **Security Groups** #### client.getSecurityGroups(callback) -Lists all security groups that are available to use on your Openstack account +Lists all security groups that are available to use on your OpenStack account Callback returns `f(err, securityGroups)` where `securityGroups` is an `Array` @@ -209,7 +209,7 @@ Takes securityGroup or securityGroupId as an argument and returns the id of the **Security Group Rules** #### client.getSecurityGroupRules(callback) -Lists all security group rules that are available to use on your Openstack account +Lists all security group rules that are available to use on your OpenStack account Callback returns `f(err, securityGroupRules)` where `securityGroupRules` is an `Array` @@ -247,7 +247,7 @@ Takes securityGroupRule or securityGroupRuleId as an argument and returns the i **Security Groups** #### client.getSecurityGroups(callback) -Lists all security groups that are available to use on your Openstack account +Lists all security groups that are available to use on your OpenStack account Callback returns `f(err, securityGroups)` where `securityGroups` is an `Array` @@ -279,7 +279,7 @@ Takes securityGroup or securityGroupId as an argument and returns the id of the **Security Group Rules** #### client.getSecurityGroupRules(callback) -Lists all security group rules that are available to use on your Openstack account +Lists all security group rules that are available to use on your OpenStack account Callback returns `f(err, securityGroupRules)` where `securityGroupRules` is an `Array` diff --git a/docs/providers/openstack/orchestration.md b/docs/providers/openstack/orchestration.md index 36f7118ba..1d3f2de1a 100644 --- a/docs/providers/openstack/orchestration.md +++ b/docs/providers/openstack/orchestration.md @@ -1,4 +1,4 @@ -##Using the Openstack Orchestration provider +##Using the OpenStack Orchestration provider Creating a client is straight-forward: @@ -20,7 +20,7 @@ Creating a client is straight-forward: ## Stacks #### client.getStacks([options], callback) -Lists all stacks that are available to use on your Openstack account +Lists all stacks that are available to use on your OpenStack account Callback returns `f(err, stacks)` where `stacks` is an `Array` diff --git a/docs/providers/openstack/storage.md b/docs/providers/openstack/storage.md index 6ff53d136..14c322a6b 100644 --- a/docs/providers/openstack/storage.md +++ b/docs/providers/openstack/storage.md @@ -1,4 +1,4 @@ -## Using the Openstack Storage provider +## Using the OpenStack Storage provider * Container * [Model](#container-model) @@ -20,11 +20,11 @@ Creating a client is straight-forward: **Note:** *Due to variances between OpenStack deployments, you may or may not need a `region` option.* -Learn about [more options for creating clients](README.md) in the Openstack `storage` provider. +Learn about [more options for creating clients](README.md) in the OpenStack `storage` provider. ### Container Model -A Container for Openstack has following properties: +A Container for OpenStack has following properties: ```Javascript { @@ -39,7 +39,7 @@ A Container for Openstack has following properties: ### File Model -A File for Openstack has the following properties: +A File for OpenStack has the following properties: ```Javascript { diff --git a/docs/providers/rackspace/blockstorage.md b/docs/providers/rackspace/blockstorage.md index f1dc0b70c..32ff08808 100644 --- a/docs/providers/rackspace/blockstorage.md +++ b/docs/providers/rackspace/blockstorage.md @@ -1,4 +1,4 @@ -##Using the Rackspace Block Storage provider +## Using the Rackspace Block Storage provider #### BETA - This API may change as additional providers for block storage are added to pkgcloud diff --git a/docs/providers/rackspace/cdn.md b/docs/providers/rackspace/cdn.md index 271cd22d4..9596a4b86 100644 --- a/docs/providers/rackspace/cdn.md +++ b/docs/providers/rackspace/cdn.md @@ -1,4 +1,4 @@ -##Using the Rackspace CDN provider +## Using the Rackspace CDN provider Creating a client is straight-forward: diff --git a/docs/providers/rackspace/databases.md b/docs/providers/rackspace/databases.md index 345347851..abe0c35a2 100644 --- a/docs/providers/rackspace/databases.md +++ b/docs/providers/rackspace/databases.md @@ -1,4 +1,4 @@ -##Using the Rackspace Database provider +## Using the Rackspace Database provider Creating a client is straight-forward: diff --git a/docs/providers/rackspace/loadbalancer.md b/docs/providers/rackspace/loadbalancer.md index 1c045062f..b02a18c1b 100644 --- a/docs/providers/rackspace/loadbalancer.md +++ b/docs/providers/rackspace/loadbalancer.md @@ -1,4 +1,4 @@ -##Using the Rackspace Load Balancer provider +## Using the Rackspace Load Balancer provider #### BETA - This API may change as additional providers for load balancers are added to pkgcloud diff --git a/docs/providers/rackspace/network.md b/docs/providers/rackspace/network.md index e7b7592ad..104d1cb6c 100644 --- a/docs/providers/rackspace/network.md +++ b/docs/providers/rackspace/network.md @@ -179,7 +179,7 @@ Takes port or portId as an argument and returns the id of the destroyed port in **Security Groups** #### client.getSecurityGroups(callback) -Lists all security groups that are available to use on your Openstack account +Lists all security groups that are available to use on your OpenStack account Callback returns `f(err, securityGroups)` where `securityGroups` is an `Array` @@ -211,7 +211,7 @@ Takes securityGroup or securityGroupId as an argument and returns the id of the **Security Group Rules** #### client.getSecurityGroupRules(callback) -Lists all security group rules that are available to use on your Openstack account +Lists all security group rules that are available to use on your OpenStack account Callback returns `f(err, securityGroupRules)` where `securityGroupRules` is an `Array` diff --git a/docs/providers/rackspace/orchestration.md b/docs/providers/rackspace/orchestration.md index 2b43f65f6..9bb9c37b1 100644 --- a/docs/providers/rackspace/orchestration.md +++ b/docs/providers/rackspace/orchestration.md @@ -1,4 +1,4 @@ -##Using the Rackspace Orchestration provider +## Using the Rackspace Orchestration provider Creating a client is straight-forward: diff --git a/docs/providers/rackspace/storage.md b/docs/providers/rackspace/storage.md index 645a948d9..fc5b935c9 100644 --- a/docs/providers/rackspace/storage.md +++ b/docs/providers/rackspace/storage.md @@ -20,7 +20,7 @@ Creating a client is straight-forward: }); ``` -Learn about [more options for creating clients](README.md) in the Openstack `storage` provider. `region` parameter can be any [Rackspace Region](http://www.rackspace.com/about/datacenters/). +Learn about [more options for creating clients](README.md) in the OpenStack `storage` provider. `region` parameter can be any [Rackspace Region](http://www.rackspace.com/about/datacenters/). ### Container Model