Refactor GCZ Repo towards OSDU Standards
In an effort to align the GCZ project's structure more closely with other OSDU Core / DDMS services, we have updated the structure of the Geospatial Consumption Zone repository.
What's Changed
-
osdu_gcz_transformer
directory is nowgcz-transformer
-
osdu_gcz_provider
directory is nowgcz-provider
-
osdu_gcz_test_assets
directory is nowgcz-test-assets
-
osdu_gcz_wiki
directory is nowgcz-docs
- Contents of the root
assets
folder have been relocated togcz-docs/assets
- Root
ignite
folder andosdu_gcz_transformer/ignite
folder have been removed from the repository- These were GCZ byproducts and are not relevant to new consumers
- Transformer
src
code has been relocated togcz-transformer/gcz-transformer-core
- Provider
src
code has been relocated togcz-provider/gcz-provider-core
-
devops
andprovider
directories have been added to bothgcz-transformer
andgcz-provider
directories with subdirectories for CSPs to extend upon or provide their own documentation and deployment strategies relevant to their specific environments - Transformer config files (
application-local.yml
,application-remote.yml
, andapplication-k8s-remote.yml
) have been merged into a singularapplication.yml
file and that file has been relocated into thegcz-transformer/.config
directory - Provider config file
koop-config.json
has been relocated into thegcz-provider/.config
directory - The GCZ Wiki has been updated to replace all outdated file/directory references with the new standardized iterations
- The singular
application.yml
file now natively supports environment variables for all parameters (except forkinds
) - The GCZ Wiki has been extended with a detailed page on Environment Variables
- The GCZ Wiki Post Deployment Testing document has been updated to give more detail on
geometry
spatial query parameters
Attention to CSPs: Please review structural changes here, and prepare what you may need to adjust on your end. This applies to IBM, GC and AWS, who already had defined some environment-specific material inside the repo.
-
IBM (@shrikgar @ashwani_pandey)
- Please review the IBM Pipelines. Note that there is now the gcz-transformer/gcz-transformer-core directory which contains the original source code and the gcz-transformer/provider directory which may contain extensions of the source code for use with specific environments. Right now, only GC has updated that area for their own environment.
- Also note that I have been unable to perform a search query against the IBM Preship instance for a couple of days now. Error documented here
-
GC (@Yurii_Ruban @Rustam_Lotsmanenko @Stanislav_Riabokon)
- Please review the restructure. The Transformer config has been simplified to one file, and it now supports many Environment Variables by default.
-
AWS (@estepamo @gustavurda @fhoueto.amz )
- Please review the restructure and consider how current local deployment instructions (gcz-docs/deployment/aws) can be modified and relocated to each component's new provider/devops directories.
Edited by Levi Remington