hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README and remove README.md

Browse Source 
Simplifies maintenance if there is but one file. Github shows
the contents of README if there is no README.md file.
This commit is contained in:
Johan Wikman
2016-03-15 14:21:55 +02:00
parent 2f21181986
commit 200f0624df
2 changed files with 16 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README
View File

@ -1,9 +1,9 @@
/** \mainpage MaxScale by MariaDB Corporation # MaxScale by MariaDB Corporation
The MariaDB Corporation MaxScale is an intelligent proxy that allows forwarding of The MariaDB Corporation MaxScale is an intelligent proxy that allows
database statements to one or more database servers using complex rules, forwarding of database statements to one or more database servers using
a semantic understanding of the database statements and the roles of complex rules, a semantic understanding of the database statements and the
the various servers within the backend cluster of databases. roles of the various servers within the backend cluster of databases.
MaxScale is designed to provide load balancing and high availability MaxScale is designed to provide load balancing and high availability
functionality transparently to the applications. In addition it provides functionality transparently to the applications. In addition it provides
@ -25,13 +25,14 @@ as external shared objects and are referred to as routing modules.
An Google Group exists for MaxScale that can be used to discuss ideas, An Google Group exists for MaxScale that can be used to discuss ideas,
issues and communicate with the MaxScale community. issues and communicate with the MaxScale community.
Send email to [maxscale@googlegroups.com](mailto:maxscale@googlegroups.com)
or use the [forum](http://groups.google.com/forum/#!forum/maxscale) interface
Bugs can be reported in the MariaDB Corporation bugs database Email: maxscale@googlegroups.com
[https://mariadb.atlassian.net/secure/CreateIssue!default.jspa](https://mariadb.atlassian.net/secure/CreateIssue!default.jspa) under project MXS. Forum: http://groups.google.com/forum/#!forum/maxscale
\section Documentation Bugs can be reported in the MariaDB Corporation bugs database:
https://jira.mariadb.org/projects/MXS/issues
# Documentation
For information about installing and using MaxScale, please refer to the For information about installing and using MaxScale, please refer to the
documentation. It is in Markdown format. documentation. It is in Markdown format.
@ -43,8 +44,5 @@ documentation in its intended display format. The contents page lists
the available documents and has links to them. the available documents and has links to them.
If you do not want to rely on the internet, then clone the project If you do not want to rely on the internet, then clone the project
from GitHub - either the entire project or just the Documentation folder. from GitHub and point your browser to the Documentation-Contents.md
Then point your browser to the Documentation-Contents.md file in your file in your local file system and proceed as above.
local file system and proceed as above.
*/

37
README.md
View File

@ -1,37 +0,0 @@
# MaxScale by MariaDB Corporation
The MariaDB Corporation MaxScale is an intelligent proxy that allows forwarding of
database statements to one or more database servers using complex rules,
a semantic understanding of the database statements and the roles of
the various servers within the backend cluster of databases.
MaxScale is designed to provide load balancing and high availability
functionality transparently to the applications. In addition it provides
a highly scalable and flexible architecture, with plugin components to
support different protocols and routing decisions.
MaxScale is implemented in C and makes extensive use of the
asynchronous I/O capabilities of the Linux operating system. The epoll
system is used to provide the event driven framework for the input and
output via sockets.
The protocols are implemented as external shared object modules which
can be loaded at runtime. These modules support a fixed interface,
communicating the entries points via a structure consisting of a set of
function pointers. This structure is called the "module object".
The code that routes the queries to the database servers is also loaded
as external shared objects and are referred to as routing modules.
An Google Group exists for MaxScale that can be used to discuss ideas,
issues and communicate with the MaxScale community.
Send email to maxscale@googlegroups.com
or use the [forum](http://groups.google.com/forum/#!forum/maxscale) interface
Bugs can be reported in the MariaDB Corporation bugs database
[https://mariadb.atlassian.net/projects/MXS/issues](https://mariadb.atlassian.net/projects/MXS/issues)
# Documentation
For information about installing and using MaxScale, please refer to the
[documentation](Documentation/Documentation-Contents.md).