Zend_Service_Amazon_Ec2-Image.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.service.amazon.ec2.images">
  5. <title>Zend_Service_Amazon_Ec2: Amazon Maschinen Images (AMI)</title>
  6. <para>
  7. Amazon Maschinen Images (AMIs) sind mit einer bereits wachsenden Listen von
  8. Betriebssystemen vorkonfiguriert.
  9. </para>
  10. <sect2 id="zend.service.amazon.ec2.images.info">
  11. <title>AMI Informations Tools</title>
  12. <example id="zend.service.amazon.ec2.images.register">
  13. <title>Ein AMI mit EC2 registrieren</title>
  14. <para>
  15. <code>register</code> Jedes <acronym>AMI</acronym> ist mit einer eideutigen ID
  16. assoziiert welche vom Amazon EC2 Service über die RegisterImage Operation zur
  17. Verfügung gestellt wird. Wärend der Registrierung empfängt Amazon EC2 das
  18. spezifizierte Manifest des Images von Amazon S3 und überprüft ob das Image dem
  19. Benutzer gehört der das Image registriert.
  20. </para>
  21. <para>
  22. <code>register</code> gibt die imageId für das registrierte Image zurück.
  23. </para>
  24. <programlisting language="php"><![CDATA[
  25. $ec2_img = new Zend_Service_Amazon_Ec2_Image('aws_key','aws_secret_key');
  26. $ip = $ec2_img->register('imageLocation');
  27. ]]></programlisting>
  28. </example>
  29. <example id="zend.service.amazon.ec2.images.deregister">
  30. <title>De-Registrieren einer AMI von EC2</title>
  31. <para>
  32. <code>deregister</code>, de-registriert ein <acronym>AMI</acronym>. Einmal
  33. de-registriert können Instanzen dieses <acronym>AMI</acronym> nicht mehr gestartet
  34. werden.
  35. </para>
  36. <para>
  37. <code>deregister</code> gibt ein boolsches <constant>TRUE</constant> oder
  38. <constant>FALSE</constant> zurück.
  39. </para>
  40. <programlisting language="php"><![CDATA[
  41. $ec2_img = new Zend_Service_Amazon_Ec2_Image('aws_key','aws_secret_key');
  42. $ip = $ec2_img->deregister('imageId');
  43. ]]></programlisting>
  44. </example>
  45. <example id="zend.service.amazon.ec2.images.describe">
  46. <title>Beschreiben einer AMI</title>
  47. <para>
  48. <code>describe</code> gibt Informationen über <acronym>AMI</acronym>s, AKIs und ARIs
  49. zurück die für den Benutzer verfügbar sind. Die zurückgegebenen Informationen
  50. enthalten den Imagetyp, Produktcodes, Architektur, Kernel und <acronym>RAM</acronym>
  51. Disk IDs. Images die für den Benutzer verfügbar sind, enthalten öffentliche Images
  52. die zum Starten für jeden Benutzer vorhanden sind, private Images die dem Benutzer
  53. gehören der die Anfrage stellt, und private Images die anderen Benutzern gehören
  54. welche dem Benutzer explizit die Rechte zum Starten gegeben haben.
  55. </para>
  56. <para>
  57. <table id="zend.service.amazon.ec2.images.describe-table">
  58. <title>Die Rechte für das Starten fallen in drei Kategorien</title>
  59. <tgroup cols="2">
  60. <thead>
  61. <row>
  62. <entry>Name</entry>
  63. <entry>Beschreibung</entry>
  64. </row>
  65. </thead>
  66. <tbody>
  67. <row>
  68. <entry><code>public</code></entry>
  69. <entry>
  70. <para>
  71. Der Eigentümer des <acronym>AMI</acronym> gibt allen Gruppen
  72. das Recht das <acronym>AMI</acronym> zu starten. Alle
  73. Benutzer haben Startberechtigung für diese
  74. <acronym>AMIs</acronym>.
  75. </para>
  76. </entry>
  77. </row>
  78. <row>
  79. <entry><code>explicit</code></entry>
  80. <entry>
  81. <para>
  82. Der Eigentümer des <acronym>AMI</acronym> gibt einem
  83. spezifischen Benutzer die Startberechtigung.
  84. </para>
  85. </entry>
  86. </row>
  87. <row>
  88. <entry><code>implicit</code></entry>
  89. <entry>
  90. <para>
  91. Ein Benutzer hat implizit die Startberechtigung für alle
  92. <acronym>AMIs</acronym> die Ihm gehören.
  93. </para>
  94. </entry>
  95. </row>
  96. </tbody>
  97. </tgroup>
  98. </table>
  99. </para>
  100. <para>
  101. Die Liste der zurückgegebenen <acronym>AMI</acronym>s kann durch die Spezifikation
  102. von <acronym>AMI</acronym> IDs, <acronym>AMI</acronym> Eigentümer oder Benutzern mit
  103. Starterechtigung, geändert werden. Wenn keine Option spezifiziert wird, gibt Amazon
  104. EC2 alle <acronym>AMI</acronym>s zurück für die der Benutzer eine Startberechtigung
  105. hat.
  106. </para>
  107. <para>
  108. Wenn eine oder mehrere <acronym>AMI</acronym> IDs spezifiziert werden, werden nur
  109. die <acronym>AMI</acronym>s zurückgegeben welche die spezifizierten IDs besitzen.
  110. Wenn man eine ungültige <acronym>AMI</acronym> ID spezifiziert, wird ein Fehler
  111. zurückgegeben. Wenn man eine <acronym>AMI</acronym> ID spezifiziert für die man
  112. keinen Zugriff hat, wird diese nicht in den zurückgegebenen Ergebnissen enthalten
  113. sein.
  114. </para>
  115. <para>
  116. Wenn ein oder mehrere <acronym>AMI</acronym> Eigentümer spezifiziert werden, werden
  117. nur die <acronym>AMI</acronym>s der spezifizierten Eigentümer, für die man auch
  118. Zugriffsrechte hat, zurückgegeben. Die Ergebnisse können account für die Account IDs
  119. des spezifizierten Eigentümers enthalten, amazon für <acronym>AMI</acronym>s die
  120. Amazon selbst gehören oder self für <acronym>AMI</acronym>s die man selbst besitzt.
  121. </para>
  122. <para>
  123. Wenn man eine Liste von ausführbaren Benutzern spezifiziert, werden nur die
  124. Benutzer zurückgegeben die eine Startberechtigung für die <acronym>AMI</acronym>s
  125. haben. Man kann mit account, Account IDs spezifizieren (wenn man die
  126. <acronym>AMI</acronym>s besitzt), self für <acronym>AMI</acronym>s die man selbst
  127. besitzt oder explizite Zugriffsrechte hat, oder all für öffentliche
  128. <acronym>AMI</acronym>s.
  129. </para>
  130. <para>
  131. <code>describe</code> gibt ein Array für alle Images zurück die den übergebenen
  132. Kriterien entsprechen. Das Array enthält imageId, imageLocation, imageState,
  133. imageOwnerId, isPublic, architecture, imageType, kernedId, ramdiskId und platform.
  134. </para>
  135. <programlisting language="php"><![CDATA[
  136. $ec2_img = new Zend_Service_Amazon_Ec2_Image('aws_key','aws_secret_key');
  137. $ip = $ec2_img->describe();
  138. ]]></programlisting>
  139. </example>
  140. </sect2>
  141. <sect2 id="zend.service.amazon.ec2.images.attribute">
  142. <title>Utilities für AMI Attribute</title>
  143. <example id="zend.service.amazon.ec2.images.attribute.modify">
  144. <title>Image Attribute verändern</title>
  145. <para>Ein Attribut eines <acronym>AMI</acronym> verändern</para>
  146. <para>
  147. <table id="zend.service.amazon.ec2.images.attribute.modify-table">
  148. <title>Gültige Attribute</title>
  149. <tgroup cols="2">
  150. <thead>
  151. <row>
  152. <entry>Name</entry>
  153. <entry>Beschreibung</entry>
  154. </row>
  155. </thead>
  156. <tbody>
  157. <row>
  158. <entry><code>launchPermission</code></entry>
  159. <entry>
  160. <para>
  161. Kontrolliert wer die Berechtigung hat das
  162. <acronym>AMI</acronym> zu starten. Startberechtigung kann
  163. spezifischen Benutzern durch das hinzufügen von userIds
  164. gegeben werden.
  165. </para>
  166. <para>
  167. Um das <acronym>AMI</acronym> öffentlich zu machen, sollte
  168. man die add Gruppe hinzufügen.
  169. </para>
  170. </entry>
  171. </row>
  172. <row>
  173. <entry><code>productCodes</code></entry>
  174. <entry>
  175. <para>
  176. Assoziiert einen Produktcode mit <acronym>AMIs</acronym>.
  177. Das erlaubt es Entwicklern Benutzer für die Verwendung von
  178. <acronym>AMIs</acronym> zu benennen. Der Benutzer muß für
  179. das Produkt angemeldet sein bevor er das
  180. <acronym>AMI</acronym> starten kann. <emphasis>Das ist ein
  181. Write-Once Attribut; nachdem es gesetzt wurde kann es nicht
  182. mehr geändert oder gelöscht werden.</emphasis>
  183. </para>
  184. </entry>
  185. </row>
  186. </tbody>
  187. </tgroup>
  188. </table>
  189. </para>
  190. <para>
  191. <code>modifyAttribute</code> gibt ein boolsches <constant>TRUE</constant> oder
  192. <constant>FALSE</constant> zurück.
  193. </para>
  194. <programlisting language="php"><![CDATA[
  195. $ec2_img = new Zend_Service_Amazon_Ec2_Image('aws_key','aws_secret_key');
  196. // Ändert die Startberechtigung (launchPermission) eines AMI
  197. $return = $ec2_img->modifyAttribute('imageId',
  198. 'launchPermission',
  199. 'add',
  200. 'userId',
  201. 'userGroup');
  202. // Setzt den Produktcode des AMI.
  203. $return = $ec2_img->modifyAttribute('imageId',
  204. 'productCodes',
  205. 'add',
  206. null,
  207. null,
  208. 'productCode');
  209. ]]></programlisting>
  210. </example>
  211. <example id="zend.service.amazon.ec2.images.attribute.reset">
  212. <title>Zurücksetzen eines AMI Attributes</title>
  213. <para>
  214. <code>resetAttribute</code> setzt die Attribute eines <acronym>AMI</acronym> auf
  215. dessen Standardwerte zurück.
  216. <emphasis>Das productCodes Attribut kann nicht zurückgesetzt werden.</emphasis>
  217. </para>
  218. <programlisting language="php"><![CDATA[
  219. $ec2_img = new Zend_Service_Amazon_Ec2_Image('aws_key','aws_secret_key');
  220. $return = $ec2_img->resetAttribute('imageId', 'launchPermission');
  221. ]]></programlisting>
  222. </example>
  223. <example id="zend.service.amazon.ec2.images.attribute.describe">
  224. <title>AMI Attribute beschreiben</title>
  225. <para>
  226. <code>describeAttribute</code> gibt Informationen über ein Attribut eines
  227. <acronym>AMI</acronym> zurück. Pro Aufruf kann nur ein Attribut spezifiziert werden.
  228. Aktuell werden nur launchPermission und productCodes unterstützt.
  229. </para>
  230. <para>
  231. <code>describeAttribute</code> gibt ein Array mit dem Wert des Attributes zurück
  232. das angefragt wurde.
  233. </para>
  234. <programlisting language="php"><![CDATA[
  235. $ec2_img = new Zend_Service_Amazon_Ec2_Image('aws_key','aws_secret_key');
  236. $return = $ec2_img->describeAttribute('imageId', 'launchPermission');
  237. ]]></programlisting>
  238. </example>
  239. </sect2>
  240. </sect1>