WWSK v0.2.1
Pre-release
Date
18-MAY-2017
Release Summary
GDAL Support
The World Wind Server Kit (WWSK) v0.2.1 addresses GDAL ECW and MrSID licensing conflicts, in particular, the issue of preinstalling (distributing) the non-GPL ECW and MrSID components in the GPL-licensed GeoServer. In WWSK v0.2.1, the ECW and MrSID components are not preinstalled. Instead, the requisite platform specific distributions for these components accompany the WWSK GeoServer installation and the user must explicitly install these components, if this functionality desired. WWSK v0.2.1 handles GDAL for Windows and Linux differently.
Linux
To install GDAL in WWSK for Ubuntu and CentOS, the user must run the setup.sh script and then choose to install GDAL and optionally MrSID and/or ECW. If GDAL is selected, the setup.sh script installs the GDAL natives and data, and copies the GeoServer GDAL-plugin jars and ImageIO-Ext jars -- excluding the ECW and MrSID jars -- to the GeoServer's lib folder (webapps/geoserver/WEB-INF/lib). To add the ECW or MrSID support, the user must choose to install ECW and/or MrSID and agree to the respective license(s), at which point the previously excluded jars are added to the GeoServer's lib folder.
Windows
In WWSK for Windows, the GDAL natives and data are already installed and the GDAL-plugin jars and ImageIO-Ext jars have been copied into the GeoServer's lib folder (webapps\geoserver\WEB-INF\lib). The ECW and MrSID natives are installed explicitly by the user using the appropriate .msi installers that can be found in the installation's gdal folder. These installers install the natives (.dlls) for the selected component.
Associated GitHub Issues
| No. | Description | Type |
|---|---|---|
| #32 | Restore GDAL ECW & JP2ECW support | enhancement |
| #25 | Restore GDAL MrSID support | enhancement |
| #31 | GeoTIFF with JPEG compression store fails after GDAL ImageIO-Ext installed | bug |
| #26 | WAR file deployment to Tomcat failed | bug |
Known Issues
| No. | Description | Type |
|---|---|---|
| #34 | Unable to open JPEG2000.jp2 image with JP2K (MrSID) Coverage Format | bug |
| #21 | WCS 2.0.1 GetCoverage requests are slow | bug |
Impacts to other development teams/compatibility
In v0.2.0, the inclusion of GDAL artifacts in the worldwind-geoserver was managed by Maven via the declaration of GDAL-related dependencies in the worldwind-geoserver POM file.
In v0.2.1 GDAL is not included in the worldwind-geoserver application build. The GDAL-related dependencies have been removed from the POM file. Instead, GDAL raster image support is added to worldwind-geoserver using the methods documented in the GeoServer Image Formats page. The worldwind-geoserver-dist project contains the scripts, resources and assemblies used to create distributions with the requisite resources to install GDAL support.
Versions
| Component | Version | Previous |
|---|---|---|
| GeoServer | 2.10.0 | |
| GeoTools | 16.0 | |
| GeoWebCache | 1.10.0 | |
| ImageIO-Ext | 1.1.16 | 1.1.13 |
| JAI-Ext | 1.0.11 | |
| Jetty | 9.2.13.v20150730 |
GDAL
Linux:
For the Ubuntu and CentoOS distributions, the GDAL 1.9.2 related resources are found in the installation's gdal folder. The setup.sh script performs the task of extracting and copying the artifacts to their proper folders. The inclusion of these resources in a particular distribution is controlled by the assemblies and components defined in the worldwind-geoserver-dist project.
Windows:
For Windows distributions, the GDAL 1.9.2 artifacts and resources have been extracted and copied to their destinations via the maven-assembly-plugin. See the worldwind-geoserver-dist POM file for details.
End User impact/User facing changes
Setup
Linux
The setup.sh script has been embellished to prompt the user whether or not to install GDAL and optionally to install ECW and/or MrSID. The script is rerunnable.
The install.sh script has been renamed install-service.sh and embellished to update the service unit file (wwsk.service). The script is rerunnable.
Windows
The setup.bat script has been removed. Users wanting to install ECW or MrSID support should run the appropriate .msi installer found in the installation's gdal folder.
Data
The low-resolution world background layer has been moved from the data/nasa folder to data/nasa/base
Documentation
See the README, GeoServer, GeoPackage and GDAL Image Formats documentation.
Logs
Not applicable at this time.
Test Tools
Apache JMeter was used to perform functional tests targeting WWSK instances running on the Ubuntu, CentOS and Windows platforms. The "GeoServer Functional Tests.jmx" file found in the jmeter folder contains the tests. Test data must be installed on the geoserver instance being tested.
Install/Update/Removal
Install
WWSK is installed by simply unzipping a platform specific distribution to a folder on a target computer.
Linux Specific
The install-service.sh script is used to install and update the wwsk.service service. It will update the paths in the service unit file.
Run ./install-service.sh to install/update the wwsk.service after installing a new version of WWSK.
Run ./setup.sh to configure the runtime environment. This must be performed at least once; the run.sh script will invoke setup.sh if it has not been run before. Use the reinstall parameter to recofigure, e.g., ./setup.sh reinstall
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
Not applicable at this time.
Should you desire to add plugins, the GeoServer version for this release is 2.10.0