-
Notifications
You must be signed in to change notification settings - Fork 272
Add capabilities/platform documentation #3542
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
base: main
Are you sure you want to change the base?
Changes from all commits
ff81213
2043bf7
e6b1834
3e389ae
ba15c62
4614a47
7c7eba4
0214715
ef2b1a2
73b039a
552aa82
d89382d
f386054
9ac7cb3
68922c6
3cdd4b5
463239f
ff38c8f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this screen has a warning banner about older versions that doesn't make sense in this context |
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Pro plans to be removed this week |
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. dynamic search rules removed now |
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this batch view will change dramatically in the next week or so - ok to update at that stage but just as a heads up this screen won't exist |
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same for this (batch view changes) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| 5 broken internal link(s) across 4 file(s): | ||
|
|
||
| capabilities/full_text_search/advanced/debug_search_performance.mdx | ||
| line 98: /resources/self_hosting/sharding | ||
|
|
||
| capabilities/indexing/how_to/document_relations.mdx | ||
| line 142: /resources/self_hosting/sharding | ||
| line 148: /reference/api/settings/get-foreign-keys | ||
|
|
||
| resources/help/experimental_features_overview.mdx | ||
| line 69: /capabilities/personalization/getting_started | ||
|
|
||
| resources/self_hosting/enterprise_edition.mdx | ||
| line 14: /resources/self_hosting/sharding |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| title: Invoices | ||
| description: View and download your Meilisearch Cloud invoice history through the Stripe customer portal. | ||
| --- | ||
|
|
||
| Invoices are managed through Stripe. To access your invoice history, open the **Billing** tab in the Cloud dashboard and click **Manage billing settings and invoices**. This opens the Stripe customer portal. | ||
|
|
||
| <Frame> | ||
| <img src="/assets/images/platform/billing/stripe_portal.png" alt="Stripe customer portal showing invoice history with dates, amounts, and paid status" /> | ||
| </Frame> | ||
|
|
||
| The **Invoice history** section in the Stripe portal lists all past invoices with their date, amount, and payment status. Click any invoice to view its details or download a PDF. | ||
|
|
||
| If you need to update the billing name, address, or Tax ID shown on invoices, click **Update information** in the portal. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| title: Billing | ||
| sidebarTitle: Overview | ||
| description: Understand how Meilisearch Cloud billing works, view your estimated next bill, and manage payment settings through Stripe. | ||
| --- | ||
|
|
||
| Meilisearch Cloud billing is fully powered by Stripe. The **Billing** tab in the Cloud dashboard shows a summary of your current billing settings and an estimate of your next bill. For invoice history, payment methods, and billing information, click **Manage billing settings and invoices** to open the Stripe customer portal. | ||
|
|
||
| ## Billing models | ||
|
|
||
| | | Resource-based | Usage-based | | ||
| |---|---|---| | ||
| | **What you pay for** | Fixed CPU, RAM, and storage allocation | Number of searches and documents indexed | | ||
| | **Billing cycle** | Hourly (prorated) | Monthly | | ||
| | **Price predictability** | High | Varies with traffic | | ||
|
|
||
| See [project types](/capabilities/platform/infrastructure/overview#resource-based-vs-usage-based-projects) for guidance on which model to choose. | ||
|
|
||
| ## The Billing tab | ||
|
|
||
| <Frame> | ||
| <img src="/assets/images/platform/billing/billing_tab.png" alt="Meilisearch Cloud Billing tab showing billing settings, payment method, and estimated cost for next bill" /> | ||
| </Frame> | ||
|
|
||
| The Billing tab shows: | ||
|
|
||
| - **Billing settings**: your current Tax ID and default payment method | ||
| - **Manage billing settings and invoices**: button to open the Stripe portal for full billing management | ||
| - **Estimated cost for next bill**: a line-by-line breakdown of charges accrued in the current billing period, covering all active projects | ||
|
|
||
| ## What affects your bill | ||
|
|
||
| Only active projects generate charges. Deleting a project stops billing immediately. Team members and API keys do not affect billing. | ||
|
|
||
| ## Next steps | ||
|
|
||
| <CardGroup cols={2}> | ||
| <Card title="Pricing model" href="/capabilities/platform/billing/pricing_model"> | ||
| How billing works, resource pricing, and cost estimation | ||
| </Card> | ||
| <Card title="Invoices" href="/capabilities/platform/billing/invoices"> | ||
| View and download your billing history via Stripe | ||
| </Card> | ||
| <Card title="Payment methods" href="/capabilities/platform/billing/payment_methods"> | ||
| Add or update payment methods via Stripe | ||
| </Card> | ||
| </CardGroup> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| title: Payment methods | ||
| description: Add or update payment methods for your Meilisearch Cloud account through the Stripe customer portal. | ||
| --- | ||
|
|
||
| Payment methods are managed through Stripe. To add, change, or remove a payment method, open the **Billing** tab in the Cloud dashboard and click **Manage billing settings and invoices**. This opens the Stripe customer portal. | ||
|
|
||
| <Frame> | ||
| <img src="/assets/images/platform/billing/stripe_portal.png" alt="Stripe customer portal showing payment method management with option to add a new payment method" /> | ||
| </Frame> | ||
|
|
||
| In the **Payment method** section of the portal: | ||
|
|
||
| - Click **+ Add payment method** to add a new card | ||
| - Click the **×** next to an existing card to remove it | ||
| - The card marked **Default** is the one charged automatically on each billing cycle | ||
|
|
||
| If a payment fails, Meilisearch Cloud will notify you by email. Update your payment method promptly to avoid service interruption. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| --- | ||
| title: Pricing model | ||
| description: How Meilisearch Cloud billing works for resource-based and usage-based projects, including pricing and cost estimation. | ||
| --- | ||
|
|
||
| Meilisearch Cloud bills each project independently. Resource-based projects are billed hourly (prorated), while usage-based projects follow a monthly cycle. | ||
| ## Resource-based pricing | ||
|
|
||
| Resource-based projects are billed at an hourly rate based on the resource tier you select (Memory and vCPU). You pay for the resources you provision, regardless of how many searches you run or documents you index. | ||
|
|
||
| The Cloud UI shows the hourly rate and estimated monthly cost for each tier at project creation and in the project settings. Pricing may vary slightly by region. | ||
|
|
||
| ## Usage-based pricing | ||
|
|
||
| Usage-based projects are billed on what your project actually consumes. There are three plans: | ||
|
|
||
| | Plan | Included searches | Extra searches | Included documents | Extra documents | Resources | | ||
| |------|------------------|----------------|--------------------|-----------------|-----------| | ||
| | **Build** | 50K/month | $0.40 per 1,000 | 100K | $0.30 per 1,000 | Shared | | ||
| | **Pro** | 250K/month | $0.30 per 1,000 | 1M | $0.20 per 1,000 | Dedicated | | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Pro to be removed this week |
||
|
|
||
| Resources scale automatically. You do not choose a tier. The Cloud UI shows your accrued costs based on recent usage. | ||
|
|
||
| ### How usage-based billing is charged | ||
|
|
||
| - **Plan cost**: the base plan fee (Build or Pro) is charged upfront at the start of each billing cycle. | ||
| - **Extra usage**: searches and documents beyond the included quota are charged at the end of the billing cycle, once the total is known. | ||
| - **Cancellation**: if you cancel your plan before the end of the month, the unused portion of the base plan fee is prorated and returned as a credit. | ||
| - **Outstanding usage**: if you remove your payment method while extra usage charges are still outstanding, Meilisearch will follow up to collect the owed amount. | ||
|
|
||
| ## Shared billing rules | ||
|
|
||
| Regardless of billing model: | ||
|
|
||
| - **Per-project billing.** Each project is billed independently. A team with multiple projects is billed the sum of all project charges. | ||
| - **Prorated daily cycle.** Creating or deleting a project mid-day adjusts the charge proportionally. | ||
| - **No per-seat fees.** Adding team members does not affect billing. | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| ## Regions and pricing | ||
|
|
||
| Pricing may vary slightly by region. The Cloud UI shows the exact price for your selected region. | ||
|
|
||
| | Region | Location | | ||
| |--------|----------| | ||
| | `FRA` | Frankfurt | | ||
| | `LON` | London | | ||
| | `SGP` | Singapore | | ||
| | `JPN` | Japan | | ||
| | `SFO` | San Francisco | | ||
| | `NYC` | New York | | ||
|
|
||
| ## Choosing a resource tier | ||
|
|
||
| For resource-based projects, the most important factor is **RAM**: Meilisearch keeps indexes in memory for fast search, so your instance needs enough RAM to hold your index comfortably. | ||
|
|
||
| ### Step 1: Estimate your index size | ||
|
|
||
| Your index size depends on how many documents you have and how large each document is. Use these typical document sizes as a starting point: | ||
|
|
||
| | Document type | Avg size | Examples | | ||
| |--------------|----------|---------| | ||
| | Small | ~1 KB | SaaS records, simple product listings with few filters | | ||
| | Medium | ~3 KB | E-commerce products with descriptions and ~10 filterable attributes | | ||
| | Large | ~8 KB | Articles, blog posts, rich content | | ||
| | AI (with vectors) | ~12 KB | Any document type with vector embeddings | | ||
|
|
||
| **Formula:** | ||
|
|
||
| ``` | ||
| Index size ≈ number of documents × average document size × 5 | ||
| ``` | ||
|
|
||
| The ×5 factor accounts for the inverted index, facet data, prefix structures, and other internal data Meilisearch builds from your documents. | ||
|
|
||
| **Examples:** | ||
|
|
||
| | Documents | Avg size | Estimated index size | | ||
| |-----------|----------|---------------------| | ||
| | 100K | 3 KB (medium) | ~1.4 GB | | ||
| | 500K | 3 KB (medium) | ~7 GB | | ||
| | 100K | 12 KB (AI) | ~5.7 GB | | ||
| | 1M | 8 KB (large) | ~37 GB | | ||
|
|
||
| ### Step 2: Choose a tier with enough RAM | ||
|
|
||
| Choose the smallest tier where **RAM exceeds your estimated index size**. Leave headroom for query cache and peak usage. | ||
|
|
||
| | Tier | vCPU | RAM | Suitable for | | ||
| |------|------|-----|-------------| | ||
| | XS | 0.5 | 1 GB | Development and testing | | ||
| | S | 1 | 2 GB | Up to ~80K small documents | | ||
| | M | 2 | 4 GB | Up to ~80K medium or ~160K small documents | | ||
| | L | 2 | 8 GB | Up to ~400K medium documents | | ||
| | XL | 4 | 16 GB | Up to ~800K medium or ~300K AI documents | | ||
| | 2XL | 8 | 32 GB | Up to ~1.6M medium or ~600K AI documents | | ||
| | 4XL | 16 | 64 GB | Up to ~3M medium or ~1.2M AI documents | | ||
|
|
||
| For larger workloads, contact [sales@meilisearch.com](mailto:sales@meilisearch.com) to discuss Enterprise options including [sharding and replication](/capabilities/platform/infrastructure/sharding_and_replication). | ||
|
|
||
| ### Step 3: Consider vCPU for high query volume | ||
|
|
||
| RAM is almost always the bottleneck. However, if your workload involves sustained high QPS (hundreds of searches per second), choose a tier with more vCPUs. Tiers L and below share 2 vCPUs, while XL and above provide dedicated cores. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Clarify vCPU statement to match the tier table. “Tiers L and below share 2 vCPUs” conflicts with XS/S values in the table. Consider wording like “share CPU resources” and keep dedicated-core distinction for XL+. 🤖 Prompt for AI Agents |
||
|
|
||
| ### Interactive estimator | ||
|
|
||
| Use the [pricing page calculator](https://www.meilisearch.com/pricing) to get a recommendation based on your document count, document type, and expected search volume. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. does this exist? 🤔
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. not yet, only in the preview but should normally be merged after the offsite! |
||
|
|
||
| ## Estimating your costs | ||
|
|
||
| **Resource-based projects:** the Cloud UI shows the hourly rate and an estimated monthly cost for each tier. You can also multiply the hourly rate by 730 for a full-month estimate. | ||
|
|
||
| **Usage-based projects:** monitor the accrued cost shown in the Cloud UI over the first few days and extrapolate. Costs scale with search volume and document count, so factor in expected traffic growth. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| title: Backups | ||
| description: Meilisearch Cloud automatically backs up your project data on a weekly schedule, with customizable options for Enterprise customers. | ||
| --- | ||
|
|
||
| Meilisearch Cloud automatically backs up your project data. Backups protect against accidental data loss and allow you to restore a project to a previous state. | ||
|
|
||
| ## Default backup schedule | ||
|
|
||
| | Setting | Default | | ||
| |---------|---------| | ||
| | Frequency | Once per week | | ||
| | Backups retained | 2 (the two most recent) | | ||
| | Scheduled day | Based on the day the project was created | | ||
|
|
||
| The backup window is automatically set when you create a project. Older backups are discarded as new ones are created, so only the two most recent backups are kept at any time. | ||
|
|
||
| ## Restoring from a backup | ||
|
|
||
| To restore your project from a backup, contact [support@meilisearch.com](mailto:support@meilisearch.com) with your project name and the date you want to restore to. | ||
|
|
||
| ## Enterprise backup customization | ||
|
|
||
| Enterprise customers can fully customize their backup configuration: | ||
|
|
||
| - **Frequency**: daily, multiple times per day, or any custom schedule | ||
| - **Retention**: keep more than 2 backups | ||
| - **Timing**: choose the exact time backups run to avoid peak traffic periods | ||
|
|
||
| Contact [sales@meilisearch.com](mailto:sales@meilisearch.com) to configure a custom backup policy for your project. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| --- | ||
| title: Create a project | ||
| description: Create a new Meilisearch Cloud project from the dashboard in a few steps. | ||
| --- | ||
|
|
||
| {/* Screenshots needed on this page: | ||
| 1. The project dashboard after successful creation (API keys, search preview) | ||
| */} | ||
|
|
||
| A project is an isolated Meilisearch instance. Creating one takes two steps: choose a plan type, then configure the project. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - A Meilisearch Cloud account. [Sign up at cloud.meilisearch.com](https://cloud.meilisearch.com) if you do not have one. | ||
|
|
||
| ## Step 1: Click "New project" | ||
|
|
||
| From the [Cloud dashboard](https://cloud.meilisearch.com), click the **New project** button. | ||
|
|
||
| <Frame> | ||
| <img src="/assets/images/platform/infrastructure/new_project_button.png" alt="Meilisearch Cloud projects list with the New project button" /> | ||
| </Frame> | ||
|
|
||
| ## Step 2: Choose a plan type | ||
|
|
||
| You will be asked to choose between two billing models: | ||
|
|
||
| | Plan type | Description | | ||
| |-----------|-------------| | ||
| | **Resource-Based** | Select compute and storage to match your performance needs. You pay a fixed hourly rate for the resources you provision. | | ||
| | **Usage-Based** | Pay as you go. Costs adjust automatically based on your actual searches and documents. | | ||
|
|
||
| See [Resource-based vs usage-based](/capabilities/platform/infrastructure/overview#resource-based-vs-usage-based-projects) for guidance on which to choose. | ||
|
|
||
| <Frame> | ||
| <img src="/assets/images/platform/infrastructure/plan_type_selection.png" alt="Create project modal showing Resource-Based and Usage-Based plan type options" /> | ||
| </Frame> | ||
|
|
||
| ## Step 3: Configure the project | ||
|
|
||
| Both plan types share three common fields: | ||
|
|
||
| | Field | Description | | ||
| |-------|-------------| | ||
| | **Project name** | Between 3 and 40 characters. | | ||
| | **Region** | The region where your project is hosted. Cannot be changed after creation. See [Regions](/capabilities/platform/infrastructure/regions). | | ||
| | **Meilisearch version** | The version to deploy. Defaults to the latest stable release. | | ||
|
|
||
| ### Resource-Based configuration | ||
|
|
||
| Select a resource tier (Memory and vCPU). The Cloud UI shows the hourly cost and estimated monthly cost for the selected tier. See [resource-based pricing](/capabilities/platform/billing/pricing_model#resource-based-pricing) for more details. | ||
|
|
||
| <Frame> | ||
| <img src="/assets/images/platform/infrastructure/resource_based_config.png" alt="Configure resource-based project form showing memory, vCPU, and hourly cost breakdown" /> | ||
| </Frame> | ||
|
|
||
| ### Usage-Based configuration | ||
|
|
||
| Select a plan: | ||
|
|
||
| | Plan | Included searches | Included documents | Resources | Support | | ||
| |------|------------------|--------------------|-----------|---------| | ||
| | **Build** | 50K/month, then $0.40 per 1,000 | 100K, then $0.30 per 1,000 | Shared | Community (Discord) | | ||
| | **Pro** | 250K/month, then $0.30 per 1,000 | 1M, then $0.20 per 1,000 | Dedicated | Meilisearch team | | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. pro to be removed |
||
|
|
||
| See [usage-based pricing](/capabilities/platform/billing/pricing_model#usage-based-pricing) for more details. | ||
|
|
||
| <Frame> | ||
| <img src="/assets/images/platform/infrastructure/usage_based_config.png" alt="Configure usage-based project form showing Build and Pro plan options with pricing details" /> | ||
| </Frame> | ||
|
|
||
| ## Step 4: Create the project | ||
|
|
||
| Click **Create project**. Meilisearch Cloud provisions the instance. The project appears in your dashboard with a **creating** status while it is being provisioned, then becomes available in a few seconds. | ||
|
|
||
| <Frame> | ||
| <img src="/assets/images/platform/infrastructure/project_creating.png" alt="Meilisearch Cloud projects list showing a project with creating status" /> | ||
| </Frame> | ||
|
|
||
| ## Next steps | ||
|
|
||
| - [Add documents](/getting_started/first_project) using your project's API URL and admin key | ||
| - [Manage resources](/capabilities/platform/infrastructure/manage_resources) to scale as your data grows | ||
| - [Invite team members](/capabilities/platform/teams/overview) to collaborate on the project | ||
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.
Team settings is organisation now. Not critical but diffrent