Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update readme #161 #162

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 24 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,38 +8,43 @@

## Overview

`Xenon` is a MySQL HA and Replication Management tool using Raft protocol.
`Xenon` is an HA MySQL and replication management tool adopting the Raft protocol.

Xenon has many cool features, such as:
`Xenon` has many cool features, such as:

* Fast Failover with no lost transactions
* Streaming & Speed-Unmatched backup/restore
* MySQL Operation and Maintenance
* No central control and easy-to-deploy
* As a Cloud App
🎂 Fast failover without loss of transactions

🎈 Streaming and speed-unmatched backup/restore

🎨 MySQL O&M

🎯 No central control and easy to deploy

☁ As a cloud App

## Architecture

![](docs/images/xenon.png)

## Documentation

- [build and run xenon](docs/how_to_build_and_run_xenon.md) : How to build and run xenon.
- [xenon cli commands](docs/xenoncli_commands.md) : Xenon client commands.
- [how xenon works](docs/how_xenon_works.md) : How xenon works.
- [how xenon upgrades](docs/how_xenon_upgrades.md): How xenon upgrades.
- [Build and run xenon](docs/how_to_build_and_run_xenon.md)
- [Xenon CLI commands](docs/xenoncli_commands.md)
- [How Xenon works](docs/how_xenon_works.md)
- [how Xenon upgrades](docs/how_xenon_upgrades.md)

## Use cases

`Xenon` is production-ready, and it has been used in production:

## Use case
🍉 [MySQL Plus](https://www.qingcloud.com/products/mysql-plus/) - a high-availability MySQL cluster

Xenon is production ready, it has been used in production like:
- [MySQL Plus](https://www.qingcloud.com/products/mysql-plus/) - A Highly Available MySQL Clusters
- [RadonDB](https://www.qingcloud.com/products/radondb) - A cloud-native MySQL database for building global, scalable cloud services
🍊 [RadonDB](https://www.qingcloud.com/products/radondb) - a cloud-native MySQL database for building global and scalable cloud services

## Issues
## Issue

The [integrated github issue tracker](https://github.com/radondb/xenon/issues)
is used for this project.
The [integrated github issue tracker](https://github.com/radondb/xenon/issues) is used for this project.

## License

Xenon is released under the GPLv3. See [LICENSE](LICENSE)
Xenon is released under the GPLv3. See [LICENSE](LICENSE)