WWSK v0.5.0
Pre-releaseDate
13-DEC-2017
Release Summary
The WWSK v0.5.0 includes the following new features and bug fixes:
- WWSK Explorer - an integrated WebWorldWind client
- Optional Java Advanced Imaging (JAI) for Linux
- Control Flow module included
- Integration Tests
- Headless options for setup scripts in Linux
- User selectable memory configuration for Linux
WWSK 0.5.0 includes an early release of the the WWSK Explorer that was debuted at the EO OpenScience 2017 conference at ESA/ESRIN. The Explorer is an integrated virtual globe web client that is connected to your WWSK installation. It provides the ability to browse your server's layers on virtual globe. It supports persistent markers and the creation of sharable bookmarks. The integrated Layer Manager supports layer sorting, opacity settings, and zooming to a layer's extents. This release of the Explorer is not mature, e.g., the integrated Layer Manager UI has room for improvement, and there are known bugs.
WWSK 0.5.0 for Linux supports the inclusion of the native Java Advanced Imaging (JAI) libraries. The setup script will prompt the user if JAI should be installed. The setup script supports the removal of the JAI as well.
The Control Flow module has been included in all the WWSK distributions. A default controlflow.properties
file has been included (will all rules disabled) in the data_dir folder to facilitate the easy inclusion of this feature in production systems. See the Control Flow documentation or look at the comments in data_dir/controlflow.properties
file for more information.
JMeter integration tests have been included in this release. This includes a test runner and test data included in the repository. The integration tests run in Travis Continous Integration server and will fail the build upon error. The integration tests can be run on the local workstation as well. See the travis/run_integration_tests.sh
script and the integration test profiles defined in the worldwind-geoserver/pom.xml
file for more information. HTML test reports are written to the worldwind-geoserver/target/jmeter/reports
folder.
The setup scripts (setup-gdal.sh
, setup-jai.sh
and setup-java.sh
) have been refactored to support headless operations via command line arguments. These scripts are now multi-purpose as they are used by both the main setup.sh
script and run_integration_test.sh
script.
A user selectable memory configuration has been added to the main setup.sh script. The options include several predefined memory configurations and the ability to define a custom allocation.
Associated GitHub Issues
No. | Description | Type |
---|---|---|
#102 | Add the Control Flow module to the WWSK build | new feature |
#139 | Update Web WorldWind library | enhancement |
#140 | Updated Web WorldWind version to 0.9.0 | enhancement |
#137 | GeoTiff with JPEG compression not working with JAI | bug |
#101 | Native JAI configuration for Linux | enhancement |
#127 | Create a redistributable test data set | task |
#125 | Refactor GeoServer Functional Tests run in Travis | task |
#130 | Create integration test runner | task |
#128 | Run the GeoServer functional tests via the JMeterMavenPlugin | task |
#120 | Implement "zoom to layer" function in WWSK viewer | task |
#115 | Add viewer link to the WWSK menu category | task |
#114 | Create a WWSK Viewer prototype using the WorldWindExplorer web app | task |
#112 | Provide WorldWind viewer with URL parsing capabilities | task |
#111 | Add basic Layer Manager for the Viewer | new feature |
#107 | Implement 'WorldWind Viewer' into WWSK | new feature |
#99 | Change Windows memory allocation to 25% system memory | enhancement |
#57 | Selectable memory configuration for Linux | new feature |
Known issues
No. | Description | Type |
---|---|---|
#138 | JPEG WorldImage layers are not working with JAI | bug wontfix |
? | WWSK Explorer occationally crashes on latest version of FireFox | bug |
? | WWSK Explorer may lock up a the pole | bug |
Impacts to other development teams/compatibility
- The worldwind-gs-explorer module and artifact id was added to the WWSK project.
- Some refactoring of script and resource locations.
travis/run_integration_tests.sh
script added. Run from the WWSK project folder.resources/gdal/setup-gdal.sh
script has new command line options.resources/java/setup-java.sh
script now supports reinstall.resources/jai/setup-jah.sh
script added.
Versions
Component | Version | Previous |
---|---|---|
GeoServer | 2.11.1 | |
GeoTools | 17.1 | |
GeoWebCache | 1.11.0 | |
ImageIO-Ext | 1.1.17 | |
JAI-Ext | 1.0.13 | |
Jetty | 9.2.13.v20150730 | |
Java JRE | 8-121 | |
JAI | 1.1.3 | |
JAI-ImageIO | 1.1 |
End User impact/User facing changes
- The new Explorer feature is accessed via the 'Explorer' link in the WWSK menu category.
- The Linux setup prompts the user to select a memory configuration.
- The Linux setup prompts the user to choose if JAI should be installed.
Documentation
See the GeoServer, GeoPackage, GDAL Image Formats, Control Flow and JAI documentation.
The Explorer documentation [TODO] will be provided on the WorldWind Server Kit website.
Logs
The output of the integration tests can be found here:
- HTML reports:
worldwind-geoserver/target/reports
- Error logs:
worldwind-geoserver/target/jmeter/logs
Test Tools
The JMeter integration tests test the results of GetCapabilities requests, GetMap requests for core data stores, GetMap for GDAL data stores, and GetMap requests for both core and GDAL data stores with JAI installed.
To run the integration tests run ./travis/run_integration_tests -c
from the WWSK root project folder.
The same integration tests are run by the Travis continuous integration service and they will fail the build upon error.
Two other JMeter test plans are included in the WWSK project's jmeter folder hierarchy:
- GeoServer Functional Test.jmx : performs WMS and WPS requests for the supported data stores and image formats.
- GeoServer Stress Test.jmx : performs load tests with performance metrics.
These test plans require data sets that not included in the repository so may require editing or customization before use.
Install/Update/Removal
Install
WWSK is installed by simply unzipping a platform specific distribution to a folder on a target computer.
Removal
WWSK is removed by simply deleting the folder in which it was installed. If a wwsk.service has been created (Linux), it should be stopped, disabled and removed.
Update
The recommended practice for updating WWSK is to:
- Install a new version of WWSK alongside an older version,
- (Optionally) copy/move data and workspaces from the old version to the new version,
- Remove the old version.
Updating WWSK by unzipping a distribution into an existing WWSK instance has not been tested and is not recommended.
Notes
Additional notes, links, and information goes here.