Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/urbanos-public/smartcitiesdata

The core micro services of UrbanOS as an umbrella project with component documentation
https://github.com/urbanos-public/smartcitiesdata

data-analytics data-processing data-visualization elixir elixir-phoenix

Last synced: about 1 month ago
JSON representation

The core micro services of UrbanOS as an umbrella project with component documentation

Host: GitHub
URL: https://github.com/urbanos-public/smartcitiesdata
Owner: UrbanOS-Public
License: apache-2.0
Created: 2019-06-17T19:35:09.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-04-01T18:36:26.000Z (9 months ago)
Last Synced: 2024-04-02T18:03:54.109Z (9 months ago)
Topics: data-analytics, data-processing, data-visualization, elixir, elixir-phoenix
Language: Elixir
Homepage:
Size: 13.6 MB
Stars: 60
Watchers: 3
Forks: 10
Open Issues: 34
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # Smart Cities Data Platform

# Project Description

The platform is a combination of Elixir micro services custom built to ingest, normalize, transform,

persist, and stream data from numerous sources, orchestrated via Kubernetes in any cloud provider or

on-prem Kubernetes deployment. The loosely coupled services pass data across the pipeline via Kafka

message queues and persist data to any hyper-scalable object store providing the S3 standard. They

coordinate and communicate via a single event bus, also running on top of Kafka. The distributed data

files are persisted and retrieved via SQL queries processed by the PrestoDB engine.

Finally, user access, discovery, and analysis is facilitated by a ReactJS web application user interface,

a RESTful API, or a web socket API for streaming data feeds.

![scdp architecture diagram](./scdp_arch.png?raw=true "scdp architecture")

## Microservices

| Application       | Short Description | Build Status |

| ----------------- | ----------------- | ------------ |

| [Andi](https://github.com/UrbanOS-Public/smartcitiesdata/blob/master/apps/andi/README.md)                             | Admin Interface for creating/editing datasets to be ingested  | ![](https://github.com/UrbanOS-Public/smartcitiesdata/actions/workflows/andi.yml/badge.svg)  |

| [Discovery API](https://github.com/UrbanOS-Public/smartcitiesdata/blob/master/apps/discovery_api/README.md)           | API to search for and query datasets                          | ![](https://github.com/UrbanOS-Public/smartcitiesdata/actions/workflows/discovery_api.yml/badge.svg) |

| [Discovery Streams](https://github.com/UrbanOS-Public/smartcitiesdata/blob/master/apps/discovery_streams/README.md)   | Websocket connection to listen to streaming data              | ![](https://github.com/UrbanOS-Public/smartcitiesdata/actions/workflows/discovery_streams.yml/badge.svg)  |

| [Estuary](https://github.com/UrbanOS-Public/smartcitiesdata/blob/master/apps/estuary/README.md)                       | Microservice to persist event stream events                   | ![](https://github.com/UrbanOS-Public/smartcitiesdata/actions/workflows/estuary.yml/badge.svg)  |

| [Forklift](https://github.com/UrbanOS-Public/smartcitiesdata/blob/master/apps/forklift/README.md)                     | Microservice for saving data to Presto DB                     | ![](https://github.com/UrbanOS-Public/smartcitiesdata/actions/workflows/forklift.yml/badge.svg)  |

| [Reaper](https://github.com/UrbanOS-Public/smartcitiesdata/blob/master/apps/reaper/README.md)                         | Microservice to retrieve data                                 | ![](https://github.com/UrbanOS-Public/smartcitiesdata/actions/workflows/reaper.yml/badge.svg)  |

| [Valkyrie](https://github.com/UrbanOS-Public/smartcitiesdata/blob/master/apps/valkyrie/README.md)                     | Microservice to validate data structure during ingestion      | ![](https://github.com/UrbanOS-Public/smartcitiesdata/actions/workflows/valkyrie.yml/badge.svg)  |

| [Alchemist](https://github.com/UrbanOS-Public/smartcitiesdata/blob/master/apps/alchemist/README.md)                   | Microservice to alter data from its original format           | ![](https://github.com/UrbanOS-Public/smartcitiesdata/actions/workflows/alchemist.yml/badge.svg)  |

# Prerequisites

### General Prerequisites

* [Elixir](https://elixir-lang.org/) - The primary language that all of the microservices are written in

* [Docker](https://www.docker.com/) - All microservices are built as docker images

* [Apache Kafka](https://kafka.apache.org/) -  Communication mechanism between microservices

* [Redis](https://redis.io/) - General purpose storage and caching

* [Elasticsearch](https://www.elastic.co/) - Used by Discovery API for search

* [PostgreSQL](https://www.postgresql.org/) - General purpoase storage

* [Presto](https://prestodb.io/) - Big Data storage of ingested data

* [Vault](https://www.vaultproject.io/) - Secure storage of secrets

### Development Enviornment Setup

[Setup guide available on our wiki](https://github.com/UrbanOS-Public/smartcitiesdata/wiki/Setup)

# Usage

The microservices written in Elixir use [Mix](https://elixir-lang.org/getting-started/mix-otp/introduction-to-mix.html) as the build tool.

## Building

Each microservice under the [apps/](https://github.com/UrbanOS-Public/smartcitiesdata/tree/master/apps) directory has a `Dockerfile` that can be used to build that microservice individually by running the following command:

```

docker build .

```

Additional app specific build steps will be in the relative readme at `apps/{app}/readme.md`.

## Testing

* Unit tests can be executed from the root of this repository or a specific application under the [apps/](https://github.com/UrbanOS-Public/smartcitiesdata/tree/master/apps) directory

```

mix test

```

* Integration tests can be executed from the root of this repository or a specific application under the [apps/](https://github.com/UrbanOS-Public/smartcitiesdata/tree/master/apps) directory

```

mix test.integration

```

* End to End (E2E) Tests can be executed from the root of this repository.

```

mix test.e2e

```

## Execution

[How to run and use the code](https://github.com/UrbanOS-Public/smartcitiesdata/wiki/Run)

# Additional Notes

* [What is the project and how it works](https://github.com/UrbanOS-Public/smartcitiesdata/wiki/The-What)

* [What all those application names mean](https://github.com/UrbanOS-Public/smartcitiesdata/wiki/Names)

* [Additional learning resources](https://github.com/UrbanOS-Public/smartcitiesdata/wiki/Resources)

* [A glossary of terms and technologies](https://github.com/UrbanOS-Public/smartcitiesdata/wiki/Glossary)

* [Starting All of the Microservices](https://github.com/UrbanOS-Public/smartcitiesdata/wiki/Run)

# Version History and Retention

Each microservice is released independently and can be found here in the [Releases](https://github.com/UrbanOS-Public/smartcitiesdata/releases) section.  All releases will be kept indefinitely.

Versioning conforms to the standard versioning pattern of .., for example 3.0.1. 3 being major, 0 being minor, and 1 being patch.

Patch version increments should introduce no breaking changes to the existing public chart. Docker images/Elixir apps are able to be updated in-place with no changes needed.

Minor version increments may require chart changes to function properly. These changes should be reviewed and charts should be adjusted accordingly before updating.

Major version increments likely introduce wide-spread or structural changes that require many configuration changes. 

# License

Released under [Apache 2 license](https://github.com/UrbanOS-Public/smartcitiesdata/blob/master/LICENSE).

# Contributions

[How to contribute](https://github.com/UrbanOS-Public/smartcitiesdata/wiki/Contribute)

# Contact Information

# Acknowledgements