Updated the documentation to reflect the new nomenclature.
This commit is contained in:
@@ -21,15 +21,14 @@
|
|||||||
* - account ID and secret key: For cases where you want account-wide
|
* - account ID and secret key: For cases where you want account-wide
|
||||||
* authentication/authorization.
|
* authentication/authorization.
|
||||||
* - username/password: Typically, this is the same username/password you use
|
* - username/password: Typically, this is the same username/password you use
|
||||||
* to access the HPCloud management console.
|
* to access the HPCloud console.
|
||||||
* - tenant ID: This associates an account or user with a bundle of services.
|
* - tenant ID: This associates an account or user with a bundle of services.
|
||||||
* You can find this information in your management console.
|
* You can find this information in your console.
|
||||||
* - endpoint: You will need the URL to the HPCloud endpoint responsible for
|
* - endpoint: You will need the URL to the HPCloud endpoint responsible for
|
||||||
* <i>authenticating users</i>. This can be found in your management
|
* <i>authenticating users</i>. This can be found in your console.
|
||||||
* console.
|
|
||||||
*
|
*
|
||||||
* (If you are not sure what the "HPCloud Management Console" is, head over to
|
* (If you are not sure what the "HPCloud Console" is, head over to
|
||||||
* http://build.hpcloud.com. There you will find some articles and videos
|
* http://docs.hpcloud.com. There you will find some articles and videos
|
||||||
* explaining the HPCloud structure.)
|
* explaining the HPCloud structure.)
|
||||||
*
|
*
|
||||||
* @section where_to_start Where To Start
|
* @section where_to_start Where To Start
|
||||||
@@ -56,7 +55,7 @@
|
|||||||
* screencasts, a knowledge base, and active community forums are
|
* screencasts, a knowledge base, and active community forums are
|
||||||
* just a click away.
|
* just a click away.
|
||||||
*
|
*
|
||||||
* Head over to http://build.hpcloud.com to find these and other resources.
|
* Head over to http://docs.hpcloud.com to find these and other resources.
|
||||||
*
|
*
|
||||||
* Or maybe you'd just like to see a couple of examples.
|
* Or maybe you'd just like to see a couple of examples.
|
||||||
*
|
*
|
||||||
@@ -79,7 +78,7 @@
|
|||||||
*
|
*
|
||||||
* // Create a stream context. You can get this
|
* // Create a stream context. You can get this
|
||||||
* // information (including tenant ID) from your
|
* // information (including tenant ID) from your
|
||||||
* // HPCloud management console.
|
* // HPCloud console.
|
||||||
* $cxt = stream_context_create(array(
|
* $cxt = stream_context_create(array(
|
||||||
* 'username' => 'matthew.butcher@hp.com',
|
* 'username' => 'matthew.butcher@hp.com',
|
||||||
* 'password' => 'secret',
|
* 'password' => 'secret',
|
||||||
@@ -128,12 +127,12 @@
|
|||||||
*
|
*
|
||||||
* // Create a new identity service object, and tell it where to
|
* // Create a new identity service object, and tell it where to
|
||||||
* // go to authenticate. This URL can be found in your HPCloud
|
* // go to authenticate. This URL can be found in your HPCloud
|
||||||
* // management console.
|
* // console.
|
||||||
* $identity = new IdentityServices('http://get.url.from.hpcloud.com');
|
* $identity = new IdentityServices('http://get.url.from.hpcloud.com');
|
||||||
*
|
*
|
||||||
* // You can authenticate either with username/password (IdentityServices::authenticateAsUser())
|
* // You can authenticate either with username/password (IdentityServices::authenticateAsUser())
|
||||||
* // or as an account/secret key (IdentityServices::authenticateAsAccount()). In either
|
* // or as an account/secret key (IdentityServices::authenticateAsAccount()). In either
|
||||||
* // case you can get the info you need from the management console.
|
* // case you can get the info you need from the console.
|
||||||
* $account = '123456789098765';
|
* $account = '123456789098765';
|
||||||
* $secret = 'dgasgasd';
|
* $secret = 'dgasgasd';
|
||||||
* $tenantId = '56545654';
|
* $tenantId = '56545654';
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ There are two ways to authenticate to Object Storage:
|
|||||||
For legacy swift authentication, you will need to use your Account ID
|
For legacy swift authentication, you will need to use your Account ID
|
||||||
and your secret Key, along with the URL to the Object Storage endpoint.
|
and your secret Key, along with the URL to the Object Storage endpoint.
|
||||||
If you are an existing HP Cloud customer, you can find all of this
|
If you are an existing HP Cloud customer, you can find all of this
|
||||||
information on your management dashboard.
|
information on your console dashboard.
|
||||||
|
|
||||||
### Using Stream Wrappers
|
### Using Stream Wrappers
|
||||||
|
|
||||||
|
|||||||
@@ -151,8 +151,8 @@ pieces of information:
|
|||||||
|
|
||||||
Before you issue a forlorn sigh, envisioning some laborious task, let us
|
Before you issue a forlorn sigh, envisioning some laborious task, let us
|
||||||
point out that all of this information is available in one place, Log
|
point out that all of this information is available in one place, Log
|
||||||
into [the management console](https://manage.hpcloud.com) and go to the
|
into [the console](https://console.hpcloud.com) and go to the `API Keys`
|
||||||
`API Keys` page. It's all there.
|
page. It's all there.
|
||||||
|
|
||||||
### Identity Services
|
### Identity Services
|
||||||
|
|
||||||
|
|||||||
@@ -92,8 +92,7 @@ of information:
|
|||||||
looks something like this: `https://region-a.geo-1.identity.hpcloudsvc.com:35357`
|
looks something like this: `https://region-a.geo-1.identity.hpcloudsvc.com:35357`
|
||||||
|
|
||||||
All four of these pieces of information can be found in the **API Keys**
|
All four of these pieces of information can be found in the **API Keys**
|
||||||
section of your [management console](https://manage.hpcloud.com)
|
section of your [console](https://console.hpcloud.com) account.
|
||||||
account.
|
|
||||||
|
|
||||||
(Note: You can use your username and password instead of account and
|
(Note: You can use your username and password instead of account and
|
||||||
key, but you still must supply the tenant ID. Instead of supplying
|
key, but you still must supply the tenant ID. Instead of supplying
|
||||||
|
|||||||
@@ -75,8 +75,8 @@ namespace HPCloud\Services;
|
|||||||
* A list of tenants associated with this account can be obtain programatically
|
* A list of tenants associated with this account can be obtain programatically
|
||||||
* using the tenants() method on this object.
|
* using the tenants() method on this object.
|
||||||
*
|
*
|
||||||
* HPCloud customers can find their tenant ID in the management console along
|
* HPCloud customers can find their tenant ID in the console along with their
|
||||||
* with their account ID and secret key.
|
* account ID and secret key.
|
||||||
*
|
*
|
||||||
* @b EXAMPLE
|
* @b EXAMPLE
|
||||||
*
|
*
|
||||||
@@ -311,7 +311,7 @@ class IdentityServices {
|
|||||||
* A password string.
|
* A password string.
|
||||||
* @param string $tenantId
|
* @param string $tenantId
|
||||||
* The tenant ID for this account. This can be obtained through the
|
* The tenant ID for this account. This can be obtained through the
|
||||||
* HPCloud management console.
|
* HPCloud console.
|
||||||
* @throws HPCloud::Transport::AuthorizationException
|
* @throws HPCloud::Transport::AuthorizationException
|
||||||
* If authentication failed.
|
* If authentication failed.
|
||||||
* @throws HPCloud::Exception
|
* @throws HPCloud::Exception
|
||||||
@@ -340,7 +340,7 @@ class IdentityServices {
|
|||||||
* used with other HPCloud services, such as Object Storage (aka Swift).
|
* used with other HPCloud services, such as Object Storage (aka Swift).
|
||||||
*
|
*
|
||||||
* The account ID and access key information can be found in the account
|
* The account ID and access key information can be found in the account
|
||||||
* section of the management console.
|
* section of the console.
|
||||||
*
|
*
|
||||||
* The third paramater allows you to specify a tenant ID. In order to access
|
* The third paramater allows you to specify a tenant ID. In order to access
|
||||||
* services, this object will need a tenant ID. If none is specified, it can
|
* services, this object will need a tenant ID. If none is specified, it can
|
||||||
|
|||||||
@@ -38,8 +38,8 @@ including:
|
|||||||
* URL: The Endpoint URL.
|
* URL: The Endpoint URL.
|
||||||
|
|
||||||
All four pieces of information can be found by logging into [the
|
All four pieces of information can be found by logging into [the
|
||||||
management console](https://manage.hpcloud.com) and going to the section
|
console](https://console.hpcloud.com) and going to the section called
|
||||||
called *Storage*. There should be a link on that page that says *Get
|
*Storage*. There should be a link on that page that says *Get
|
||||||
Storage API Keys*. That page displays all four pieces of required
|
Storage API Keys*. That page displays all four pieces of required
|
||||||
information.
|
information.
|
||||||
|
|
||||||
@@ -91,7 +91,7 @@ hpcloud.identity.key = 9878787
|
|||||||
```
|
```
|
||||||
|
|
||||||
You will need to add all of the `hpcloud.identity` settings, and all of
|
You will need to add all of the `hpcloud.identity` settings, and all of
|
||||||
this information can be found on your management console.
|
this information can be found on your console.
|
||||||
|
|
||||||
The hpcloud.swift.account, key, and url params are no longer required
|
The hpcloud.swift.account, key, and url params are no longer required
|
||||||
for the basic tests, but are required if you are also running the tests
|
for the basic tests, but are required if you are also running the tests
|
||||||
|
|||||||
Reference in New Issue
Block a user