€cdocutils.nodes document q)q}q(U nametypesq}q(Xgetting startedqNXconceptsqNX"3. create a stack from a template.qNX orchestrationq NX:2. obtain an orchestration service object from the client.q NX next stepsq NX01. instantiate an openstack or rackspace client.q NuUsubstitution_defsq }qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hUgetting-startedqhUconceptsqhUcreate-a-stack-from-a-templateqh U orchestrationqh U6obtain-an-orchestration-service-object-from-the-clientqh U next-stepsqh U,instantiate-an-openstack-or-rackspace-clientquUchildrenq]qcdocutils.nodes section q)q }q!(U rawsourceq"UUparentq#hUsourceq$XP/Users/jamie/projects/php/php-opencloud/doc/services/orchestration/README.md.rstq%Utagnameq&Usectionq'U attributesq(}q)(Udupnamesq*]Uclassesq+]Ubackrefsq,]Uidsq-]q.haUnamesq/]q0h auUlineq1KUdocumentq2hh]q3(cdocutils.nodes title q4)q5}q6(h"X Orchestrationq7h#h h$h%h&Utitleq8h(}q9(h*]h+]h,]h-]h/]uh1Kh2hh]q:cdocutils.nodes Text q;X Orchestrationq<…q=}q>(h"h7h#h5ubaubcdocutils.nodes paragraph q?)q@}qA(h"X·**Orchestration** is a service that can be used to create and manage cloud resources. Examples of such resources are databases, load balancers, servers and software installed on them.h#h h$h%h&U paragraphqBh(}qC(h*]h+]h,]h-]h/]uh1Kh2hh]qD(cdocutils.nodes strong qE)qF}qG(h"X**Orchestration**h(}qH(h*]h+]h,]h-]h/]uh#h@h]qIh;X OrchestrationqJ…qK}qL(h"Uh#hFubah&UstrongqMubh;X¦ is a service that can be used to create and manage cloud resources. Examples of such resources are databases, load balancers, servers and software installed on them.qN…qO}qP(h"X¦ is a service that can be used to create and manage cloud resources. Examples of such resources are databases, load balancers, servers and software installed on them.h#h@ubeubh)qQ}qR(h"Uh#h h$h%h&h'h(}qS(h*]h+]h,]h-]qThah/]qUhauh1K h2hh]qV(h4)qW}qX(h"XConceptsqYh#hQh$h%h&h8h(}qZ(h*]h+]h,]h-]h/]uh1K h2hh]q[h;XConceptsq\…q]}q^(h"hYh#hWubaubh?)q_}q`(h"XYTo use the Orchestration service effectively, you should understand several key concepts:qah#hQh$h%h&hBh(}qb(h*]h+]h,]h-]h/]uh1K h2hh]qch;XYTo use the Orchestration service effectively, you should understand several key concepts:qd…qe}qf(h"hah#h_ubaubcdocutils.nodes bullet_list qg)qh}qi(h"Uh#hQh$h%h&U bullet_listqjh(}qk(UbulletqlX-h-]h,]h*]h+]h/]uh1Kh2hh]qm(cdocutils.nodes list_item qn)qo}qp(h"XU**Template**: An Orchestration template is a JSON or YAML document that describes how a set of resources should be assembled to produce a working deployment. The template specifies what resources should be used, what attributes of these resources are parameterized and what information is output to the user when a template is instantiated. h#hhh$h%h&U list_itemqqh(}qr(h*]h+]h,]h-]h/]uh1Nh2hh]qsh?)qt}qu(h"XT**Template**: An Orchestration template is a JSON or YAML document that describes how a set of resources should be assembled to produce a working deployment. The template specifies what resources should be used, what attributes of these resources are parameterized and what information is output to the user when a template is instantiated.h#hoh$h%h&hBh(}qv(h*]h+]h,]h-]h/]uh1Kh]qw(hE)qx}qy(h"X **Template**h(}qz(h*]h+]h,]h-]h/]uh#hth]q{h;XTemplateq|…q}}q~(h"Uh#hxubah&hMubh;XH: An Orchestration template is a JSON or YAML document that describes how a set of resources should be assembled to produce a working deployment. The template specifies what resources should be used, what attributes of these resources are parameterized and what information is output to the user when a template is instantiated.q…q€}q(h"XH: An Orchestration template is a JSON or YAML document that describes how a set of resources should be assembled to produce a working deployment. The template specifies what resources should be used, what attributes of these resources are parameterized and what information is output to the user when a template is instantiated.h#htubeubaubhn)q‚}qƒ(h"Xä**Resource**: A resource is a template artifact that represents some component of your desired architecture (a Cloud Server, a group of scaled Cloud Servers, a load balancer, some configuration management system, and so forth). h#hhh$h%h&hqh(}q„(h*]h+]h,]h-]h/]uh1Nh2hh]q…h?)q†}q‡(h"Xã**Resource**: A resource is a template artifact that represents some component of your desired architecture (a Cloud Server, a group of scaled Cloud Servers, a load balancer, some configuration management system, and so forth).h#h‚h$h%h&hBh(}qˆ(h*]h+]h,]h-]h/]uh1Kh]q‰(hE)qŠ}q‹(h"X **Resource**h(}qŒ(h*]h+]h,]h-]h/]uh#h†h]qh;XResourceqŽ…q}q(h"Uh#hŠubah&hMubh;X×: A resource is a template artifact that represents some component of your desired architecture (a Cloud Server, a group of scaled Cloud Servers, a load balancer, some configuration management system, and so forth).q‘…q’}q“(h"X×: A resource is a template artifact that represents some component of your desired architecture (a Cloud Server, a group of scaled Cloud Servers, a load balancer, some configuration management system, and so forth).h#h†ubeubaubhn)q”}q•(h"X†**Stack**: A stack is a running instance of a template. When a stack is created, the resources specified in the template are created. h#hhh$h%h&hqh(}q–(h*]h+]h,]h-]h/]uh1Nh2hh]q—h?)q˜}q™(h"X…**Stack**: A stack is a running instance of a template. When a stack is created, the resources specified in the template are created.h#h”h$h%h&hBh(}qš(h*]h+]h,]h-]h/]uh1Kh]q›(hE)qœ}q(h"X **Stack**h(}qž(h*]h+]h,]h-]h/]uh#h˜h]qŸh;XStackq …q¡}q¢(h"Uh#hœubah&hMubh;X|: A stack is a running instance of a template. When a stack is created, the resources specified in the template are created.q£…q¤}q¥(h"X|: A stack is a running instance of a template. When a stack is created, the resources specified in the template are created.h#h˜ubeubaubeubeubh)q¦}q§(h"Uh#h h$h%h&h'h(}q¨(h*]h+]h,]h-]q©hah/]qªhauh1Kh2hh]q«(h4)q¬}q­(h"XGetting startedq®h#h¦h$h%h&h8h(}q¯(h*]h+]h,]h-]h/]uh1Kh2hh]q°h;XGetting startedq±…q²}q³(h"h®h#h¬ubaubh)q´}qµ(h"Uh#h¦h$h%h&h'h(}q¶(h*]h+]h,]h-]q·hah/]q¸h auh1K h2hh]q¹(h4)qº}q»(h"X01. Instantiate an OpenStack or Rackspace client.q¼h#h´h$h%h&h8h(}q½(h*]h+]h,]h-]h/]uh1K h2hh]q¾h;X01. Instantiate an OpenStack or Rackspace client.q¿…qÀ}qÁ(h"h¼h#hºubaubh?)qÂ}qÃ(h"XlTo use the Orchestration service, you must first instantiate a ``OpenStack`` or ``Rackspace`` client object.h#h´h$h%h&hBh(}qÄ(h*]h+]h,]h-]h/]uh1K"h2hh]qÅ(h;X?To use the Orchestration service, you must first instantiate a qÆ…qÇ}qÈ(h"X?To use the Orchestration service, you must first instantiate a h#hÂubcdocutils.nodes literal qÉ)qÊ}qË(h"X ``OpenStack``h(}qÌ(h*]h+]h,]h-]h/]uh#hÂh]qÍh;X OpenStackqÎ…qÏ}qÐ(h"Uh#hÊubah&UliteralqÑubh;X or qÒ…qÓ}qÔ(h"X or h#hÂubhÉ)qÕ}qÖ(h"X ``Rackspace``h(}q×(h*]h+]h,]h-]h/]uh#hÂh]qØh;X RackspaceqÙ…qÚ}qÛ(h"Uh#hÕubah&hÑubh;X client object.qÜ…qÝ}qÞ(h"X client object.h#hÂubeubhg)qß}qà(h"Uh#h´h$h%h&hjh(}qá(hlX-h-]h,]h*]h+]h/]uh1K%h2hh]qâ(hn)qã}qä(h"XkIf you are working with an OpenStack cloud, instantiate an ``OpenCloud\OpenStack`` client as follows: .. code:: php use OpenCloud\OpenStack; $client = new OpenStack('', array( 'username' => '', 'password' => '' )); h#hßh$Nh&hqh(}qå(h*]h+]h,]h-]h/]uh1Nh2hh]qæ(h?)qç}qè(h"XeIf you are working with an OpenStack cloud, instantiate an ``OpenCloud\OpenStack`` client as follows:h#hãh$h%h&hBh(}qé(h*]h+]h,]h-]h/]uh1K%h]qê(h;X;If you are working with an OpenStack cloud, instantiate an që…qì}qí(h"X;If you are working with an OpenStack cloud, instantiate an h#hçubhÉ)qî}qï(h"X``OpenCloud\OpenStack``h(}qð(h*]h+]h,]h-]h/]uh#hçh]qñh;XOpenCloud\OpenStackqò…qó}qô(h"Uh#hîubah&hÑubh;X client as follows:qõ…qö}q÷(h"X client as follows:h#hçubeubcdocutils.nodes literal_block qø)qù}qú(h"Xàuse OpenCloud\OpenStack; $client = new OpenStack('', array( 'username' => '', 'password' => '' ));h(}qû(U xml:spaceqüUpreserveqýh-]h,]h*]h+]qþ(UcodeqÿXphpreh/]uh#hãh]rcdocutils.nodes inline r)r}r(h"Xàuse OpenCloud\OpenStack; $client = new OpenStack('', array( 'username' => '', 'password' => '' ));h(}r(h*]h+]rUotherrah,]h-]h/]uh#hùh]rh;Xàuse OpenCloud\OpenStack; $client = new OpenStack('', array( 'username' => '', 'password' => '' ));r …r }r (h"Uh#jubah&Uinliner ubah&U literal_blockr ubeubhn)r}r(h"XaIf you are working with the Rackspace cloud, instantiate a ``OpenCloud\Rackspace`` client as follows: .. code:: php use OpenCloud\Rackspace; $client = new Rackspace(Rackspace::US_IDENTITY_ENDPOINT, array( 'username' => '', 'apiKey' => '' )); h#hßh$Nh&hqh(}r(h*]h+]h,]h-]h/]uh1Nh2hh]r(h?)r}r(h"XeIf you are working with the Rackspace cloud, instantiate a ``OpenCloud\Rackspace`` client as follows:h#jh$h%h&hBh(}r(h*]h+]h,]h-]h/]uh1K1h]r(h;X;If you are working with the Rackspace cloud, instantiate a r…r}r(h"X;If you are working with the Rackspace cloud, instantiate a h#jubhÉ)r}r(h"X``OpenCloud\Rackspace``h(}r(h*]h+]h,]h-]h/]uh#jh]rh;XOpenCloud\Rackspacer…r}r(h"Uh#jubah&hÑubh;X client as follows:r …r!}r"(h"X client as follows:h#jubeubhø)r#}r$(h"XÖuse OpenCloud\Rackspace; $client = new Rackspace(Rackspace::US_IDENTITY_ENDPOINT, array( 'username' => '', 'apiKey' => '' ));h(}r%(hühýh-]h,]h*]h+]r&(hÿXphpr'eh/]uh#jh]r(j)r)}r*(h"XÖuse OpenCloud\Rackspace; $client = new Rackspace(Rackspace::US_IDENTITY_ENDPOINT, array( 'username' => '', 'apiKey' => '' ));h(}r+(h*]h+]r,Uotherr-ah,]h-]h/]uh#j#h]r.h;XÖuse OpenCloud\Rackspace; $client = new Rackspace(Rackspace::US_IDENTITY_ENDPOINT, array( 'username' => '', 'apiKey' => '' ));r/…r0}r1(h"Uh#j)ubah&j ubah&j ubeubeubeubh)r2}r3(h"Uh#h¦h$h%h&h'h(}r4(h*]h+]h,]h-]r5hah/]r6h auh1K>h2hh]r7(h4)r8}r9(h"X:2. Obtain an Orchestration service object from the client.r:h#j2h$h%h&h8h(}r;(h*]h+]h,]h-]h/]uh1K>h2hh]r<h;X:2. Obtain an Orchestration service object from the client.r=…r>}r?(h"j:h#j8ubaubh?)r@}rA(h"XÎAll Orchestration operations are done via an *orchestration service object*. To instantiate this object, call the ``orchestrationService`` method on the ``$client`` object as shown in the following example:h#j2h$h%h&hBh(}rB(h*]h+]h,]h-]h/]uh1K@h2hh]rC(h;X-All Orchestration operations are done via an rD…rE}rF(h"X-All Orchestration operations are done via an h#j@ubcdocutils.nodes emphasis rG)rH}rI(h"X*orchestration service object*h(}rJ(h*]h+]h,]h-]h/]uh#j@h]rKh;Xorchestration service objectrL…rM}rN(h"Uh#jHubah&UemphasisrOubh;X'. To instantiate this object, call the rP…rQ}rR(h"X'. To instantiate this object, call the h#j@ubhÉ)rS}rT(h"X``orchestrationService``h(}rU(h*]h+]h,]h-]h/]uh#j@h]rVh;XorchestrationServicerW…rX}rY(h"Uh#jSubah&hÑubh;X method on the rZ…r[}r\(h"X method on the h#j@ubhÉ)r]}r^(h"X ``$client``h(}r_(h*]h+]h,]h-]h/]uh#j@h]r`h;X$clientra…rb}rc(h"Uh#j]ubah&hÑubh;X* object as shown in the following example:rd…re}rf(h"X* object as shown in the following example:h#j@ubeubhø)rg}rh(h"Xf$region = ''; $orchestrationService = $client->orchestrationService(null, $region);h#j2h$h%h&j h(}ri(hühýh-]h,]h*]h+]rj(hÿXphprkeh/]uh1KHh2hh]rlj)rm}rn(h"Xf$region = ''; $orchestrationService = $client->orchestrationService(null, $region);h(}ro(h*]h+]rpUotherrqah,]h-]h/]uh#jgh]rrh;Xf$region = ''; $orchestrationService = $client->orchestrationService(null, $region);rs…rt}ru(h"Uh#jmubah&j ubaubh?)rv}rw(h"XŠAny stacks and resources created with this ``$orchestrationService`` instance will be stored in the cloud region specified by ``$region``.h#j2h$h%h&hBh(}rx(h*]h+]h,]h-]h/]uh1KIh2hh]ry(h;X+Any stacks and resources created with this rz…r{}r|(h"X+Any stacks and resources created with this h#jvubhÉ)r}}r~(h"X``$orchestrationService``h(}r(h*]h+]h,]h-]h/]uh#jvh]r€h;X$orchestrationServicer…r‚}rƒ(h"Uh#j}ubah&hÑubh;X: instance will be stored in the cloud region specified by r„…r…}r†(h"X: instance will be stored in the cloud region specified by h#jvubhÉ)r‡}rˆ(h"X ``$region``h(}r‰(h*]h+]h,]h-]h/]uh#jvh]rŠh;X$regionr‹…rŒ}r(h"Uh#j‡ubah&hÑubh;X.…rŽ}r(h"X.h#jvubeubeubh)r}r‘(h"Uh#h¦h$h%h&h'h(}r’(h*]h+]h,]h-]r“hah/]r”hauh1KMh2hh]r•(h4)r–}r—(h"X"3. Create a stack from a template.r˜h#jh$h%h&h8h(}r™(h*]h+]h,]h-]h/]uh1KMh2hh]ršh;X"3. Create a stack from a template.r›…rœ}r(h"j˜h#j–ubaubhø)rž}rŸ(h"X|$stack = $orchestrationService->createStack(array( 'name' => 'simple-lamp-setup', 'templateUrl' => 'https://raw.githubusercontent.com/rackspace-orchestration-templates/lamp/master/lamp.yaml', 'parameters' => array( 'server_hostname' => 'web01', 'image' => 'Ubuntu 14.04 LTS (Trusty Tahr) (PVHVM)' ), 'timeoutMins' => 5 ));h#jh$h%h&j h(}r (hühýh-]h,]h*]h+]r¡(hÿXphpr¢eh/]uh1KZh2hh]r£j)r¤}r¥(h"X|$stack = $orchestrationService->createStack(array( 'name' => 'simple-lamp-setup', 'templateUrl' => 'https://raw.githubusercontent.com/rackspace-orchestration-templates/lamp/master/lamp.yaml', 'parameters' => array( 'server_hostname' => 'web01', 'image' => 'Ubuntu 14.04 LTS (Trusty Tahr) (PVHVM)' ), 'timeoutMins' => 5 ));h(}r¦(h*]h+]r§Uotherr¨ah,]h-]h/]uh#jžh]r©h;X|$stack = $orchestrationService->createStack(array( 'name' => 'simple-lamp-setup', 'templateUrl' => 'https://raw.githubusercontent.com/rackspace-orchestration-templates/lamp/master/lamp.yaml', 'parameters' => array( 'server_hostname' => 'web01', 'image' => 'Ubuntu 14.04 LTS (Trusty Tahr) (PVHVM)' ), 'timeoutMins' => 5 ));rª…r«}r¬(h"Uh#j¤ubah&j ubaubh?)r­}r®(h"X^[ `Get the executable PHP script for this example `__ ]h#jh$h%h&hBh(}r¯(h*]h+]h,]h-]h/]uh1K[h2hh]r°(h;X[ r±…r²}r³(h"X[ h#j­ubcdocutils.nodes reference r´)rµ}r¶(h"XZ`Get the executable PHP script for this example `__h(}r·(UnameX.Get the executable PHP script for this exampleUrefurir¸X%/samples/Orchestration/quickstart.phph-]h,]h*]h+]h/]uh#j­h]r¹h;X.Get the executable PHP script for this examplerº…r»}r¼(h"Uh#jµubah&U referencer½ubh;X ]r¾…r¿}rÀ(h"X ]h#j­ubeubeubeubh)rÁ}rÂ(h"Uh#h h$h%h&h'h(}rÃ(h*]h+]h,]h-]rÄhah/]rÅh auh1K_h2hh]rÆ(h4)rÇ}rÈ(h"X Next stepsrÉh#jÁh$h%h&h8h(}rÊ(h*]h+]h,]h-]h/]uh1K_h2hh]rËh;X Next stepsrÌ…rÍ}rÎ(h"jÉh#jÇubaubh?)rÏ}rÐ(h"X~Once you have created a stack, there is more you can do with it. See `complete user guide for orchestration `__.h#jÁh$h%h&hBh(}rÑ(h*]h+]h,]h-]h/]uh1Kah2hh]rÒ(h;XEOnce you have created a stack, there is more you can do with it. See rÓ…rÔ}rÕ(h"XEOnce you have created a stack, there is more you can do with it. See h#jÏubj´)rÖ}r×(h"X8`complete user guide for orchestration `__h(}rØ(UnameX%complete user guide for orchestrationj¸X USERGUIDE.mdh-]h,]h*]h+]h/]uh#jÏh]rÙh;X%complete user guide for orchestrationrÚ…rÛ}rÜ(h"Uh#jÖubah&j½ubh;X.…rÝ}rÞ(h"X.h#jÏubeubeubeubah"UU transformerrßNU footnote_refsrà}ráUrefnamesrâ}rãUsymbol_footnotesrä]råUautofootnote_refsræ]rçUsymbol_footnote_refsrè]réU citationsrê]rëh2hU current_linerìNUtransform_messagesrí]rîUreporterrïNUid_startrðKU autofootnotesrñ]ròU citation_refsró}rôUindirect_targetsrõ]röUsettingsr÷(cdocutils.frontend Values røorù}rú(Ufootnote_backlinksrûKUrecord_dependenciesrüNU rfc_base_urlrýUhttp://tools.ietf.org/html/rþU tracebackrÿˆUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelr KU strip_classesr Nh8NUerror_encoding_error_handlerr Ubackslashreplacer Udebugr NUembed_stylesheetr‰Uoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrˆUtrim_footnote_reference_spacer‰UenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformr‰U source_linkr NUrfc_referencesr!NUoutput_encodingr"Uutf-8r#U source_urlr$NUinput_encodingr%U utf-8-sigr&U_disable_configr'NU id_prefixr(UU tab_widthr)KUerror_encodingr*UUTF-8r+U_sourcer,h%Ugettext_compactr-ˆU generatorr.NUdump_internalsr/NU smart_quotesr0‰U pep_base_urlr1Uhttp://www.python.org/dev/peps/r2Usyntax_highlightr3Ulongr4Uinput_encoding_error_handlerr5jUauto_id_prefixr6Uidr7Udoctitle_xformr8‰Ustrip_elements_with_classesr9NU _config_filesr:]r;Ufile_insertion_enabledr<ˆU raw_enabledr=KU dump_settingsr>NubUsymbol_footnote_startr?KUidsr@}rA(hjhh¦hh hh´hjÁhj2hhQuUsubstitution_namesrB}rCh&h2h(}rD(h*]h-]h,]Usourceh%h+]h/]uU footnotesrE]rFUrefidsrG}rHub.