-
Notifications
You must be signed in to change notification settings - Fork 54
update docs: use operator to deploy eloqdoc #242
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
Open
starrysky9959
wants to merge
3
commits into
eloqdata:main
Choose a base branch
from
starrysky9959:operator_docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| # Deploy EloqDoc with Eloq Operator | ||
|
|
||
| This directory contains deployment guides for running EloqDoc on different cloud platforms using the Eloq Operator. | ||
|
|
||
| ## Overview | ||
|
|
||
| The Eloq Operator simplifies the deployment and management of EloqDoc clusters by providing: | ||
| - Declarative configuration through Kubernetes Custom Resources (CR) | ||
| - Automated lifecycle management (deployment, scaling, updates) | ||
| - Cloud-native integration with various cloud providers | ||
| - Simplified storage configuration (local SSD, cloud object storage) | ||
|
|
||
| ## Deployment Guides by Cloud Provider | ||
|
|
||
| | Cloud Provider | Platform | Guide | | ||
| | --------------- | -------- | ------------------------------------- | | ||
| | **AWS** | EKS | [Deploy on AWS EKS](./aws-eks.md) | | ||
| | **Baidu Cloud** | CCE | [Deploy on Baidu CCE](./baidu-cce.md) | | ||
|
|
||
| 1. **Choose your cloud platform** from the guides above | ||
| 2. **Follow the platform-specific guide** for detailed step-by-step instructions | ||
| 3. **Deploy the Eloq Operator** and required components | ||
| 4. **Apply the EloqDoc CustomResource** to create your cluster | ||
| 5. **Connect and test** your EloqDoc deployment | ||
|
|
||
| ## Common Prerequisites | ||
|
|
||
| Before deploying on any platform, ensure you have: | ||
|
|
||
| - `kubectl` installed (v1.28 or later) | ||
| - `helm` installed (v3.0 or later) | ||
| - Access to a Kubernetes cluster (v1.28 or later) | ||
| - Appropriate cloud provider CLI tools and credentials | ||
|
|
||
| ## Common Components | ||
|
|
||
| All deployments require the following components: | ||
|
|
||
| 1. **cert-manager** (v1.19.0+) | ||
| - Manages TLS certificates for webhook endpoints | ||
| - Required by the Eloq Operator | ||
|
|
||
| 2. **OpenEBS** (v4.3.0+) | ||
| - Provides local persistent volume provisioning | ||
| - Supports XFS filesystem with quota | ||
|
|
||
| 3. **Eloq Operator** | ||
| - Manages EloqDoc cluster lifecycle | ||
| - Deploys and configures EloqDoc instances | ||
| - Handles storage and networking configuration | ||
|
|
||
| ## Deployment Architecture | ||
|
|
||
| EloqDoc uses a hybrid storage approach: | ||
|
|
||
| - **Block Storage (Raft Log)** | ||
| - Cloud block storage (EBS/CDS) for raft consensus logs | ||
| - Used by the log service for distributed consensus | ||
| - Persistent volumes for durability and consistency | ||
| - Provisioned via CSI drivers (EBS CSI/CDS CSI) | ||
|
|
||
| - **Local Storage (Hot Data)** | ||
| - Fast local SSDs for cache and active data | ||
| - XFS filesystem with quota support | ||
| - Provisioned via OpenEBS local PV | ||
|
|
||
| - **Object Storage (Cold Data)** | ||
| - Cloud object storage (S3/BOS) for persistent data | ||
| - Transaction logs and SST files | ||
| - Automatic bucket creation and lifecycle management | ||
|
|
||
|
|
||
| ``` | ||
| ┌─────────────────────────────────────────────────────────┐ | ||
| │ Kubernetes Cluster │ | ||
| │ │ | ||
| │ ┌────────────────────────────────────────────────┐ │ | ||
| │ │ Eloq Operator │ │ | ||
| │ │ (Namespace: eloq-operator-system) │ │ | ||
| │ └────────────────────────────────────────────────┘ │ | ||
| │ │ │ | ||
| │ │ Manages │ | ||
| │ ▼ │ | ||
| │ ┌────────────────────────────────────────────────┐ │ | ||
| │ │ EloqDoc Cluster (CR) │ │ | ||
| │ │ ┌──────────────────────────────────────────┐ │ │ | ||
| │ │ │ Frontend (MongoDB Protocol) │ │ │ | ||
| │ │ └──────────────────────────────────────────┘ │ │ | ||
| │ │ ┌──────────────────────────────────────────┐ │ │ | ||
| │ │ │ TX Nodes (Transaction Processing) │ │ │ | ||
| │ │ │ - Local SSD (XFS with quota) │ │ │ | ||
| │ │ │ - Object Storage (S3/BOS) │ │ │ | ||
| │ │ └──────────────────────────────────────────┘ │ │ | ||
| │ └────────────────────────────────────────────────┘ │ | ||
| │ │ | ||
| │ ┌────────────────────────────────────────────────┐ │ | ||
| │ │ Supporting Components │ │ | ||
| │ │ - cert-manager (TLS certificates) │ │ | ||
| │ │ - OpenEBS (Local PV provisioning) │ │ | ||
| │ │ - CSI Drivers (Cloud disk management) │ │ | ||
| │ └────────────────────────────────────────────────┘ │ | ||
| └─────────────────────────────────────────────────────────┘ | ||
| │ | ||
| │ Storage | ||
| ▼ | ||
| ┌───────────────────────────────┐ | ||
| │ Object Storage │ | ||
| │ - Transaction Logs │ | ||
| │ - Object Store Data │ | ||
| └───────────────────────────────┘ | ||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Specify language for fenced code block (ASCII diagram).
The ASCII architecture diagram at Line 67 should declare a language. Since it's a text diagram, use
textorplaintext:🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
67-67: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents