1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
|
<?xml version="1.0" encoding="utf-8"?>
<sect1 id="zend.service.rackspace">
<title>Zend_Service_Rackspace</title>
<sect2 id="zend.service.rackspace.introduction">
<title>Introduction</title>
<para>
The <classname>Zend_Service_Rackspace</classname> is a class that
provides a simple <acronym>API</acronym> to manage the Rackspace services
Cloud Files and Cloud Servers.
</para>
<note><title>Load balancers service</title>
<para>
The load balancers service of Rackspace is not implemented yet.
We are planning to release it in the next future.
</para>
</note>
</sect2>
<sect2 id="zend.service.rackspace.registering">
<title>Registering with Rackspace</title>
<para>
Before you can get started with <classname>Zend_Service_Rackspace</classname>, you must
first register for an account. Please see the
<ulink url="http://www.rackspace.com/cloud/">Cloud services</ulink>
page on the Rackspace website for more information.
</para>
<para>
After registering, you can get the Username and the API Key from the Rackspace management
console under the menu "Your Account" > "API Access".
These informations are required to use the <classname>Zend_Service_Rackspace</classname>
classes.
</para>
</sect2>
<sect2 id="zend.service.rackspace.feature.files">
<title>Cloud Files</title>
<para>
The Cloud Files is a service to store any files in a cloud environment.
A user can store an unlimited quantity of files and each file can be as
large as 5 gigabytes. The files can be private or public. The private files
can be accessed using the API of Rackspace. The public files are accessed using
a <acronym>CDN</acronym> (Content Delivery Network).
Rackspace exposes a <acronym>REST</acronym> API to manage the Cloud Files.
</para>
<para>
<classname>Zend_Service_Rackspace_Files</classname> provides the following functionality:
<itemizedlist>
<listitem>
<para>
Upload files programmatically for tight integration with your application
</para>
</listitem>
<listitem>
<para>
Enable Cloud Files CDN integration on any container for public distribution
</para>
</listitem>
<listitem>
<para>
Create Containers programmatically
</para>
</listitem>
<listitem>
<para>
Retrieve lists of containers and files
</para>
</listitem>
</itemizedlist>
</para>
</sect2>
<sect2 id="zend.service.rackspace.feature.servers">
<title>Cloud Servers</title>
<para>
Rackspace Cloud Servers is a compute service that provides server capacity in the cloud.
Cloud Servers come in different flavors of memory, disk space, and CPU.
</para>
<para>
<classname>Zend_Service_Rackspace_Servers</classname> provides the following functionality:
<itemizedlist>
<listitem>
<para>
Create/delete new servers
</para>
</listitem>
<listitem>
<para>
List and get information on each server
</para>
</listitem>
<listitem>
<para>
Manage the public/private IP addresses of a server
</para>
</listitem>
<listitem>
<para>
Resize the server capacity
</para>
</listitem>
<listitem>
<para>
Reboot a server
</para>
</listitem>
<listitem>
<para>
Create new images for a server
</para>
</listitem>
<listitem>
<para>
Manage the backup of a server
</para>
</listitem>
<listitem>
<para>
Create a group of server to share the IP addresses for High Availability architecture
</para>
</listitem>
</itemizedlist>
</para>
</sect2>
<sect2 id="zend.service.rackspace.methods">
<title>Available Methods</title>
<para>
Eeach service class (Files, Servers) of Rackspace extends the <classname>Zend_Service_Rackspace</classname> abstract class.
This class contains a set of public methods shared with all the service.
This public methods are reported as follow:
</para>
<variablelist>
<varlistentry id="zend.service.rackspace.files.methods.authenticate">
<term>
<methodsynopsis>
<methodname>authenticate</methodname>
<methodparam>
<funcparams/>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Authenticate the Rackspace API using the user and the key specified in the concrete class
that extend <classname>Zend_Service_Rackspace</classname>.
Return <emphasis>true</emphasis> in case of success and <emphasis>false</emphasis> in case of error.
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.set-service-net">
<term>
<methodsynopsis>
<methodname>setServiceNet</methodname>
<methodparam>
<funcparams>boolean $useServiceNet = true</funcparams>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Use the Rackspace 'ServiceNet' internal network.
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.get-service-net">
<term>
<methodsynopsis>
<methodname>getServiceNet</methodname>
<methodparam>
<funcparams/>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Are we using the Rackspace 'ServiceNet' internal network?
Returns a boolean.
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.get-auth-url">
<term>
<methodsynopsis>
<methodname>getAuthUrl</methodname>
<methodparam>
<funcparams/>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Get the authentication URL of Rackspace.
Returns a string.
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.get-cdn-url">
<term>
<methodsynopsis>
<methodname>getCdnUrl</methodname>
<methodparam>
<funcparams/>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Get the URL for the CDN.
Returns a string.
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.get-error-code">
<term>
<methodsynopsis>
<methodname>getErrorCode</methodname>
<methodparam>
<funcparams/>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Get the last HTTP error code.
Returns a string.
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.get-error-msg">
<term>
<methodsynopsis>
<methodname>getErrorMsg</methodname>
<methodparam>
<funcparams/>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Get the last error message.
Returns a string.
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.get-http-client">
<term>
<methodsynopsis>
<methodname>getHttpClient</methodname>
<methodparam>
<funcparams/>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Get the HTTP client used to call the API of the Rackspace.
Returns a <classname>Zend_Http_Client</classname> instance.
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.get-key">
<term>
<methodsynopsis>
<methodname>getKey</methodname>
<methodparam>
<funcparams/>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Get the authentication key.
Returns a string.
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.get-management-url">
<term>
<methodsynopsis>
<methodname>getManagementUrl</methodname>
<methodparam>
<funcparams/>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Get the URL for the management services.
Returns a string.
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.get-storage-url">
<term>
<methodsynopsis>
<methodname>getStorageUrl</methodname>
<methodparam>
<funcparams/>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Get the URL for the storage (files) service.
Returns a string.
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.get-token">
<term>
<methodsynopsis>
<methodname>getToken</methodname>
<methodparam>
<funcparams/>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Get the token returned after a successful authentication.
Returns a string.
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.get-user">
<term>
<methodsynopsis>
<methodname>getUser</methodname>
<methodparam>
<funcparams/>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Get the user authenticated with the Rackspace service.
Returns a string.
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.is-successful">
<term>
<methodsynopsis>
<methodname>isSuccessful</methodname>
<methodparam>
<funcparams/>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Return <emphasis>true</emphasis> if the last service call was successful, false otherwise.
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.set-auth-url">
<term>
<methodsynopsis>
<methodname>setAuthUrl</methodname>
<methodparam>
<funcparams>string $url</funcparams>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Set the authentication URL to be used.
</para>
<para>
<emphasis>$url</emphasis> is the URL for the authentication
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.set-key">
<term>
<methodsynopsis>
<methodname>setKey</methodname>
<methodparam>
<funcparams>string $key</funcparams>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Set the key for the API authentication.
</para>
<para>
<emphasis>$key</emphasis> is the key string for the authentication
</para>
</listitem>
</varlistentry>
<varlistentry id="zend.service.rackspace.files.methods.set-user">
<term>
<methodsynopsis>
<methodname>setUser</methodname>
<methodparam>
<funcparams>string $user</funcparams>
</methodparam>
</methodsynopsis>
</term>
<listitem>
<para>
Set the user for the API authentication.
</para>
<para>
<emphasis>$user</emphasis> is the user string for the authentication
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
|
