[jbosstools-commits] JBoss Tools SVN: r41912 - in trunk/openshift/docs/reference/en-US: images and 5 other directories.

Author: irooskov(a)redhat.com Date: 2012-06-12 22:52:32 -0400 (Tue, 12 Jun 2012) New Revision: 41912 Added: trunk/openshift/docs/reference/en-US/Debugging.xml trunk/openshift/docs/reference/en-US/Deleting_applications_and_domains.xml trunk/openshift/docs/reference/en-US/Port_forwarding.xml trunk/openshift/docs/reference/en-US/Viewing_environment_variables.xml trunk/openshift/docs/reference/en-US/images/Creating_an_OpenShift_Express_Application/application_creation_13.png trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/ trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_01.png trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_02.png trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_03.png trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_04.png trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_05.png trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_06.png trunk/openshift/docs/reference/en-US/images/OpenShift_Environment_Variables/ trunk/openshift/docs/reference/en-US/images/OpenShift_Environment_Variables/openshift_environment_variables_01.png trunk/openshift/docs/reference/en-US/images/OpenShift_Environment_Variables/openshift_environment_variables_02.png trunk/openshift/docs/reference/en-US/images/Port_Forwarding/ trunk/openshift/docs/reference/en-US/images/Port_Forwarding/port_forwarding_01.png trunk/openshift/docs/reference/en-US/images/Port_Forwarding/port_forwarding_02.png Modified: trunk/openshift/docs/reference/en-US/Book_Info.xml trunk/openshift/docs/reference/en-US/Creating_an_OpenShift_Express_Application.xml trunk/openshift/docs/reference/en-US/OpenShift_Tools_Reference_Guide.xml trunk/openshift/docs/reference/en-US/Viewing_the_remote_console.xml trunk/openshift/docs/reference/en-US/images/OpenShift_Remote_Console/openshift_remote_console_01.png Log: updated with heaps of new content Modified: trunk/openshift/docs/reference/en-US/Book_Info.xml =================================================================== --- trunk/openshift/docs/reference/en-US/Book_Info.xml 2012-06-13 00:22:05 UTC (rev 41911) +++ trunk/openshift/docs/reference/en-US/Book_Info.xml 2012-06-13 02:52:32 UTC (rev 41912) @@ -13,7 +13,7 @@ <edition>5.0.0</edition> - <pubsnumber>10</pubsnumber> + <pubsnumber>11</pubsnumber> <abstract> <para> Modified: trunk/openshift/docs/reference/en-US/Creating_an_OpenShift_Express_Application.xml =================================================================== --- trunk/openshift/docs/reference/en-US/Creating_an_OpenShift_Express_Application.xml 2012-06-13 00:22:05 UTC (rev 41911) +++ trunk/openshift/docs/reference/en-US/Creating_an_OpenShift_Express_Application.xml 2012-06-13 02:52:32 UTC (rev 41912) @@ -196,5 +196,21 @@ <para> As with a local server, double-clicking on the OpenShift server instance in the <guilabel>Servers</guilabel> tab will open the server overview page in your workbench. </para> + <figure id="application_creation_13"> + <title>OpenShift server overview and settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Creating_an_OpenShift_Express_Application/application_creation_13.png" format="PNG" /> + </imageobject> + <textobject> + <phrase> + The OpenShift view. + </phrase> + </textobject> + </mediaobject> + </figure> + <para> + The OpenShift application will also be available under your domain in the <guilabel>OpenShift</guilabel> view. + </para> </chapter> Added: trunk/openshift/docs/reference/en-US/Debugging.xml =================================================================== --- trunk/openshift/docs/reference/en-US/Debugging.xml (rev 0) +++ trunk/openshift/docs/reference/en-US/Debugging.xml 2012-06-13 02:52:32 UTC (rev 41912) @@ -0,0 +1,11 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<chapter id="chap-OpenSift_Tools_Reference_Guide-Debugging"> + <title>Debugging</title> + <para> + This chapter covers useful tools for debugging OpenShift servers and applications. + </para> + <xi:include href="Viewing_the_remote_console.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Viewing_environment_variables.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> + Added: trunk/openshift/docs/reference/en-US/Deleting_applications_and_domains.xml =================================================================== --- trunk/openshift/docs/reference/en-US/Deleting_applications_and_domains.xml (rev 0) +++ trunk/openshift/docs/reference/en-US/Deleting_applications_and_domains.xml 2012-06-13 02:52:32 UTC (rev 41912) @@ -0,0 +1,121 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<chapter id="chap-OpenSift_Tools_Reference_Guide-Deleting_applications_and_domains"> + <title>Deleting applications and domains</title> + <para> + This chapter explains how to remove applications and domains from OpenShift. + </para> + <section> + <title>Deleting an application</title> + <para> + Deleting an application will remove it from your workbench and the OpenShift server. + </para> + <para> + To remove an application right-click on it in the <guilabel>OpenShift Explorer</guilabel> view tab and select <menuchoice><guimenuitem>Delete Application(s)</guimenuitem></menuchoice> from the context menu. + </para> + <figure id="delete_application_and_domain_01"> + <title>Delete Application(s) menu item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Deleting_Applications_and_Domains/delete_application_and_domain_01.png" format="PNG" /> + </imageobject> + <textobject> + <phrase> + Selecting the Delete Application(s) menu item. + </phrase> + </textobject> + </mediaobject> + </figure> + <para> + A dialog window will display asking you to confirm the action and alerting you that you will not be able to recover the application one it has been deleted. Click the <guibutton>OK</guibutton> button to delete the application. + </para> + <figure id="delete_application_and_domain_02"> + <title>Confirming application deletion</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Deleting_Applications_and_Domains/delete_application_and_domain_02.png" format="PNG" /> + </imageobject> + <textobject> + <phrase> + Dialog box to confirm removal of application. + </phrase> + </textobject> + </mediaobject> + </figure> + <para> + Once the application has been deleted you will notice that it has been removed from the list of applications available on your OpenShift server. + </para> + <figure id="delete_application_and_domain_03"> + <title>Application removed</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Deleting_Applications_and_Domains/delete_application_and_domain_03.png" format="PNG" /> + </imageobject> + <textobject> + <phrase> + OpenShift view tab without the application listed. + </phrase> + </textobject> + </mediaobject> + </figure> + </section> + <section> + <title>Deleting a domain</title> + <para> + To delete a domain right-click on your server in the <guilabel>OpenShift Explorer</guilabel> view tab and select <menuchoice><guimenuitem>Delete Domain</guimenuitem></menuchoice> from the context menu. + </para> + <figure id="delete_application_and_domain_04"> + <title>Delete Domain menu item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Deleting_Applications_and_Domains/delete_application_and_domain_04.png" format="PNG" /> + </imageobject> + <textobject> + <phrase> + Selecting Delete Domain. + </phrase> + </textobject> + </mediaobject> + </figure> + <para> + A dialog box will be displayed asking you to confirm domain deletion. As a domain can only be deleted if it has no applications associated with it, an option is available to <guilabel>Force applications deletion</guilabel>. By selecting this checkbox any applications still associated with the domain will be deleted and unrecoverable. + </para> + <warning> + <para> + It is recommended that you remove applications individually before deleting a domain to ensure you have created a copy of any application data you wish to keep. + </para> + </warning> + <para> + If you do not select the <guilabel>Force applications deletion</guilabel> option and the domain to be removed still has an application associated with it, domain deletion will fail. + </para> + <figure id="delete_application_and_domain_05"> + <title>Confirming domain deletion</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Deleting_Applications_and_Domains/delete_application_and_domain_05.png" format="PNG" /> + </imageobject> + <textobject> + <phrase> + Dialog box to confirm removal of domain. + </phrase> + </textobject> + </mediaobject> + </figure> + <para> + Once the domain has been deleted the OpenShift server will remain, however the <menuchoice><guimenuitem>Delete Domain</guimenuitem></menuchoice> option will not be available from the context menu. + </para> + <figure id="delete_application_and_domain_06"> + <title>Delete Domain option not available</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Deleting_Applications_and_Domains/delete_application_and_domain_06.png" format="PNG" /> + </imageobject> + <textobject> + <phrase> + The option to delete a domain is no longer available from the OpenShift context menu. + </phrase> + </textobject> + </mediaobject> + </figure> + </section> +</chapter> Modified: trunk/openshift/docs/reference/en-US/OpenShift_Tools_Reference_Guide.xml =================================================================== --- trunk/openshift/docs/reference/en-US/OpenShift_Tools_Reference_Guide.xml 2012-06-13 00:22:05 UTC (rev 41911) +++ trunk/openshift/docs/reference/en-US/OpenShift_Tools_Reference_Guide.xml 2012-06-13 02:52:32 UTC (rev 41912) @@ -6,8 +6,10 @@ <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Creating_an_OpenShift_Express_Application.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Viewing_the_remote_console.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Port_forwarding.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Modifying_your_web_application_to_deploy_to_OpenShift_Express.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Debugging.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Deleting_applications_and_domains.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </book> Added: trunk/openshift/docs/reference/en-US/Port_forwarding.xml =================================================================== --- trunk/openshift/docs/reference/en-US/Port_forwarding.xml (rev 0) +++ trunk/openshift/docs/reference/en-US/Port_forwarding.xml 2012-06-13 02:52:32 UTC (rev 41912) @@ -0,0 +1,44 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<chapter id="chap-OpenSift_Tools_Reference_Guide-Port_forwarding"> + <title>Port Forwarding</title> + <para> + Port forwarding is available for each OpenShift application. To access port forwarding for an application right-click on an application in the <guilabel>OpenShift Explorer</guilabel> view tab and select <menuchoice><guimenuitem>Port forwarding</guimenuitem></menuchoice> from the context menu. + </para> + <figure id="port_forwarding_01"> + <title>Port forwarding option</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Port_Forwarding/port_forwarding_01.png" format="PNG" /> + </imageobject> + <textobject> + <phrase> + Selecting OpenShift application port forwarding. + </phrase> + </textobject> + </mediaobject> + </figure> + <para> + The <guilabel>Application port forward</guilabel> dialog will display ports that can be forwarded. To forward all ports click the <guibutton>Start All</guibutton> and the <guibutton>Stop All</guibutton> button will stop port forwarding for all listed ports. + </para> + <para> + If you do not wish to use the remote port numbers selected by default, click the checkbox beside the <guilabel>Find free ports for all Services</guilabel> option. + </para> + <para> + The default local address is set to 127.0.0.1 and if the remote port is not available a random one will be generated. If your operating system supports it, you can uncheck <guilabel>Use 127.0.0.1 as the local address for all services</guilabel> and the local address will become the same as the remote address. + </para> + <figure id="port_forwarding_02"> + <title>Port forwarding dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Port_Forwarding/port_forwarding_02.png" format="PNG" /> + </imageobject> + <textobject> + <phrase> + The Application port forward dialog window. + </phrase> + </textobject> + </mediaobject> + </figure> +</chapter> + Added: trunk/openshift/docs/reference/en-US/Viewing_environment_variables.xml =================================================================== --- trunk/openshift/docs/reference/en-US/Viewing_environment_variables.xml (rev 0) +++ trunk/openshift/docs/reference/en-US/Viewing_environment_variables.xml 2012-06-13 02:52:32 UTC (rev 41912) @@ -0,0 +1,41 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<section id="chap-OpenSift_Tools_Reference_Guide-Debugging-Viewing_environment_variables"> + <title>Viewing Environment Variables</title> + <para> + You are able to view the environment variables that an OpenShift application is utilizing and the current content of each variable. To have this output displayed to you right-click on your OpenShift server in the <guilabel>OpenShift</guilabel> view tab, and select <menuchoice><guimenuitem>Environment Variables</guimenuitem></menuchoice>. + </para> + <figure id="openshift_environment_variables_01"> + <title>Selecting the Environment Variables menu item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/OpenShift_Environment_Variables/openshift_environment_variables_01.png" format="PNG" /> + </imageobject> + <textobject> + <phrase> + Environment Variables menu item selected. + </phrase> + </textobject> + </mediaobject> + </figure> + <para> + The output will appear in the <guilabel>Console</guilabel> view tab. + </para> + <figure id="openshift_environment_variables_02"> + <title>Viewing OpenShift application environment variables</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/OpenShift_Environment_Variables/openshift_environment_variables_02.png" format="PNG" /> + </imageobject> + <textobject> + <phrase> + Viewing environment variables in the Console view. + </phrase> + </textobject> + </mediaobject> + </figure> + <para> + This information can be useful in ensuring an application is receiving the correct environment variable values. + </para> +</section> + Modified: trunk/openshift/docs/reference/en-US/Viewing_the_remote_console.xml =================================================================== --- trunk/openshift/docs/reference/en-US/Viewing_the_remote_console.xml 2012-06-13 00:22:05 UTC (rev 41911) +++ trunk/openshift/docs/reference/en-US/Viewing_the_remote_console.xml 2012-06-13 02:52:32 UTC (rev 41912) @@ -1,17 +1,12 @@ <?xml version='1.0' encoding='utf-8' ?> -<chapter id="chap-OpenSift_Tools_Reference_Guide-Viewing_the_remote_console"> +<section id="chap-OpenSift_Tools_Reference_Guide-Debugging-Viewing_the_remote_console"> <title>Viewing the Remote Console</title> - <note> - <para> - If you have not yet created an OpenShift server adapter, follow the instructions in <xref linkend="chap-OpenSift_Tools_Reference_Guide-Creating_an_OpenShift_Application" />. - </para> - </note> <para> - Similar to when you are running a server locally, you are also able to see console output for your remote OpenShift server. To have this output displayed to you, right-click on your OpenShift server in the <guilabel>Servers</guilabel> tab and select <menuchoice><guimenuitem>OpenShift</guimenuitem><guimenuitem>Tail files</guimenuitem></menuchoice>. + Similar to when you are running a server locally, you are also able to see console output for your remote OpenShift server. To have this output displayed to you, right-click on your OpenShift application in the <guilabel>OpenShift</guilabel> view tab, and select <menuchoice><guimenuitem>Tail files</guimenuitem></menuchoice>. </para> <figure id="openshift_remote_console_01"> - <title>Tailing OpenShift server output</title> + <title>Tailing OpenShift server option</title> <mediaobject> <imageobject> <imagedata fileref="images/OpenShift_Remote_Console/openshift_remote_console_01.png" format="PNG" /> @@ -40,7 +35,7 @@ </mediaobject> </figure> <para> - This information can be useful in debugging the remote server and ensuring processes are occuring as expected. + This information can be useful in ensuring processes are executing as expected. </para> -</chapter> +</section> Added: trunk/openshift/docs/reference/en-US/images/Creating_an_OpenShift_Express_Application/application_creation_13.png =================================================================== (Binary files differ) Property changes on: trunk/openshift/docs/reference/en-US/images/Creating_an_OpenShift_Express_Application/application_creation_13.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_01.png =================================================================== (Binary files differ) Property changes on: trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_02.png =================================================================== (Binary files differ) Property changes on: trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_02.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_03.png =================================================================== (Binary files differ) Property changes on: trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_03.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_04.png =================================================================== (Binary files differ) Property changes on: trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_04.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_05.png =================================================================== (Binary files differ) Property changes on: trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_05.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_06.png =================================================================== (Binary files differ) Property changes on: trunk/openshift/docs/reference/en-US/images/Deleting_Applications_and_Domains/delete_application_and_domain_06.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/openshift/docs/reference/en-US/images/OpenShift_Environment_Variables/openshift_environment_variables_01.png =================================================================== (Binary files differ) Property changes on: trunk/openshift/docs/reference/en-US/images/OpenShift_Environment_Variables/openshift_environment_variables_01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/openshift/docs/reference/en-US/images/OpenShift_Environment_Variables/openshift_environment_variables_02.png =================================================================== (Binary files differ) Property changes on: trunk/openshift/docs/reference/en-US/images/OpenShift_Environment_Variables/openshift_environment_variables_02.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: trunk/openshift/docs/reference/en-US/images/OpenShift_Remote_Console/openshift_remote_console_01.png =================================================================== (Binary files differ) Added: trunk/openshift/docs/reference/en-US/images/Port_Forwarding/port_forwarding_01.png =================================================================== (Binary files differ) Property changes on: trunk/openshift/docs/reference/en-US/images/Port_Forwarding/port_forwarding_01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/openshift/docs/reference/en-US/images/Port_Forwarding/port_forwarding_02.png =================================================================== (Binary files differ) Property changes on: trunk/openshift/docs/reference/en-US/images/Port_Forwarding/port_forwarding_02.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream