Skip to content

Commit 7d98568

Browse files
authored
Merge pull request #313 from weaviate/feat/wcd-default-settings-page
Feat/wcd default settings page
2 parents cecf07b + 918e025 commit 7d98568

File tree

2 files changed

+71
-0
lines changed

2 files changed

+71
-0
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Default cluster settings
3+
sidebar_position: 7
4+
description: "Default configuration settings for Weaviate Cloud clusters."
5+
image: og/wcd/user_guides.jpg
6+
---
7+
8+
This page describes the default configuration settings applied to Weaviate Cloud clusters. These settings control various aspects of your cluster's behavior, including database limits, authentication, backups, and usage metrics.
9+
10+
The majority of these settings are configured via environment variables. For more details on each environment variable, refer to the [environment variable pages](/deploy/configuration/env-vars) in the [Deployment section](/deploy) of our documentation.
11+
12+
## Weaviate Database settings
13+
14+
These settings control core database functionality and limits.
15+
16+
| Setting | Requires restart | Default value | User configurable |
17+
| --- | --- | --- | --- |
18+
| [`MAXIMUM_ALLOWED_COLLECTIONS_COUNT`](/deploy/configuration/env-vars/index.md#MAXIMUM_ALLOWED_COLLECTIONS_COUNT) | No | 1000 | No |
19+
| [`AUTOSCHEMA_ENABLED`](/deploy/configuration/env-vars/index.md#AUTOSCHEMA_ENABLED) | No | true | Yes |
20+
| [`ASYNC_REPLICATION_DISABLED`](/deploy/configuration/env-vars/index.md#ASYNC_REPLICATION_DISABLED) | No | false | No |
21+
| [`ASYNC_INDEXING`](/deploy/configuration/env-vars/index.md#ASYNC_INDEXING) | Yes | true | No |
22+
| [`DEFAULT_QUANTIZATION`](/deploy/configuration/env-vars/index.md#DEFAULT_QUANTIZATION) | No | [RQ-8](/weaviate/configuration/compression/rq-compression.md) | No |
23+
| `CORS_ALLOW_ORIGIN` | Yes | https://console.weaviate.cloud | Yes (to allow any) |
24+
25+
## User management & permissions
26+
27+
These settings control authentication and authorization for your cluster. These settings are not user configurable.
28+
29+
| Setting | Default value |
30+
| --- | --- |
31+
| [`AUTHORIZATION_RBAC_ENABLED`](/deploy/configuration/env-vars/index.md#AUTHORIZATION_RBAC_ENABLED) | true |
32+
| [`AUTHENTICATION_DB_USERS_ENABLED`](/deploy/configuration/env-vars/index.md#AUTHENTICATION_DB_USERS_ENABLED) | true |
33+
| [`AUTHENTICATION_OIDC_ENABLED`](/deploy/configuration/env-vars/index.md#AUTHENTICATION_OIDC_ENABLED) | true |
34+
35+
For more information on authentication and authorization, see:
36+
- [Authentication](/cloud/manage-clusters/authentication)
37+
- [Authorization](/cloud/manage-clusters/authorization)
38+
39+
## Backups
40+
41+
Each Weaviate Cloud instance is automatically backed up daily by default. Additional backups can be triggered manually via the API.
42+
43+
Backups are retained per the applicable backup retention period of that cluster, such as 7 days for Flex Shared Cloud clusters.
44+
45+
To restore a backup, [contact Weaviate Cloud support](https://console.weaviate.cloud/support).
46+
47+
## Query settings
48+
49+
These settings control default query behavior.
50+
51+
| Setting | Default value |
52+
| --- | --- |
53+
| [`QUERY_DEFAULTS_LIMIT`](/deploy/configuration/env-vars/index.md#QUERY_DEFAULTS_LIMIT) | 10 |
54+
| [`QUERY_MAXIMUM_RESULTS`](/deploy/configuration/env-vars/index.md#QUERY_MAXIMUM_RESULTS) | 100000 |
55+
56+
## Modules
57+
58+
Weaviate Cloud clusters do not have a default vectorizer module configured. As a result, you must specify a vectorizer integration when creating collections, or import your own vectors.
59+
60+
To view the list of enabled modules on your cluster, see [Cluster Status: Enabled Modules](/cloud/manage-clusters/status#enabled-modules).
61+
62+
## Support & feedback
63+
64+
import SupportAndTrouble from "/_includes/wcs/support-and-troubleshoot.mdx";
65+
66+
<SupportAndTrouble />

sidebars.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1421,6 +1421,11 @@ const sidebars = {
14211421
id: "cloud/manage-clusters/authorization",
14221422
className: "sidebar-item",
14231423
},
1424+
{
1425+
type: "doc",
1426+
id: "cloud/manage-clusters/default-settings",
1427+
className: "sidebar-item",
1428+
},
14241429
],
14251430
},
14261431
{

0 commit comments

Comments
 (0)