Skip to content

Latest commit

 

History

History
113 lines (69 loc) · 6.71 KB

README.md

File metadata and controls

113 lines (69 loc) · 6.71 KB

Erda logo

An enterprise-grade Cloud-Native application platform

license Go Report Card release

Demo

Screenshot

Introduction

Erda is an open-source platform created by Terminus to ensure the development of microservice applications. It provides DevOps, microservice governance, and multi-cloud management capabilities. The multi-cloud architecture based on Kubernetes and application-centric DevOps and microservice governance can make the development, operation, monitoring, and problem diagnosis of complex business applications simpler and more efficient.

Functional Architecture

Erda is mainly composed of the following parts:

  • DevOps
  • Microservice Governance, including Application Performance Management, Monitoring, Log Analysis, API Gateway, etc.
  • Multi-Cloud Management
  • Edge Computing
  • FastData Management

Vision: Build any application, Deploy anywhere, Monitor anything

Architecture

The Erda project consists of multiple repsitories according to different functions. The key repositories are erda, erda-ui, erda-proto, erda-infra, erda-actions, erda-addons, docs.

It is the core repository that implements all the RESTful and gRPC interfaces of the backend services of Erda platform by multiple components in microservice architecture.

It is the graphical user portal of Erda platform built with React with the help of which users can work upon Erda platform very easily. It talks with erda backend services in RESTful APIs.

It defines a part of the communication protocols among erda backend services using Protocol Buffers. All the other protocols among erda backend services will be migrated here in the near future.

It is a lightweight microservices framework implements by golang. It provides many popular middleware providers such as Redis, KafKa, etcd, etc., so that developers can build a module-driven application quickly with help of it. It is also integrated into almost all the backend components in erda.

It holds the definition for the official Pipeline Actions of the Erda Action Marketplace as found at https://www.erda.cloud/market/action. A Pipeline Action plays as a mininal runnable unit in Erda Pipelines such as checking out source code in github, buiding a docker image, creating a deployment in a Kubernetes cluster etc.. You can find more information about Pipeline Actions here.

It holds the definition for the official Addons of the Erda Addon Marketplace as found at https://www.erda.cloud/market/addon. An Addon holds the configration of a middleware like MySQL, Redis, etc. or a third-party service and it can be shared to different environments of applications, so that developers would not need to import the same configurations again and again in different environments. You can find more information about Erda Addons here.

It is the codebase of Erda documentation built with vuepress.

There are some extra repositories that plays as customized third-partiy independent components and tools in Erda project such as

  • erda-proto-go generated code for Erda protobuf data modals and protocols.
  • erda-analyzer is the streaming aggregator for metrics and alert data.
  • erda-java-agent is the apm java agent in Erda platform.
  • telegraf is the plugin-driven server agent for collecting & reporting metrics.
  • kubeprober is a large-scale Kubernetes cluster diagnostic tool.
  • beats is the lightweight shippers for Elasticsearch & Logstash.
  • remotedialer is a reverse tunneling dialer.
  • erda-bot is the bot handing Github webhooks.

Quick Start

To get started, see Quick Start.

Installation

Please refer to the following documentation to install Erda.

User Manual

To start using Erda, please refer to the following documentation.

Contributing

Contributions are always welcomed. Please refer to Contributing to Erda for details.

Contact Us

If you have any questions, please feel free to contact us.

License

Erda is under the AGPL 3.0 license. See the LICENSE file for details.