Chapter 3. Developing for the Cloud with OpenShift 2

1. In JBoss Central, under Start from scratch, click OpenShift Application.

1. Click the link provided to sign up for an OpenShift account and follow the instructions on the OpenShift website.

   Figure 3.1. Link to Sign up for a New OpenShift Online User Account

   
2. When you have completed the sign-up process, restart the OpenShift Application wizard from JBoss Central.

1. Complete the fields about your OpenShift Online account as follows:

   1. From the Connection list, select New Connection.
   2. Ensure the disabled Server field states https://openshift.redhat.com.

   3. In the Username and Password fields, type your account credentials.

      Figure 3.2. Connection Information Provided for OpenShift Online Account

      
2. Click Next.

1. Click New.

2. Complete the fields about the SSH Keys to be created as follows:

   1. In the Name field, type a name for the SSH key pair.
   2. From the Key Type list, ensure SSH_RSA is selected.
   3. In the SSH2 Home field, ensure your .ssh directory path is correct.

   4. In the Private Key File Name field, type a name for the private key file name. The Public Key File Name field populates automatically with the name of the private key file name with .pub appended.

      Figure 3.3. New SSH Key Information for OpenShift Online Provided

      
3. Click Finish.
4. Click Finish to close the Add SSH Keys window.

1. In the Domain Name field, type an alphanumeric name for your new OpenShift Online domain and click Finish. The provided domain name must be unique across all domains on OpenShift Online; if it is not unique, you are directed back to the Create Domain window to provide a unique domain name.

   Figure 3.4. New OpenShift Domain Name Provided

   

1. Complete the fields about the type of OpenShift application you want to create as follows:

   1. Ensure Create a new OpenShift application is selected.

   2. Expand Basic Cartridges and select JBoss Application Server 7.

      Figure 3.5. Basic Cartridge Selected for the New OpenShift Online Application

      
2. Click Next.

3. Complete the fields about your OpenShift application as follows:

   1. Ensure the Domain field displays the OpenShift Online domain with which you want to host your application.
   2. In the Name field, type an alphanumeric name for your application.
   3. From the Gear profile list, select small.

   4. Select the Enable scaling check box.

      Figure 3.6. New OpenShift Application Information Provided

      
4. Click Next.

1. Complete the fields about the corresponding workspace project as follows:

   1. Ensure the Create a new project check box is selected.
   2. Ensure the Create and set up a server for easy publishing check box is selected. This automatically creates an OpenShift server adapter for the application, enabling you to easily publish project changes to the OpenShift server.
2. Click Next.

3. Ensure the location in the Git Clone Destination field corresponds to where you want to make a local git repository for the project source code.

   Figure 3.7. Git Clone Destination Specified

   

18. Click Finish for the wizard to start generating the new OpenShift application. This process may take some time to complete.
19. If you are prompted that the authenticity of the host cannot be established and asked whether you want to continue connecting, ensure that the host name matches that of your application and domain and click Yes.

20. In the OpenShift Explorer view, expand the connection and domain.
21. Right-click {application name} and click Show In → Web Browser.

1. In the OpenShift Explorer view, ensure your OpenShift Online connection is listed or click the Connection icon and complete your OpenShift Online account details to create a new connection.
2. In the OpenShift Explorer view, expand the connection and domain to locate the application you want to import.
3. Right-click {application name} and click Import Application.

4. Complete the fields about the application to be imported as follows:

   1. Ensure that Use my existing OpenShift application is selected.

   2. Ensure that the name of the application you want to import is listed. If this is not the case, type the name of the application or click Browse to select the application.

      Figure 3.8. Existing OpenShift Online Application Information Provided

      
5. Click Next.

6. Complete the fields about the corresponding new workspace project as follows:

   1. Ensure the Create a new project check box is selected.
   2. Ensure the Create and set up a server adapter for easy publishing check box is selected.
7. Click Next.
8. Ensure the location in the Git Clone Destination field corresponds to where you want to make a local copy of the OpenShift Online application Git repository.
9. Ensure a public SSH key is uploaded to OpenShift Online and private key location is specified in the IDE preferences by clicking SSH Keys Wizard and reviewing the information.
10. Click Finish.

1. In the Project Explorer view, expand {project name} → src → main → webapp.
2. Double-click index.html to open it in the JBoss Tools HTML Editor.

3. After the opening <body> tag add the following line:

   <h1>This is a change made to my OpenShift Online app from the IDE.</h1>

4. Save the index.html file by pressing Ctrl+S (or Cmd+S).

1. In the Servers view, right-click {application name} at OpenShift and click Publish. Or you can drag the from the Project Explorer view and drop it on the server adapter in the Servers view.

2. Complete the fields about the project changes to commit and push to the OpenShift Online application Git repository as follows:

   1. In the Commit message field, type the following message

      Added new heading in body of index.html

   2. In the table of files, ensure the index.html file is selected.

      Figure 3.9. Commit Message Provided and Changed Project File Selected

      
3. Click Commit and Publish.

1. In the OpenShift Explorer view, expand the connection and the domain.
2. Right-click {application name} and click Show In → Web Browser.

1. In the Project Explorer view, right-click {project name} and click OpenShift → Configure Markers.

2. From the Marker table, select Hot Deploy and click OK.

   Figure 3.10. Hot Deploy Marker Selected

   

   An empty .openshift/markers/hot_deploy file is added to the application. OpenShift Tools automatically completes the git add action so that this new file is added to the Git index and can be committed and pushed to the OpenShift application repository when ready.

Create the post deploy action hook

1. In the Navigator view, expand {project name} → .openshift.
2. Right-click action_hooks and click New → File.
3. In the File name field, type post_deploy and click Finish.

4. In the file editor, add the following lines to the post_deploy file:

   #!/bin/bash
   echo "This is my post-deploy bash script”

5. Save the file by pressing Ctrl+S (or Cmd+S).

Make the post deploy action hook executable

6. In the Navigator view, right-click the post_deploy file and click Properties.

7. In the Permissions table, select the Execute check boxes for all user types.

   Figure 3.11. Execute Permissions Check Boxes Selected for All Users

   
8. Click Apply and click OK.

1. Click Window → Preferences → Team → Git.

2. In the Remote connection timeout (seconds) field, type a value in seconds.

   Figure 3.12. Git Remote Connection Timeout Set

   
3. Click Apply and click OK to close the Preferences window.

1. In the Servers view, right-click {application name} at OpenShift and click Publish.

2. Complete the fields about the application changes to commit and push to the OpenShift Online application repository as follows:

   1. In the Commit message field, type the following message:

      Added hot_deploy marker and post_deploy bash script

   2. In the Files table, ensure the hot_deploy file is selected and select the post_deploy file.

      Figure 3.13. Commit Message Supplied and Files Selected for Committing and Publishing

      
3. Click Commit and Publish.

1. In the Project Explorer view, right-click {project name} and click OpenShift → Configure Markers.

2. In the Configure OpenShift Markers window, select the Enable JPDA check box and click OK.

   Figure 3.14. OpenShift Enable JPDA Marker Selected

   
3. In the Servers view, right-click {application name} at OpenShift and click Publish.
4. In the Publish Changes window, in the Commit message field type a message for the commit.
5. From the Files list, ensure the .openshift/markers/enable_jpda check box is selected and click Commit and Publish.

1. In the OpenShift Explorer view, right-click {application name} and click Port Forwarding.

2. In the Application port forwarding window, click Start All. Ensure the Status value shows Started for the debug ports and click OK to close the Application port forwarding window.

   Figure 3.15. Port Forwarding Started for All Ports

   

1. In the global toolbar of the JBoss perspective, click the drop-down list for the Debug icon and select Debug Configurations.
2. From the debug configurations list, select Remote Java Application and click the New launch configuration icon

3. In the Connect tab, complete the following fields:

   1. In the Project field, type the name of the workspace project associated with the OpenShift application or click Browse to locate the project.
   2. In the Port field, type the value of the debug port.

   3. Click Apply and then click Debug.

      Figure 3.16. Debug Configuration Ready for Your OpenShift Application

      

1. In the Project Explorer, right-click {project name} and click Configure → New/Import OpenShift Application.

2. Complete the fields about your OpenShift Online account as follows:

   1. In the Connection list, select the connection.
   2. In the Password field, type your OpenShift Online account password.
3. Click Next.

4. Complete the fields about the type of OpenShift application you want to create as follows:

   1. Ensure Create a new OpenShift application is selected.
   2. Expand Basic Cartridges and select the core cartridge to match the application type; for example, for applications with Java-based server-side functionality select jbossas-7, jboss-wildfly-8, or jbosseap-6.
5. Click Next.

6. Complete the fields about your OpenShift application as follows:

   1. Ensure that the 'Domain' list displays the domain in which you want to host your application.
   2. Ensure the Name field contains a valid alphanumeric name for your application.
   3. In the Gear profile field, select the gear size that you want for your application or leave blank to use the default gear profile.
   4. Select the Enable Scaling check box to make your application scalable.
7. Click Next.

8. Complete the fields about the corresponding workspace project as follows:

   1. Ensure the Create a new project check box is clear.
   2. Ensure the Use existing project field lists the workspace project that you want to deploy on OpenShift.

   3. Ensure the Create and set up a server adapter for easy publishing check box is selected.

      Figure 3.17. Existing Workspace Project Selected for the New OpenShift Application

      
9. Click Next.
10. Ensure the location in the Git Clone Destination field exists and corresponds to where you want to make a local git repository for the project source code.
11. Ensure a public SSH key is uploaded to OpenShift Online and private key location specified in the IDE preferences by clicking SSH Keys wizard and reviewing the information.
12. Click Finish.
13. At the prompt informing that changes will be made to the workspace project, click OK.

1. In the Servers view, right-click {application name} at OpenShift and click Full Publish.
2. When prompted if you want to publish the committed project changes to OpenShift, click Yes.

1. In the OpenShift Explorer view, expand the connection and the domain.
2. Right-click {application name} and click Show In → Web Browser.

1. In the OpenShift Explorer view, right-click the connection and click Manage SSH Keys.
2. In the Manage SSH Keys wizard, click New.

3. Complete the fields about the new SSH keys as follows:

   • In the Name field, type a name to distinguish the key pair from any other keys associated with the connection.
   • From the Key Type list, select SSH_RSA.
   • Ensure that the SSH2 Home field contains the location where you want to create the files associated with the key pair. To change the location, clear the Default check box and type the location in the SSH2 Home field or click Browse to navigate to the desired location.

   • In the Private Key File Name field, type a name for the private key file. The Public Key File Name field is automatically completed and displays the private key file name appended with .pub.

     Figure 3.18. Completed Fields for the New SSH Key Pair

     
4. Click Finish and click OK to close the Manage SSH Keys wizard.

1. In the OpenShift Explorer view, right-click the connection and click Manage SSH Keys.
2. Click Add Existing.

3. Complete the fields about the existing public SSH key as follows:

   • In the Name field, type a name for the SSH key.

   • In the Public Key field, type the path of the public key file or click Browse to locate the public key file.

     Figure 3.19. Completed Fields for Adding an Existing SSH Public Key

     
4. Click the SSH2 Preferences link.
5. In the Private keys field, click Add Private Key and locate the private key file.
6. Click Apply and click OK to close the Preferences window.
7. Click Finish and click OK.

1. Click Window → Preferences → General → Network Connections → SSH2.
2. In the General tab, click Add Private Key and locate the private key file.
3. Click Apply and click OK to close the Preferences window.