- Introduction to WorkXpress
- Building Your Application
- Examples and Best Practices
- Technical Manual
This is an old revision of the document!
At WorkXpress, we understand that our customers need infrastructure choice, including the ability to host WorkXpress applications using their own computing infrastructure; that is, some customers prefer to install and manage a private cloud environment. To meet that need, we offer WorkXpress Cloud's packaged as an Open Virtualization Format (OVF) compliant virtual appliance to empower those customers to host development, testing, and production applications behind their own firewalls while continuing to manage them via the WorkXpress Platform at http://platform.workxpress.com.
Installing WorkXpress in your private cloud is not difficult, but it will require some preparation and basic knowledge about hardware and network configuration:
There are two primary uses of the externally routable IP from your ISP: your access to the WorkXpress Applications installed on this Private Cloud from outside of your local network, and so the platform can communicate with the cloud for maintenance.
WorkXpress brings significant value in it's applications by deploying each one of them as a web-based application. This means that you can access it just as easily from your desk at work as you can from your desk at home, smart phone on the go, or your remote office location overseas.
The platform application is in contact with your private cloud for a variety of reasons. When you use the platform to release a new version of a Development application hosted on your private cloud, or when you trigger an update to a testing or production application from the platform, it connects to your private cloud and performs the update. When the shutdown command is triggered from the platform it connects to your private cloud to begin the operation, and more. Point and click control over your private cloud through the WorkXpress Platform is achieved with this connection.
You can, but the private cloud has a host based firewall that limits inbound access to the required ports, so even though you may feel uneasy about letting everything in, the private cloud will only respond to requests that come to the required ports. Also keep in mind any changes to our infrastructure will require changes to any filtering you put in place.
If you still feel that you need to filter at your network edge you can use the follow as guidelines for filtering:
Log in to the WorkXpress Platform. Once logged in, click the “Clouds” tab to see a list of Clouds you own, and clouds you're hosting applications on. Next, click the orange “Create a New Cloud” button in the top right corner of the list of clouds.
Fill in the Cloud Server Name, and the fields for what email addresses to use for warning and critical notifications as well as sales and support email addresses for your company. When you're finished, click “Create Cloud”. The screen will reload to show you the synchronization code that will allow your virtual appliance to host WorkXpress applications.
Note: Please record this code because you will require it to complete the installation procedure.
Close this window and continue to step two.
The WorkXpress OVF Cloud installation process will vary based on the OVF compliant hypervisor you've chosen to deploy. The instructions that follow were written specifically for installation into a VMware ESXi 5.0.0 virtualization environment.
First, open the VMware Infrastructure Client (VIC) and connect to your ESX Server.
Next, choose File : Deploy OVF Template.
Then, in the “Deploy from a File or URL” field, enter : http://www.workxpress.com/sites/default/files/ovf/WorkXpress/workxpress.ovf
Click Next and answer any questions asked by the VMware installation wizard. Please consult the VMware documentation for answers to specific questions you may have related to VMware ESXi. When you reach the Network Mapping section of the Import Virtual Appliance Wizard, select the network from which your firewall expects to receive client traffic or a network that is directly connected to the internet. If you choose to connect to an internal, non-routable IP network behind your firewall, you or your network administrator should allow traffic on the following ports to reach your server:
Incoming and Outgoing Traffic:
Outgoing Traffic only:
Click Next, review your settings, and click Finish to start the import. This process may take quite some time to finish, depending on your internet connection speed, because the image file is just over 1 GB in size. Please be patient. After the import process finishes, you're ready to move on to step three.
If you are not deploying this Private Cloud with a direct internet connection and routable IP address, you'll need to be sure do the following :
Regardless of these configuration choices, you'll need to:
Start the virtual appliance by pressing the “Play” button for your new server in the VIC's Inventory list. Your virtual appliance will boot, then launch the WorkXpress Virtual Appliance Setup Wizard.
First, configure your network interface by assigning it an IP address, subnet mask, a default gateway and DNS addresses.
If you have any questions about your network interface's configuration, please consult your system administrator or contact us directly for assistance using any of the methods listed at mailto:support@workxpress.com.
Then, enter a DNS Domain and a DNS Domain Search order when asked.
If you entered only private address information, the setup utility will not ask you for the public access information.
When you enter the Public IP Address, the setup utility will ask the Platform to test this external access. If the ports have not been properly forwarded to the private IP, or if the public settings are incorrect this will fail. Setup cannot continue without valid public access settings.
Once the Public test is complete all of the networking settings will be displayed for your review and approval.
Next you'll be asked for the WorkXpress Virtual Appliance Syncronization Code you obtained earlier in the installation process.
Finally, the Private Cloud will complete it's configuration, fully activate the cloud in the WorkXpress Platform, and complete the boot process.
When you see this screen, the boot up process is complete, and the cloud is ready for hosting WorkXpress applications!
Return to the WorkXpress Platform to install, move, or copy applications onto your new Private Cloud.