Configuration file location
The Client module is configured in a single file named client-config.xml.jsp that can be found in config/client-config.xml.jsp file into the client (or client-premium if you are using Enterprise edition) war.
Configuration file contents
Google Maps
Infrastructure section uses a map to visually show where the Datacenters are physically located. The Action Script 3 version of the Google Maps API is used to draw the map and geolocate the Datacenters.
- GOOGLE_MAPS_KEY: Key used to connect with Google maps API service. You need an API key for each domain where you plan to deploy the client. To obtain a valid key for your domain, visit http://code.google.com/apis/maps/signup.html
- GOOGLE_MAPS_LOAD_TIMEOUT: Since we cannot guarantee that the Google Maps API is always available, we try to connect with the API service for a certain period of time. After that, the client considers that the service is not available, and the map is not used until the next login.
- GOOGLE_MAPS_DEFAULT_LONGITUDE, GOOGLE_MAPS_DEFAULT_LATITUDE, GOOGLE_MAPS_DEFAULT_ZOOM: These values indicates where in the world will the Map be centered by default when loaded.
Update intervals
Sometimes the Client needs to be aware of server side changes in data. Since there is no a push service, a periodic polling is started by the Client when needed. These values determine how often this polling is done. All values are in seconds.
- INFRASTRUCTURE_UPDATE_INTERVAL: When exploring a Datacenter, the whole infrastructure for that Datacenter (Racks, Physical Machines and Virtual Machines) is periodically updated
- VIRTUAL_APPLIANCES_UPDATE_INTERVAL: In Virtual Datacenters sections, the Virtual Datacenter and Virtual Appliances lists are periodically updated. This value is also used in the Virtual Appliance management screen.
- VIRTUAL_APPLIANCE_DEPLOYING_UPDATE_INTERVAL: In Virtual Appliance management section, if the Virtual Appliance is in a state of DEPLOYING, this value is used to refresh it, instead of VIRTUAL_APPLIANCES_UPDATE_INTERVAL.
- OVFPACKAGES_DOWNLOADING_PROGRESS_UPDATE_INTERVAL: When downloading Virtual Images from a Remote Space, this value is used to refresh the download progress.
- VIRTUALIMAGE_UPLOAD_PROGRESS_UPDATE_INTERVAL: When user creates a new Virtual Image from a local file, this value is used to refresh the upload progress.
- METERING_UPDATE_INTERVAL: In Events section, this value is used to refresh the events list when the Autorefresh option is selected
Pagination
There are some lists in Client that are paginated, when retrieving all items for those lists is not suitable. These values allow to adjust the number of items per page.
- NUMBER_USERS_PER_PAGE, NUMBER_ENTERPRISES_PER_PAGE: Used by lists present in the Users section
- NUMBER_IP_ADDRESSES_PER_PAGE: Value used when listing IP addresses in the different networking management sections of the Client
Server connection
These parameters are used by the client to connect to the Abiquo platform. The client mainly connects with Server, and with Appliance Manager for certain operations.
- SERVER_ADDRESS, SERVER_PORT: Fully qualified name or IP address, and port, where the Client will try to PING to test server reachability when a network problem happens
- channels: The BlazeDS channels used to connect with Server. The only channel types that will be used are amf and amfsecure. More than one channel of each type can be specified, and they will be used in that order. For example, if two amf channels are defined, the Client will try the first one and if it fails, the second one will be used
- APPLIANCE_MANAGER_SERVER_ADDRESS: The address where the Appliance Manager is deployed. The Client directly connects with the Appliance Manager, instead of going through the Server.
Misc
Other configuration values
- SHOW_START_UP_ALERT When set to 1, the Client will show the text contained in config/Startup_Alert.txt when the application starts and the user logs in.
Important considerations
This config file is a JSP file. This means that the Client must be deployed in a application server. This allows to define variables in the configuration file, that will be set when loaded. See the default client-config.xml.jsp to see an example in the APPLIANCE_MANAGER_SERVER_ADDRESS attribute.
