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

Adding architecture section and diagram. #23

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
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
9 changes: 9 additions & 0 deletions docs/Quickstart/Architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SkySQL Architecture

The SkySQL architecture is designed to provide a robust, scalable, and secure database management solution. At its core, users interact with the system through the Application Portal, which serves as the interface for deploying and managing database instances. This portal connects to the SkySQL Core Services, a suite of components responsible for handling user requests, orchestrating deployments, and monitoring system performance via RESTful APIs.

![SkySQL Architecture](skysql-architecture.png)

The SkySQL Core Services operate within a Virtual Private Cloud (VPC) to ensure security and isolation. Key components within this core include APIs and microservices that manage database operations and user interactions, a monitoring and metrics infrastructure that tracks the health and performance of the databases, and an orchestration engine that deploys and configures database instances as needed.

Customer clusters are deployed in their own VPCs, providing complete security and isolation. Each cluster houses multiple MariaDB server instances managed by Kubernetes, which ensures performance and high availability. This architecture allows SkySQL to seamlessly integrate with major cloud providers like AWS, GCP, and Azure, offering flexible multi-cloud and scalable deployment options to meet varying customer needs.
Binary file added docs/Quickstart/skysql-architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ nav:
- 'Quickstart/README.md'
- 'Quickstart/Launch DB using the REST API.md'
- 'Quickstart/Launch DB using the Terraform Provider.md'
- 'Quickstart/Architecture.md'
- 'UI Portal Features' :
- 'Portal features/README.md'
- 'Portal features/Launch page.md'
Expand Down