Skip to content

Commit dde902f

Browse files
committed
updated aks deploy instructions
1 parent a971800 commit dde902f

File tree

2 files changed

+313
-284
lines changed

2 files changed

+313
-284
lines changed

articles/energy-data-services/how-to-deploy-gcz.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,23 @@ zone_pivot_groups: gcz-aks-or-windows
1212

1313
# Deploy Geospatial Consumption Zone
1414

15-
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-
2215
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.
2316

17+
This guide shows you how to deploy the Geospatial Consumption Zone (GCZ) service integrated with Azure Data Manager for Energy (ADME).
18+
2419
## Create an App Registration in Microsoft Entra ID
2520

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.
2722

2823
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.
2924
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.
3025

3126
## Setup
3227

3328
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 setup, configure, and maintain.
31+
- **Windows**: Deploy the GCZ service on a Windows. This deployment option recommended for development and testing environments.
3632

3733
::: zone pivot="gcz-aks"
3834

@@ -65,14 +61,14 @@ Through APIM we can add policies to secure, monitor, and manage the APIs.
6561
#### Download the GCZ OpenAPI specifications
6662

6763
1. Download the two OpenAPI specification to your local computer.
68-
- [GCZ Provider](https://github.com/microsoft/adme-samples/blob/main/services/gcz/gcz-openapi-provider.yaml)
69-
- [GCZ Transformer](https://github.com/microsoft/adme-samples/blob/main/services/gcz/gcz-openapi-transformer.yaml)
70-
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).
64+
- [GCZ Provider](https://github.com/microsoft/adme-samples/blob/main/services/gcz/gcz-openapi-provider.yaml)
65+
- [GCZ Transformer](https://github.com/microsoft/adme-samples/blob/main/services/gcz/gcz-openapi-transformer.yaml)
66+
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.
7167

72-
```yaml
73-
servers:
74-
- url: "http://<GCZ-Service-External-IP>/ignite-provider"
75-
```
68+
```yaml
69+
servers:
70+
- url: "http://<GCZ-Service-LoadBalancer-IP>/ignite-provider"
71+
```
7672
7773
##### [Azure portal](#tab/portal)
7874
@@ -88,13 +84,15 @@ Through APIM we can add policies to secure, monitor, and manage the APIs.
8884
8985
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).
9086
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.
87+
88+
- `PROVIDER_URL` - The URL to the GCZ Provider API.
89+
- `AMBASSADOR_URL` - The URL to the GCZ Transformer API.
90+
- `access_token` - A valid ADME access token.
9491

9592
1. To verify that the GCZ is working as expected, run the API calls in the collection.
9693

9794
## Next steps
95+
9896
After you have a successful deployment of GCZ, you can:
9997

10098
- 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 +104,7 @@ You can also ingest data into your Azure Data Manager for Energy instance:
106104

107105
- [Tutorial on CSV parser ingestion](tutorial-csv-ingestion.md).
108106
- [Tutorial on manifest ingestion](tutorial-manifest-ingestion.md).
109-
107+
110108
## References
111109

112110
- For information about Geospatial Consumption Zone, see [OSDU GitLab](https://community.opengroup.org/osdu/platform/consumption/geospatial/).

0 commit comments

Comments
 (0)