Skip to content
Snippets Groups Projects
Commit ccde4726 authored by Levi Remington's avatar Levi Remington
Browse files

Merge branch '670-update-gitlab-home-lr' into 'master'

Resolve "Update Gitlab home to align with OSDU comms template"

Closes #670

See merge request !342
parents a6170eda 4d262bc8
No related branches found
No related tags found
1 merge request!342Resolve "Update Gitlab home to align with OSDU comms template"
Pipeline #305357 passed
# Geospatial Consumption Zone
Layered service providing ready-to-consume geospatial web services from OSDU datasets.
**Status**:
- This project is graduated and maintaining active development. Some pieces of the below proposed architecture have yet to be implemented (OGC & Vector Tile output).
- Please visit the [Issue Boards](https://community.opengroup.org/osdu/platform/consumption/geospatial/-/boards/) for latest status.
- For any questions, please reach out to our Slack channel ([#cap-geospatial_consumption_zone](https://og.enterprise.slack.com/archives/C022X4RC0UR))
**See the [GCZ Status page](https://community.opengroup.org/osdu/platform/consumption/geospatial/-/wikis/Status) for latest project status and see our [GCZ Docs](./docs/README.md) for a technical overview of GCZ components, API, configuration, deployment, and testing procedures.**
## About
The Geospatial Consumption Zone is a project spawned by the OSDU Geomatics Workstream to streamline the management and consumption of geospatial data in OSDU by client applications.
The geospatial industry and community has a number of open standard formats for geospatial web services and these are frequently supported and used by a variety of significant vendor applications. To make OSDU accessible to those applications in a performant way, a geospatial consumption zone is highly valuable.
## Architecture
The consumption zone is a set of microservices designed for managing and access a variety of geospatial web services. These web services are based on datasets stored in OSDU.
![Overview Diagram](docs/assets/Diagrams/old/overview.svg)
The provider and ambassador represent the two primary services that need to be developed by this project.
The ambassador can be thought of as the manager of geospatial web services, while the provider is the set of data services themselves.
![Provider and Ambassador Services](docs/assets/Diagrams/old/provider_ambassador.svg)
## Structure
### / (root)
Home to the GCZ's Transformer service
### /docs
Wiki for the Geospatial Consumption Zone solution including deployment, configuration, and testing guides
### /gcz-provider
Home to the GCZ's Provider service
## Key resources and contact points
- **Product Owner:** Christina Dischinger, ExxonMobil
- **Project Lead:** David Jacob, Esri
- **Development Lead:** Levi Remington, Esri
- **Status:** Graduated
- **Homepage:** [Geospatial Consumption Zone Homepage](https://community.opengroup.org/osdu/platform/consumption/geospatial/-/blob/master/README.md)
- **Charter:**
- **Documentation:** [Documentation](https://community.opengroup.org/osdu/platform/consumption/geospatial/-/blob/master/docs/README.md)
- **Backlog:** See [Issue boards](https://community.opengroup.org/osdu/platform/consumption/geospatial/-/boards/1357)
- **Slack Channel:** [Slack channel](https://og.enterprise.slack.com/archives/C022X4RC0UR)
- **Meeting Schedule:** This project has a 2-week Sprint cadence.
- Sprint Review is held every other Tuesday at 10 am US Central Time
- New Sprint Planning occurs the following day (Wednesday) at 10 am US Central Time
- Backlog Refinement occurs in the intervening Wednesday at 10 am US Central Time
- Standup occurs every Monday at 10 am US Central Time
## Background
The Geospatial Consumption Zone provides ready-to-use geospatial web services or "map layers" from OSDU datasets. Because the process of searching and discovering where in the world you have data is integral to the utility of the OSDU data platform, a searcheable and intuitive map-based interface makes the data much more accessible. With this objective, the OSDU Geomatics Workstream created the Geospatial Consumption Zone (GCZ) project.
### Objectives
- Support development and maintenance of the Geospatial Consumption Zone
- Field enhancement requests and bug reports
- Implement iterative improvements in accordance with OSDU Data Platform release schedule
### Deliverables
- Set of microservices which facilitate the instream, processing, and outstream of OSDU's spatial datasets
- Once deployed and operational, the GCZ delivers ready-to-use geospatial web services representing the geographic location of OSDU datasets
- Documentation which provides guidance on the general installation, configuration, and usage of GCZ software
### Status
- This project is graduated and maintaining active development
- Some pieces of the proposed architecture have yet to be implemented (OGC & Vector Tile output)
- Please visit the Issue Boards for latest status
- For any questions, please reach out to our Slack channel (#cap-geospatial_consumption_zone)
See the GCZ Status page for latest project status. See our GCZ Docs for a technical overview of GCZ components, API, configuration, deployment, and testing procedures.
**Last Updated:** January 30, 2025, by David Jacob, [Esri].
## Support needed
### Required skillsets
- Expertise in the business benefits and use cases of geospatial representations of OSDU data
- Familiarity with geospatial / GIS concepts
- While not required, expertise in Java, JavaScript, Python, Spring, Apache Ignite, or KoopJS is highly relevant to the work
### What can new joiners get involved in?
- Contributing to ongoing development by writing code, documentation, and testing
- Reviewing the docs and providing feedback
- Using the GCZ and providing feedback
### What are the gaps?
- Any OSDU datatype absent from our list of [supported datatypes](./docs/data_types/General%20Information.md) which does not otherwise comply with generically supported datatype patterns
- Unsupported output formats, such as OGC and Vector Tile
- Any other as-yet uncompleted backlog items
## Useful links & Reference information
* [GCZ Docs](https://community.opengroup.org/osdu/platform/consumption/geospatial/-/tree/master/docs?ref_type=heads)
* [GCZ Issue Board](https://community.opengroup.org/osdu/platform/consumption/geospatial/-/boards/1357)
* [GCZ Status Page](https://community.opengroup.org/osdu/platform/consumption/geospatial/-/wikis/Status)
* [GCZ Slack Channel](https://og.enterprise.slack.com/archives/C022X4RC0UR)
* [Original Architectural Diagrams](./docs/assets/Diagrams/original-architectural-diagrams.md)
* [Admin UI Wiki](https://community.opengroup.org/osdu/platform/consumption/geospatial/-/wikis/GCZ-Admin-UI)
## License
......@@ -54,4 +79,4 @@ Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License
limitations under the License
\ No newline at end of file
## Architecture
The consumption zone is a set of microservices designed for managing and access a variety of geospatial web services. These web services are based on datasets stored in OSDU.
![Overview Diagram](./old/overview.svg)
The provider and ambassador represent the two primary services that need to be developed by this project.
The ambassador can be thought of as the manager of geospatial web services, while the provider is the set of data services themselves.
![Provider and Ambassador Services](./old/provider_ambassador.svg)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment