What is Echelon?

Echelon is a flexible and scalable metadata and governance framework. It gathers technical, operational, and business metadata and puts it all in one central database. This setup allows Echelon to be used in various ways, like creating data workflows based on metadata, keeping an eye on data quality, mapping out where data comes from, and more.

What are the various components that make up Echelon?

Echelon is a comprehensive ecosystem built upon four essential components, each contributing uniquely to its functionality and utility:

• Database: At the core of Echelon lies a robust and centralised database. This repository serves as the heart of the framework, collecting and organizing a wealth of technical, operational, and business metadata. Through this database, Echelon gains the capacity to manage and present crucial information that forms the backbone of various data-related activities.

• CLI / API: Echelon's Command Line Interface (CLI) and Application Programming Interface (API) together offer a gateway to its capabilities. The CLI empowers users to interact with the framework through a command-line interface, providing a streamlined and efficient way to execute tasks, fetch data, and manage metadata-related operations. Simultaneously, the API grants developers the flexibility to integrate Echelon's functionalities seamlessly into their own applications, fostering interoperability and expanding its potential use cases.

• Web: The Echelon Web interface is as a dynamic and user-friendly web-based application. Tailored to cater to a diverse audience, this interactive interface provides an intuitive means to visualize and explore the wealth of information stored within the Echelon ecosystem. Its role extends beyond mere visualisation, allowing users to engage with operational workflows, assess data assets, and delve into the details of data lineage and governance, all while maintaining a responsive and engaging user experience.

• Documentation: Recognising the significance of clear guidance and accessibility, Echelon places emphasis on comprehensive documentation. This component encapsulates valuable insights, guidelines, tutorials, and best practices, ensuring that users, administrators, and developers alike can harness the framework's potential to the fullest. The documentation not only aids in getting started with Echelon but also serves as an ongoing reference, promoting efficient utilisation and encouraging the exploration of its diverse capabilities.

Data Model

At a logical level, the data model below illustrates the relationships among the various entities within the Echelon data model.

Note: Relationship and mapping tables are omitted to simplify the model for illustrative purposes only.

How do I get started?

Access the directory of each component and consult the supplied README for thorough setup instructions.

Suggested sequence for setup:

1. Command Line Interface (CLI)
2. Database
3. Web Application

Afterwards, follow the Getting Started guide to get your first taste of the framework.

How do I contribute?

We welcome contributions from the community! To contribute to the Echelon project, please read our Contributor's Guide to understand our jobs.

What if I find an issue?

If you encounter any bugs, have feature requests, or wish to report issues, please create an issue on our GitHub repository.

What open-source license does the project use?

This project is licensed under the MIT License - see the LICENSE file for details.

How do I contact the Echelon team if I have questions?

For any inquiries or questions, feel free to reach out to us by raising an Issue or starting a Discussion.