Google Git
Sign in
apache / shardingsphere-on-cloud / 15665301c8557cf31d6fa0f26ad12da70e6090ae
commit15665301c8557cf31d6fa0f26ad12da70e6090ae[log] [tgz]
authormlycore <maxwell92@126.com>Sun Sep 18 19:53:07 2022 +0800
committermlycore <maxwell92@126.com>Sun Sep 18 19:53:07 2022 +0800
tree227e5d51e5adbba63273ab8798dcd13b61d8e8b3
parentd5066c0cb9ca5a76843de47fe2cb5fd5a6c571be [diff]
chore(ci): remove comments

Signed-off-by: mlycore <maxwell92@126.com>
1 file changed
tree: 227e5d51e5adbba63273ab8798dcd13b61d8e8b3
  1. .github/
  2. charts/
  3. doc/
  4. hack/
  5. shardingsphere-operator/
  6. .asf.yaml
  7. .gitignore
  8. .licenserc.yaml
  9. CODE_OF_CONDUCT.md
  10. CONTRIBUTING.md
  11. LICENSE
  12. README.md
README.md

ShardingSphere on Cloud

Apache ShardingSphere Official Website: https://shardingsphere.apache.org/

GitHub release License Twitter Slack Gitter

This repository collects scripts, tools, manifests and documentations, provides home for Apache ShardingSphere on cloud solutions.

Solutions currently included in this project:

Current Status

Currently, either The ShardingSphere Helm Charts and The ShardingSphere Operator would create the latest version as 5.2.0 of ShardingSphere Proxy. Just following the Quick Start and give it a try!

ShardingSphere Helm Charts

The ShardingSphere Helm Charts uses Helm to provide guidance for the installation of ShardingSphere-Proxy instance in a Kubernetes cluster.

Prerequisites

Quick Start

Please follows instructions to deploy a ShardingSphere cluster with version 5.2.0.

ShardingSphere Operator

The ShardingSphere Operator uses predefined CustomResourceDefinitions for describing a Deployment for Apache ShardingSphere on Kubernetes.

Prerequisites

With the help of ShardingSphere-Operator you could create a ShardingSphere-Proxy cluster including the ZooKeeper cluster in minutes.

For installation of SharingSphere-Operator, you will need a Kubernetes cluster, no matter it is a managed Kubernetes service like AWS EKS or self-hosted Kubernetes, or just a mini-kube, you can easily install ShardingSphere-Operator with respective ShardingSphere Operator Helm Charts, and apply the manifests in ShardingSphere Cluster Helm Charts describing the expected Apache ShardingSphere deployment. Kubernetes 1.18+ is recommended.

Internal Architecture

img.png

Current Status

Minimum Viable Product

Quick Start

Please follows instructions to deploy a ShardingSphere cluster with version 5.2.0.

Features

  • Supports the use of proxy to configure and describe the shardingsphere-proxy cluster. For detailed configuration, see the deployment documentation
  • Support native shardingsphere proxy server.yaml configuration. For specific support items, please refer to the documentation
  • Support automatic creation of HPA based on cpu metrics
  • Support automatic download of MySQL driver

Installation

Helm

  • ShardingSphere-Operator chart
    • Support deploy shardingsphere operator
  • ShardingSphere-Cluster chart
    • Support deploy shardingsphere proxy cluster
    • Support deploy Zookeeper by bitnami
    • Support automatic configuration of the address of the governance center
    • Use github pages to host repositories and support helm repo add to add repositories

Development Prerequisites

To build ShardingSphere Operator from scratch you will need to install the following tools:

Contributing

To contribute to this project, refer to Contributing.

Community & Support

:link: Mailing List. Best for: Apache community updates, releases, changes.

:link: GitHub Issues. Best for: larger systemic questions/bug reports or anything development related.

:link: GitHub Discussions. Best for: technical questions & support, requesting new features, proposing new features.

:link: Slack channel. Best for: instant communications and online meetings, sharing your applications.

:link: Twitter. Best for: keeping up to date on everything ShardingSphere.

License

Apache License 2.0, see LICENSE.