diff --git a/README.md b/README.md index dbeca11..d680f5a 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,10 @@ -
- Template for developing an EOEPCA Service
+ This repository includes the EOEPCA Data Access building block
Explore the docs ยป
@@ -44,12 +44,11 @@
## Table of Contents
-- [About the Project](#about-the-project)
+- [Description](#description)
- [Built With](#built-with)
+ - [Interfaces](#interfaces)
- [Getting Started](#getting-started)
- - [Prerequisites](#prerequisites)
- - [Installation](#installation)
- - [Testing](#testing)
+ - [Deployment](#deployment)
- [Documentation](#documentation)
- [Usage](#usage)
- [Roadmap](#roadmap)
@@ -60,57 +59,79 @@
-## About The Project
+## Description
-[![Product Name Screen Shot][product-screenshot]](https://example.com)
+The EOEPCA Data Access building block is built upon the upstream View Server project.
-Here's a blank template to get started:
-**To avoid retyping too much info. Do a search and replace with your text editor for the following:**
-`rm-data-access`, `twitter_handle`, `email`
+View Server is a Docker based software and all of its components are distributed and executed in context of Docker images, containers and Helm charts. Basic knowledge of Docker and either Docker Swarm or Helm and Kubernetes is a prerequisite.
-### Built With
-
-- [PRISM View Server](https://gitlab.eox.at/esa/prism/vs/)
-
-
+The provided external services are services for searching, viewing, and downloading of Earth Observation (EO) data. Service endpoints optimized for performance as well as for flexibility are provided alongside each other.
-## Getting Started
+The View Server default Chart vs consists of the following service components (with their respective Docker image in parenthesis):
-To get a local copy up and running follow these simple steps.
+* Web Client (client)
+* Cache (cache)
+* Renderer (core)
+* Registrar (core)
+* Seeder (seeder)
+* Preprocessor (preprocessor)
+* Ingestor (ingestor)
+* Harvester (harvester)
+* Scheduler (scheduler)
+* Database (postgis)
+* Queue Manager (redis)
-### Prerequisites
+View Server is Open Source, released under an MIT license.
+[![Product Name Screen Shot][product-screenshot]](https://gitlab.eox.at/vs/vs)
+### Built With
-### Installation
+- [Python](https://www.python.org/)
+- [Django](https://www.djangoproject.com/)
+- [GDAL](https://gdal.org/)
+- [PostGIS](https://postgis.net/)
+- [EOXServer](https://github.com/EOxServer/eoxserver)
+- [EOX View Server](https://gitlab.eox.at/vs/vs)
+### Interfaces
-1. Setting up minikube:
+The Data Access provides the following interfaces:
+* OGC WMS 1.1/1.3 (EO-WMS)
+* OGC WCS 2.0.0 (EO Application Profile)
+* OGC WMTS 1.0
+* DSEO
+* OpenSearch with OGC EO, Geo and Time extensions
-```bash
+
-```
+## Getting Started
-2. Deploying on minikube (or any other kubernetes cluster)
+To get a View Server copy up and running follow these simple steps.
-```bash
+https://vs.pages.eox.at/vs/operator/k8s.html#operating-k8s
-```
+### Deployment
-### Testing
+Data Access deployment is described [here](https://deployment-guide.docs.eoepca.org/current/eoepca/data-access/) in the [EOEPCA Deployment Guide](https://deployment-guide.docs.eoepca.org/current/eoepca/data-access/).
+## Documentation
+The View Server documentation can be found at https://vs.pages.eox.at/vs/.
-## Documentation
+EOEPCA related documents:
+* [Data Access Interface Control Document](https://eoepca.github.io/rm-data-access//ICD/)
+* [Data Access Software Design Document](https://eoepca.github.io/rm-data-access/SDD/)
The component documentation can be found at https://eoepca.github.io/rm-data-access/.
+
## Usage
-
+You can find some usage examples in the View Server Client documentation: https://vs.pages.eox.at/vs/user/webclient.html
diff --git a/images/logo.png b/images/logo.png
index 0f38ba9..7bf76db 100644
Binary files a/images/logo.png and b/images/logo.png differ
diff --git a/images/screenshot.png b/images/screenshot.png
index 3b58bcb..5163d90 100644
Binary files a/images/screenshot.png and b/images/screenshot.png differ