The "SmartFoxServer 2X Community Edition" ServerTemplates (v1 and v2) execute a series of boot scripts at launch to install and pre-configure SmartFoxServer and the underlying operating system. Additional operational scripts are also available for runtime operations.
Table of Contents
The SmartFoxServer 2X Community Edition ServerTemplates (v1 and v2) execute a series of boot scripts at launch to install and pre-configure SmartFoxServer and the underlying operating system. Version 1 installs SmartFoxServer 2X up to release 2.6.0 and it is compatible with AWS cloud only; version 2 installs release 2.7.0 or later and it is compatible with multiple cloud services. Using v2 ServerTemplate is highly recommended.
These ServerTemplates use several commonly used scripts published by RightScale which are not described here. The custom-specific scripts are listed below.
Description - Under Linux operating systems, file descriptors are used to abstract not only open files but also socket connections. By default most Linux distributions are set to a maximum of 1024 file descriptors: each time a file is opened or a socket connection is established, one of these descriptors is used. If a SmartFoxServer 2X application receives a lot of traffic it might start complaining with a "Too many open files" error. This script increases the file descriptors limit to avoid the above error. It is skipped in case of server reboot.
Required Inputs and Default Settings
Description - This script downloads and installs SmartFoxServer 2X Community Edition v2.0.1. Depending on the operating system (32 or 64 bit), the proper SmartFoxServer version is downloaded and installed in the server’s /opt folder. Additional patches available on the SmartFoxServer website are not included and must be installed running the next script. This script is skipped in case of server reboot.
Required Inputs and Default Settings
Description - This script downloads and installs the SmartFoxServer 2X 2.6.0 patch, containing new features and bug fixes. Previous versions of the patch are also available in case a specific version of SmartFoxServer 2X should be deployed. For the most updated version of SFS2X please refer to v2 ServerTemplate and its scripts.
All patches are cumulative, so there's no need to install the previous ones to updated SmartFoxServer 2X to the required version. This script is skipped in case of server reboot.
Required Inputs and Default Settings
Description - This script writes the server’s private IP address to the main SmartFoxServer 2X xml configuration file located at /opt/SmartFoxServer2X/SFS2X/config/server.xml. This is required to allow the clients (for example the Remote Administration Tool) to connect to SmartFoxServer as soon as the server becomes operational. This script is executed on reboot too, in case this action caused the private IP to change (even if actually this should not happen).
Required Inputs and Default Settings
Description - This script starts the SmartFoxServer 2X service.
Required Inputs and Default Settings
Disables the iptables firewall on the server, which would prevent external connections to SmartFoxServer in certain clouds environments.
Custom scripts can be added later by the customer to set specific firewall rules.
Required Inputs and Default Settings
(see v1 RightScript description above)
Description - This script downloads and installs SmartFoxServer 2X Community Edition v2.9.0 64 bit in the server’s /opt folder. Additional patches available on the SmartFoxServer website are not included and must be installed running the next script. This script is skipped in case of server reboot.
Required Inputs and Default Settings
Description - This script downloads and installs the latest SmartFoxServer 2X patch, containing new features and bug fixes. By default the latest patch in installed, but previous versions (after v2.9.0 anyway) are also available in case a specific version of SmartFoxServer 2X should be deployed.
All patches are cumulative, so there's no need to install the previous ones to updated SmartFoxServer 2X to the required version. This script is skipped in case of server reboot.
Required Inputs and Default Settings
Description - This script starts the SmartFoxServer 2X service.
Required Inputs and Default Settings
Description - This script starts the SmartFoxServer 2X service.
Required Inputs and Default Settings
Description - This script restarts a running SmartFoxServer 2X service.
Required Inputs and Default Settings
Description - This script stops the SmartFoxServer 2X service.
Required Inputs and Default Settings
N/A
The following operations should be performed in order to deploy a server instance featuring SmartFoxServer 2X, using the RightScale management platform.
Please notice that this runbook is not meant to provide a substantial background of SmartFoxServer features and capabilities: for more informations and detailed documentation please check the links provided in the See Also section below.
In order to be able to connect to the SmartFoxServer 2X instance running on your AWS server from any client application (for example the Remote Administration Tool, aka AdminTool), you will need to create a Security Group for each cloud (AWS Region) in which the server will be deployed. The following steps show how to set up a new Security Group; this operation is required only once.
Please notice that the provided settings are valid for the default SmartFoxServer 2X configuration: if you change it after the server is launched, you might need to change the Security Group too.
For more informations on Security Groups, please check this link: EC2 Security Groups
This is not necessary for other cloud services like Rackspace.
In order to be able to deploy a SmartFoxserver 2X Community Edition server you need to import one of the two available ServerTemplates (v1 or v2) to your RightScale account from the MultiCloud Marketplace. This operation is required only once. Follow the steps below.
Servers that are launched using ServerTemplates must be launched from the context of a Deployment.
Server instances must be associated to a Deployment.
You are now ready to launch the Server. Click the Launch button next to the Server in the Deployment's Servers tab. Since you defined the inputs at the Deployment level, you can scroll down the Input Confirmation Screen and click the Launch button. In a few minutes the Server will become operational.
Once the server status is reported as operational, you can access the AdminTool to make sure you can connect to your SmartFoxServer instance. Follow the steps below.
© 2006-2014 RightScale, Inc. All rights reserved.
RightScale is a registered trademark of RightScale, Inc. All other products and services may be trademarks or servicemarks of their respective owners.