Prerequisite
-
Workspace needs to be enabled for Software/Data Product Entitlements – Please
reach out to Precisely Support for enabling the Software/Data product entitlements.
Note:
- In the absence of entitled products for a user, the data product listings will be empty.
- Only those Data Products the users are entitled to are displayed will be displayed in the list.
Users with Product Entitlements
- Log in to the Data Integrity Suite (DIS) and access the Downloads page from
Account in the DIS navigation area.
- Click the Downloads tab to access data products where a list of software and
data products is displayed.
- When you first log in to their workspace, you will come across a step-by-step module located under the Downloads tab. This module will systematically guide you through the installation process of Private Spatial APIs, with customized links for each task, allowing you to manually mark completed tasks.
- Upon checking off all tasks and dismissing the step-by-step module, the system will recognize the successful deployment of the Private Spatial APIs.
Step-by-step module
-
Prepare your Environment: Ensure that the client tools specific to the cloud
platform are installed to set up the environment for deploying the Spatial application.
Learn how to Prepare your Environment.
-
Create Kubernetes Cluster: Establish Kubernetes Cluster.
In the absence of an existing Kubernetes cluster, utilize our provided sample cluster installation script to deploy one.
Learn how to Create K8s. -
Download Private Spatial APIs Docker Images: Locate the Docker images to which you
have entitlements in the data product list. To expedite your search, select the "Find
Docker Images" button to narrow down your Docker Image searches.
Download the docker images to your local machine or copy the cURL snippet.
Learn about Private Spatial APIs Images Download.
-
Create a Persistent Volume: The Spatial application necessitates reference data to
enable Spatial capabilities. Deploy this reference data using a persistent volume,
supported by Amazon Elastic File System (EFS). This setup ensures that the data becomes
instantly accessible upon mounting the volume to the pods.
If you do not have an existing persistent volume, you can create one using our provided samples.
Learn how to create Persistent Volume. -
Prepare a MongoDB for Repository: The functionality of the Spatial application
hinges on reference data for executing Spatial operations. Install a MongoDB database to
your local system or use an existing instance. Learn how to Prepare a MongoDB for
Repository.
-
Install Private Spatial APIs: You have completed all the necessary prerequisites
and are just one step away! The next step involves deploying Private Spatial APIs to K8s
cluster.
Upon executing the Spatial APIs install/upgrade command, the deployment process may take a few seconds to conclude. You can monitor the creation of pods using the command.
Learn how to Install Private Spatial APIs. -
Enable security (optional): Install or use an existing Keycloak instance.
-
Use Spatial Utilities: You can use various Spatial Utilities for:
- Generating MapTiling requests
- Generating Map tiles for the WMTS service
- Uploading maps from MapInfo Pro to the Spatial repository
- Importing and exporting Spatial repository.
- You will receive email notifications for new updates to data products or software. These notifications will direct you to the data products page, where you can view the latest version of the data products in the list.