You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This guide shows you how to deploy the Geospatial Consumption Zone (GCZ) service integrated with Azure Data Manager for Energy (ADME).
16
-
17
-
> [!IMPORTANT]
18
-
> While the Geospatial Consumption Zone (GCZ) service is a graduated service in the OSDU Forum, it has limitations in terms of security and usage. We will deploy some additional services and policies to secure the environment, but encourage you to follow the service's development on the [OSDU Gitlab](https://community.opengroup.org/osdu/platform/consumption/geospatial/-/wikis/home).
19
-
20
-
## Description
21
-
22
15
The OSDU Geospatial Consumption Zone (GCZ) is a service that enables enhanced management and utilization of geospatial data. The GCZ streamlines the handling of location-based information. It abstracts away technical complexities, allowing software applications to access geospatial data without needing to deal with intricate details. By providing ready-to-use map services, the GCZ facilitates seamless integration with OSDU-enabled applications.
23
16
17
+
This guide shows you how to deploy the Geospatial Consumption Zone (GCZ) service integrated with Azure Data Manager for Energy (ADME).
18
+
24
19
## Create an App Registration in Microsoft Entra ID
25
20
26
-
To deploy the GCZ, you need to create an App Registration in Microsoft Entra ID. The App Registration is to authenticate the GCZ APIs with Azure Data Manager for Energy to be able to generate the cache of the geospatial data.
21
+
To deploy the GCZ, you need to create an App Registration in Microsoft Entra ID. The App Registration is used to authenticate the GCZ APIs with Azure Data Manager for Energy to be able to generate the cache of the geospatial data.
27
22
28
23
1. See [Create an App Registration in Microsoft Entra ID](/azure/active-directory/develop/quickstart-register-app) for instructions on how to create an App Registration.
29
24
1. Grant the App Registration permission to read the relevant data in Azure Data Manager for Energy. See [How to add members to an OSDU group](./how-to-manage-users.md#add-members-to-an-osdu-group-in-a-data-partition) for further instructions.
30
25
31
26
## Setup
32
27
33
28
There are two main deployment options for the GCZ service:
34
-
-**Azure Kubernetes Service (AKS)**: Deploy the GCZ service on an AKS cluster. This deployment option is recommended for production environments. It requires more setup, configuration, and maintenance. It also has some limitations in the provided container images.
35
-
-**Windows**: Deploy the GCZ service on a Windows. This deployment option recommended for development and testing environments, as it's easier to set up and configure, and requires less maintenance.
29
+
30
+
-**Azure Kubernetes Service (AKS)**: Deploy the GCZ service on an AKS cluster. This deployment option is recommended for production environments. It requires more effort to set up, configure, and maintain.
31
+
-**Windows**: Deploy the GCZ service on a Windows. This deployment option recommended for development and testing environments.
36
32
37
33
::: zone pivot="gcz-aks"
38
34
@@ -65,14 +61,14 @@ Through APIM we can add policies to secure, monitor, and manage the APIs.
65
61
#### Download the GCZ OpenAPI specifications
66
62
67
63
1. Download the two OpenAPI specification to your local computer.
1. Open each OpenAPI specification file in a text editor and replace the `servers` section with the corresponding IPs of the AKS GCZ Services' Load Balancer (External IP).
1. Open each OpenAPI specification file in a text editor and replace the `servers` section with the corresponding IPs of the AKS GCZ Services' Load Balancer.
@@ -86,15 +82,18 @@ Through APIM we can add policies to secure, monitor, and manage the APIs.
86
82
87
83
## Testing the GCZ service
88
84
89
-
1. Download the API client collection from the [OSDU GitLab](https://community.opengroup.org/osdu/platform/consumption/geospatial/-/blob/master/docs/test-assets/postman/Geospatial%20Consumption%20Zone%20-%20Provider%20Postman%20Tests.postman_collection.json?ref_type=heads) and import it into your API client of choice (for example, Postman).
85
+
1. Download the API client collection from the [OSDU GitLab](https://community.opengroup.org/osdu/platform/consumption/geospatial/-/blob/master/docs/test-assets/postman/Geospatial%20Consumption%20Zone%20-%20Provider%20Postman%20Tests.postman_collection.json?ref_type=heads) and import it into your API client of choice (that is, Bruno, Postman).
86
+
1.
90
87
1. Add the following environment variables to your API client:
91
-
- `PROVIDER_URL` - The URL to the GCZ Provider API.
92
-
- `AMBASSADOR_URL`- The URL to the GCZ Transformer API.
93
-
- `access_token`- A valid ADME access token.
88
+
89
+
- `PROVIDER_URL` - The URL to the GCZ Provider API.
90
+
- `AMBASSADOR_URL`- The URL to the GCZ Transformer API.
91
+
- `access_token`- A valid ADME access token.
94
92
95
93
1. To verify that the GCZ is working as expected, run the API calls in the collection.
96
94
97
95
## Next steps
96
+
98
97
After you have a successful deployment of GCZ, you can:
99
98
100
99
- Visualize your GCZ data using the GCZ WebApps from the [OSDU GitLab](https://community.opengroup.org/osdu/platform/consumption/geospatial/-/tree/master/docs/test-assets/webapps?ref_type=heads).
@@ -106,7 +105,7 @@ You can also ingest data into your Azure Data Manager for Energy instance:
106
105
107
106
- [Tutorial on CSV parser ingestion](tutorial-csv-ingestion.md).
108
107
- [Tutorial on manifest ingestion](tutorial-manifest-ingestion.md).
109
-
108
+
110
109
## References
111
110
112
111
- For information about Geospatial Consumption Zone, see [OSDU GitLab](https://community.opengroup.org/osdu/platform/consumption/geospatial/).
0 commit comments