[jbosstools-commits] JBoss Tools SVN: r28015 - in trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US: images and 1 other directory.

Author: mcaspers Date: 2011-01-09 21:38:44 -0500 (Sun, 09 Jan 2011) New Revision: 28015 Modified: trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/Revision_History.xml trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/add_and_manage_server_keys-task.xml trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/connecting_to_a_deltacloud_server-task.xml trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/images/Deltacloud-cloud_connection_wizard_2.png trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/images/Deltacloud-perspective-launch_instance.png trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/using_the_deltacloud_perspective-task.xml Log: Updated to include new functionality such as importing keys and launching instances. Modified: trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/Revision_History.xml =================================================================== --- trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/Revision_History.xml 2011-01-08 21:50:51 UTC (rev 28014) +++ trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/Revision_History.xml 2011-01-10 02:38:44 UTC (rev 28015) @@ -8,6 +8,20 @@ <simpara> <revhistory> <revision> + <revnumber>1</revnumber> + <date>Mon Jan 10 2011</date> + <author> + <firstname>Matthew</firstname> + <surname>Casperson</surname> + <email&gt;mcaspers(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>General updates</member> + </simplelist> + </revdescription> + </revision> + <revision> <revnumber>0</revnumber> <date>Fri Sep 24 2010</date> <author> Modified: trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/add_and_manage_server_keys-task.xml =================================================================== --- trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/add_and_manage_server_keys-task.xml 2011-01-08 21:50:51 UTC (rev 28014) +++ trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/add_and_manage_server_keys-task.xml 2011-01-10 02:38:44 UTC (rev 28015) @@ -6,7 +6,7 @@ <section id="sect-Cloud_Tools_Reference_Guide-Tasks-add_and_manage_server_keys"> <title>Add and manage server keys</title> <para> - To access Deltacloud servers, key file authentication is used. Each key represents the person accessing the server and informs the server of their authorisation level. + To access Deltacloud servers, key file authentication is used. Each key represents the person accessing the server and informs the server of their authorization level. </para> <para> Each unique user requires an individual key file and each file must be specified in the SSH2 private keys list prior to performing the ssh connection. To access the SSH2 private keys list navigate to <menuchoice> @@ -25,6 +25,11 @@ </imageobject> </mediaobject> </figure> + <para> + Keys are also imported when launching a new instance. Refer to <xref linkend="sect-Cloud_Tools_Reference_Guide-Tasks-using_the_deltacloud_perspective"/> for more information. + </para> + + </section> Modified: trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/connecting_to_a_deltacloud_server-task.xml =================================================================== --- trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/connecting_to_a_deltacloud_server-task.xml 2011-01-08 21:50:51 UTC (rev 28014) +++ trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/connecting_to_a_deltacloud_server-task.xml 2011-01-10 02:38:44 UTC (rev 28015) @@ -17,7 +17,7 @@ </mediaobject> </figure> <para> - To setup a connection to a Deltacloud server go to <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>. From the <guilabel>New</guilabel> dialog select <menuchoice><guimenuitem>Deltacloud</guimenuitem><guimenuitem>Cloud Connection</guimenuitem></menuchoice> and press <guibutton>Next</guibutton>. + To setup a connection to a Deltacloud server select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>. From the <guilabel>New</guilabel> dialog select <menuchoice><guimenuitem>Deltacloud</guimenuitem><guimenuitem>Cloud Connection</guimenuitem></menuchoice> and press <guibutton>Next</guibutton>. </para> <para> <figure id="opening_the_cloud_connection_wizard"> @@ -30,29 +30,29 @@ </figure> </para> <para> - The <guilabel>Cloud Connection</guilabel> dialog requires a cloud name, URl, username and password to create a connection. Once you specify a URL of a cloud server the <guilabel>Type</guilabel> field will automatically inform you of the cloud type. If you are connecting to a EC2 cloud type, use your <emphasis>Access ID</emphasis> for the <guilabel>Username</guilabel> field and your <emphasis>Access Secret Key</emphasis> for the <guilabel>Password</guilabel> field. + The <guilabel>Cloud Connection</guilabel> dialog requires a cloud name, URL, username and password to create a connection. Once you specify the URL of a cloud server the <guilabel>Type</guilabel> field will automatically inform you of the cloud type. If you are connecting to an EC2 cloud type, use your <emphasis>Access ID</emphasis> for the <guilabel>Username</guilabel> field and your <emphasis>Access Secret Key</emphasis> for the <guilabel>Password</guilabel> field. </para> <para> Once all fields are filled in correctly, click the <guibutton>Finish</guibutton> button. </para> <note> <para> - When running a local Deltacloud server, use <ulink url="http://localhost:3002">http://localhost:3002</ulink> for the server URL. + The default URL for a local Deltacloud server is <ulink url="http://localhost:3001">http://localhost:3001</ulink>. </para> - </note> + </note> <para> - <figure id="creating_the_connection"> - <title>Creating the connection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/Deltacloud-cloud_connection_wizard_2.png"/> - </imageobject> - </mediaobject> - </figure> + <figure id="creating_the_connection"> + <title>Creating the connection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Deltacloud-cloud_connection_wizard_2.png"/> + </imageobject> + </mediaobject> + </figure> </para> <para> - Your new cloud connection will appear in the <guilabel>Cloud Viewer</guilabel> as the name you specified in the connection wizard. For information on using your new cloud server connection see <xref linkend="sect-Cloud_Tools_Reference_Guide-Tasks-using_the_deltacloud_perspective"/> - </para> + Your new cloud connection will appear in the <guilabel>Cloud Viewer</guilabel> using the name you specified in the connection wizard. For information on using your new cloud server connection see <xref linkend="sect-Cloud_Tools_Reference_Guide-Tasks-using_the_deltacloud_perspective"/>. + </para> </section> Modified: trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/images/Deltacloud-cloud_connection_wizard_2.png =================================================================== (Binary files differ) Modified: trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/images/Deltacloud-perspective-launch_instance.png =================================================================== (Binary files differ) Modified: trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/using_the_deltacloud_perspective-task.xml =================================================================== --- trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/using_the_deltacloud_perspective-task.xml 2011-01-08 21:50:51 UTC (rev 28014) +++ trunk/deltacloud/docs/Cloud_Tools_Reference_Guide/en-US/using_the_deltacloud_perspective-task.xml 2011-01-10 02:38:44 UTC (rev 28015) @@ -6,31 +6,43 @@ <section id="sect-Cloud_Tools_Reference_Guide-Tasks-using_the_deltacloud_perspective"> <title>Using the Deltacloud perspective</title> <para> - The Deltacloud perspective consists of three different views: <guilabel>Cloud Viewer</guilabel>, <guilabel>Images</guilabel> and <guilabel>Instances</guilabel>. - </para> - <formalpara> - <title>The Cloud Viewer</title> - <para> - <guilabel>Cloud Viewer</guilabel> shows you the servers you are connected to, the instances running on each server and the images available on each server. Right-clicking on a cloud connection presents you with options to disconnect from a cloud using the <guimenuitem>Disconnect Cloud</guimenuitem> option or reload the the cloud view with the <guimenuitem>Refresh View</guimenuitem> option. Clicking on a connection name causes details to be shown in the <guilabel>Properties</guilabel> view. - </para> - </formalpara> - <figure id="deltacloud_perspective-the_cloud_viewer"> - <title>Deltacloud perspective: The Cloud Viewer</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/Deltacloud-perspective-cloud_viewer.png"/> - </imageobject> - </mediaobject> - </figure> - <para> - You can have multiple Deltacloud servers connected at any one time. If you have not yet setup a connection to a Deltacloud server see <xref linkend="sect-Cloud_Tools_Reference_Guide-Tasks-connecting_to_a_deltacloud_server"/>. You will also require a unique key file for each user who is to have access to the server. To add and manage your key files see <xref linkend="sect-Cloud_Tools_Reference_Guide-Tasks-add_and_manage_server_keys"/> + The Deltacloud perspective consists of three different views: <guilabel>Cloud Viewer</guilabel>, <guilabel>Images</guilabel> and <guilabel>Instances</guilabel>. </para> - <formalpara> - <title>The Images view</title> + <section id="thecloudviewer"> + <title>The Cloud Viewer</title> + + <para> + The <guilabel>Cloud Viewer</guilabel> view lists the servers you are connected to, the instances running on each server and the images available on each server. Right-clicking (or control-clicking on Mac OS) on a cloud connection presents you with options to disconnect from a cloud using the <guimenuitem>Disconnect Cloud</guimenuitem> option or reload the the cloud view with the <guimenuitem>Refresh View</guimenuitem> option. + </para> + + <para> + You can also right-click (or control-click on Mac OS) anywhere in the <guilabel>Cloud Viewer</guilabel> view and select the <guilabel>Launch Instance</guilabel> option to launch a new instance. See <xref linkend="theimagesview"/> for more information on lanching an instance. + </para> + + <para> + Clicking on a connection name causes details to be shown in the <guilabel>Properties</guilabel> view. + </para> + + <figure id="deltacloud_perspective-the_cloud_viewer"> + <title>Deltacloud perspective: The Cloud Viewer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Deltacloud-perspective-cloud_viewer.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You can have multiple Deltacloud servers connected at any one time. If you have not yet setup a connection to a Deltacloud server see <xref linkend="sect-Cloud_Tools_Reference_Guide-Tasks-connecting_to_a_deltacloud_server"/>. You will also require a unique key file for each user who is to have access to the server. To add and manage your key files see <xref linkend="sect-Cloud_Tools_Reference_Guide-Tasks-add_and_manage_server_keys"/> + </para> + + </section> + <section id="theimagesview"> + <title id="imagesview">The Images view</title> <para> Displayed in the <guilabel>Images</guilabel> view is a table of all images for a specified cloud. </para> - </formalpara> + <figure id="deltacloud_perspective-the_images_view"> <title>Deltacloud perspective: The Images view</title> <mediaobject> @@ -40,10 +52,10 @@ </mediaobject> </figure> <para> - By right-clicking on an image in the table and selecting <guimenuitem>Launch Instance</guimenuitem>, a dialog will appear. Define the <guilabel>Name</guilabel> of the instance, the <guilabel>Realm</guilabel> the instance should appear in, select a pre-defined <guilabel>Hardware Profile</guilabel> and choose a <guilabel>Key Name</guilabel> for key file authentication. + By right-clicking (or control-clicking on Mac OS) on an image in the table and selecting <guimenuitem>Launch Instance</guimenuitem>, a dialog will appear. Define the <guilabel>Name</guilabel> of the instance, the <guilabel>Realm</guilabel> the instance should appear in, select a pre-defined <guilabel>Hardware Profile</guilabel> and choose a <guilabel>Key Name</guilabel> for key file authentication. You can also change the default image by defining the value for the <guilabel>Image</guilabel> field, or by clicking the <guibutton>Find...</guibutton> button. </para> <para> - User authentication keys are managed for Deltacloud tooling by the <guilabel>Manage Keys</guilabel> dialog. When clicking on the <guibutton>Manage</guibutton> you will be presented with this dialog. Select one from the list or add a new one. When adding a new key through this dialog, be sure that it has first been added to the SSH2 key list by undertaking <xref linkend="sect-Cloud_Tools_Reference_Guide-Tasks-add_and_manage_server_keys"/>. + User authentication keys are managed for Deltacloud tooling by the <guilabel>Manage Keys</guilabel> dialog. When clicking on the <guibutton>Manage</guibutton> you will be presented with this dialog. Select one from the list or add a new one. Keys added via this method will be added to the SSH2 key list if they are not present. </para> <para> Click <guibutton>Finish</guibutton> to create the new instance. @@ -56,12 +68,13 @@ </imageobject> </mediaobject> </figure> - <formalpara> + </section> + <section id="theinstancesview"> <title>The Instances view</title> <para> Through the <guilabel>Instances</guilabel> view you can see all instances for a cloud server while having the functionality to start, stop and restart a selected instance. </para> - </formalpara> + <figure id="deltacloud_perspective-the_instances_view"> <title>Deltacloud perspective: The Instances view</title> <mediaobject> @@ -76,6 +89,7 @@ <para> Once connected, files on the external instance can be manipulated as if they were on your local machine. </para> + </section> </section>