From da3ef01182fe49c753f64ae94d7effa2eda22dc9 Mon Sep 17 00:00:00 2001 From: JP Hwang Date: Mon, 29 Dec 2025 17:14:58 +0000 Subject: [PATCH 1/6] init --- .../manage-clusters/default-settings.mdx | 73 +++++++++++++++++++ sidebars.js | 5 ++ 2 files changed, 78 insertions(+) create mode 100644 docs/cloud/manage-clusters/default-settings.mdx diff --git a/docs/cloud/manage-clusters/default-settings.mdx b/docs/cloud/manage-clusters/default-settings.mdx new file mode 100644 index 00000000..87c070e7 --- /dev/null +++ b/docs/cloud/manage-clusters/default-settings.mdx @@ -0,0 +1,73 @@ +--- +title: Default cluster settings +sidebar_position: 7 +description: "Default configuration settings for Weaviate Cloud clusters" +image: og/wcd/user_guides.jpg +--- + +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. + +## Weaviate Database settings + +These settings control core database functionality and limits. + +| Setting | Requires restart | Default value | User configurable | +| --- | --- | --- | --- | +| `MAXIMUM_ALLOWED_COLLECTIONS_COUNT` | No | 1000 | No | +| `AUTOSCHEMA_ENABLED` | No | true | Yes | +| `ASYNC_REPLICATION_DISABLED` | No | false | No | +| `ASYNC_INDEXING` | Yes | true | No | +| `DEFAULT_QUANTIZATION` | No | RQ-8 | No | +| `CORS_ALLOW_ORIGIN` | Yes | https://console.weaviate.cloud | Yes | + +### Key settings + +- **MAXIMUM_ALLOWED_COLLECTIONS_COUNT**: Sets the maximum number of collections that can be created in your cluster. +- **AUTOSCHEMA_ENABLED**: When enabled, Weaviate automatically infers and creates schema definitions from incoming data. +- **ASYNC_REPLICATION_DISABLED**: Controls whether asynchronous replication is disabled for multi-node clusters. +- **ASYNC_INDEXING**: Enables asynchronous indexing for improved write performance. +- **DEFAULT_QUANTIZATION**: Sets the default quantization method (RQ-8 - Random Quantization with 8 bits). +- **CORS_ALLOW_ORIGIN**: Specifies allowed origins for Cross-Origin Resource Sharing (CORS). + +## User management & permissions + +These settings control authentication and authorization for your cluster. + +| Setting | Configuration Type | Default value | Configurable | +| --- | --- | --- | --- | +| `AUTHORIZATION_RBAC_ENABLED` | Static (Configmap) | true | No | +| `AUTHENTICATION_DB_USERS_ENABLED` | Static (ENV) | true | No | +| `AUTHORIZATION_ADMINLIST_ENABLED` | Static (Configmap) | false | No | +| `AUTHENTICATION_OIDC_CLIENT_ID` | Static (Configmap) / Runtime | Descope client ID | No | +| `AUTHENTICATION_OIDC_ENABLED` | Static (Configmap) / Runtime | true | No | +| `AUTHENTICATION_OIDC_GROUPS_CLAIM` | Static (Configmap) / Runtime | roles | No | +| `AUTHENTICATION_OIDC_ISSUER` | Static (Configmap) / Runtime | Descope issuer | No | +| `AUTHENTICATION_OIDC_USERNAME_CLAIM` | Static (Configmap) / Runtime | email | No | +| `AUTHENTICATION_OIDC_SKIP_CLIENT_ID_CHECK` | Static (Configmap) / Runtime | false | No | +| `root_groups` | Static (Configmap) | \-admin, access-customer-data | No | +| `root_users` | Static (Configmap) | wcs-team+wcs-cluster-management@weaviate.io | No | + +:::info Root users setting +The `root_users` setting will be deprecated in a future release following the Descope migration. +::: + +### Authentication overview + +Weaviate Cloud clusters use a combination of: +- **RBAC (Role-Based Access Control)**: Enabled by default for fine-grained access control +- **Database users**: Local user authentication +- **OIDC (OpenID Connect)**: Integration with Descope for identity management + +For more information on authentication and authorization, see: +- [Authentication](/cloud/manage-clusters/authentication) +- [Authorization](/cloud/manage-clusters/authorization) + +## Backups + +Each Weaviate Cloud instance is automatically backed up by default. + +## Support & feedback + +import SupportAndTrouble from "/_includes/wcs/support-and-troubleshoot.mdx"; + + diff --git a/sidebars.js b/sidebars.js index 239ab4ff..ae0d72be 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1421,6 +1421,11 @@ const sidebars = { id: "cloud/manage-clusters/authorization", className: "sidebar-item", }, + { + type: "doc", + id: "cloud/manage-clusters/default-settings", + className: "sidebar-item", + }, ], }, { From 406fde2232020ffee92ee300298ef801070e1042 Mon Sep 17 00:00:00 2001 From: JP Hwang Date: Mon, 29 Dec 2025 17:22:08 +0000 Subject: [PATCH 2/6] edits --- .../manage-clusters/default-settings.mdx | 44 ++++--------------- 1 file changed, 9 insertions(+), 35 deletions(-) diff --git a/docs/cloud/manage-clusters/default-settings.mdx b/docs/cloud/manage-clusters/default-settings.mdx index 87c070e7..84661912 100644 --- a/docs/cloud/manage-clusters/default-settings.mdx +++ b/docs/cloud/manage-clusters/default-settings.mdx @@ -7,6 +7,8 @@ image: og/wcd/user_guides.jpg 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. +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. + ## Weaviate Database settings These settings control core database functionality and limits. @@ -18,45 +20,17 @@ These settings control core database functionality and limits. | `ASYNC_REPLICATION_DISABLED` | No | false | No | | `ASYNC_INDEXING` | Yes | true | No | | `DEFAULT_QUANTIZATION` | No | RQ-8 | No | -| `CORS_ALLOW_ORIGIN` | Yes | https://console.weaviate.cloud | Yes | - -### Key settings - -- **MAXIMUM_ALLOWED_COLLECTIONS_COUNT**: Sets the maximum number of collections that can be created in your cluster. -- **AUTOSCHEMA_ENABLED**: When enabled, Weaviate automatically infers and creates schema definitions from incoming data. -- **ASYNC_REPLICATION_DISABLED**: Controls whether asynchronous replication is disabled for multi-node clusters. -- **ASYNC_INDEXING**: Enables asynchronous indexing for improved write performance. -- **DEFAULT_QUANTIZATION**: Sets the default quantization method (RQ-8 - Random Quantization with 8 bits). -- **CORS_ALLOW_ORIGIN**: Specifies allowed origins for Cross-Origin Resource Sharing (CORS). +| `CORS_ALLOW_ORIGIN` | Yes | https://console.weaviate.cloud | Yes (to allow any) | ## User management & permissions -These settings control authentication and authorization for your cluster. - -| Setting | Configuration Type | Default value | Configurable | -| --- | --- | --- | --- | -| `AUTHORIZATION_RBAC_ENABLED` | Static (Configmap) | true | No | -| `AUTHENTICATION_DB_USERS_ENABLED` | Static (ENV) | true | No | -| `AUTHORIZATION_ADMINLIST_ENABLED` | Static (Configmap) | false | No | -| `AUTHENTICATION_OIDC_CLIENT_ID` | Static (Configmap) / Runtime | Descope client ID | No | -| `AUTHENTICATION_OIDC_ENABLED` | Static (Configmap) / Runtime | true | No | -| `AUTHENTICATION_OIDC_GROUPS_CLAIM` | Static (Configmap) / Runtime | roles | No | -| `AUTHENTICATION_OIDC_ISSUER` | Static (Configmap) / Runtime | Descope issuer | No | -| `AUTHENTICATION_OIDC_USERNAME_CLAIM` | Static (Configmap) / Runtime | email | No | -| `AUTHENTICATION_OIDC_SKIP_CLIENT_ID_CHECK` | Static (Configmap) / Runtime | false | No | -| `root_groups` | Static (Configmap) | \-admin, access-customer-data | No | -| `root_users` | Static (Configmap) | wcs-team+wcs-cluster-management@weaviate.io | No | - -:::info Root users setting -The `root_users` setting will be deprecated in a future release following the Descope migration. -::: - -### Authentication overview +These settings control authentication and authorization for your cluster. These settings are not user configurable. -Weaviate Cloud clusters use a combination of: -- **RBAC (Role-Based Access Control)**: Enabled by default for fine-grained access control -- **Database users**: Local user authentication -- **OIDC (OpenID Connect)**: Integration with Descope for identity management +| Setting | Default value | +| --- | --- | +| `AUTHORIZATION_RBAC_ENABLED` | true | +| `AUTHENTICATION_DB_USERS_ENABLED` | true | +| `AUTHENTICATION_OIDC_ENABLED` | true | For more information on authentication and authorization, see: - [Authentication](/cloud/manage-clusters/authentication) From 3eb13ceac66ff03664604cbd34f60910c85893c2 Mon Sep 17 00:00:00 2001 From: JP Hwang Date: Mon, 29 Dec 2025 17:35:16 +0000 Subject: [PATCH 3/6] Add default settings page for WCD --- docs/cloud/manage-clusters/default-settings.mdx | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/cloud/manage-clusters/default-settings.mdx b/docs/cloud/manage-clusters/default-settings.mdx index 84661912..d202d56c 100644 --- a/docs/cloud/manage-clusters/default-settings.mdx +++ b/docs/cloud/manage-clusters/default-settings.mdx @@ -38,7 +38,22 @@ For more information on authentication and authorization, see: ## Backups -Each Weaviate Cloud instance is automatically backed up by default. +Each Weaviate Cloud instance is automatically backed up by default. To restore a backup, [contact Weaviate Cloud support](https://console.weaviate.cloud/support). + +## Query settings + +These settings control default query behavior. + +| Setting | Default value | +| --- | --- | +| `QUERY_DEFAULTS_LIMIT` | 10 | +| `QUERY_MAXIMUM_RESULTS` | 100000 | + +## Modules + +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. + +To view the list of enabled modules on your cluster, see [Cluster Status: Enabled Modules](/cloud/manage-clusters/status#enabled-modules). ## Support & feedback From bf181576a31efe33fbf649d91eb9a326fe31fabc Mon Sep 17 00:00:00 2001 From: JP Hwang Date: Tue, 30 Dec 2025 09:20:02 +0000 Subject: [PATCH 4/6] Update notes --- docs/cloud/manage-clusters/default-settings.mdx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/cloud/manage-clusters/default-settings.mdx b/docs/cloud/manage-clusters/default-settings.mdx index d202d56c..3fd3589e 100644 --- a/docs/cloud/manage-clusters/default-settings.mdx +++ b/docs/cloud/manage-clusters/default-settings.mdx @@ -38,7 +38,11 @@ For more information on authentication and authorization, see: ## Backups -Each Weaviate Cloud instance is automatically backed up by default. To restore a backup, [contact Weaviate Cloud support](https://console.weaviate.cloud/support). +Each Weaviate Cloud instance is automatically backed up by default. Additional backups can be triggered manually via the API. + +Backups are retained per the applicable backup retention period of that cluster, such as 7 days for Shared Cloud clusters. All (manual and scheduled) backups are deleted according to the relevant's cloud provider's lifecycle policy (e.g. 90 days). + +To restore a backup, [contact Weaviate Cloud support](https://console.weaviate.cloud/support). ## Query settings From d1d7d94346fc978a19bf3e3e88fe3ae780da3410 Mon Sep 17 00:00:00 2001 From: JP Hwang Date: Tue, 30 Dec 2025 10:08:30 +0000 Subject: [PATCH 5/6] Updates per Paul feedback --- docs/cloud/manage-clusters/default-settings.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/cloud/manage-clusters/default-settings.mdx b/docs/cloud/manage-clusters/default-settings.mdx index 3fd3589e..c21d7dd6 100644 --- a/docs/cloud/manage-clusters/default-settings.mdx +++ b/docs/cloud/manage-clusters/default-settings.mdx @@ -38,9 +38,9 @@ For more information on authentication and authorization, see: ## Backups -Each Weaviate Cloud instance is automatically backed up by default. Additional backups can be triggered manually via the API. +Each Weaviate Cloud instance is automatically backed up daily by default. Additional backups can be triggered manually via the API. -Backups are retained per the applicable backup retention period of that cluster, such as 7 days for Shared Cloud clusters. All (manual and scheduled) backups are deleted according to the relevant's cloud provider's lifecycle policy (e.g. 90 days). +Backups are retained per the applicable backup retention period of that cluster, such as 7 days for Flex Shared Cloud clusters. To restore a backup, [contact Weaviate Cloud support](https://console.weaviate.cloud/support). From 918e02566a307f443b25ff4d18ad159d2a0c712d Mon Sep 17 00:00:00 2001 From: Ivan Despot <66276597+g-despot@users.noreply.github.com> Date: Fri, 9 Jan 2026 07:47:01 +0100 Subject: [PATCH 6/6] Add links to env vars --- .../manage-clusters/default-settings.mdx | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/cloud/manage-clusters/default-settings.mdx b/docs/cloud/manage-clusters/default-settings.mdx index c21d7dd6..9d17fdb3 100644 --- a/docs/cloud/manage-clusters/default-settings.mdx +++ b/docs/cloud/manage-clusters/default-settings.mdx @@ -1,7 +1,7 @@ --- title: Default cluster settings sidebar_position: 7 -description: "Default configuration settings for Weaviate Cloud clusters" +description: "Default configuration settings for Weaviate Cloud clusters." image: og/wcd/user_guides.jpg --- @@ -15,11 +15,11 @@ These settings control core database functionality and limits. | Setting | Requires restart | Default value | User configurable | | --- | --- | --- | --- | -| `MAXIMUM_ALLOWED_COLLECTIONS_COUNT` | No | 1000 | No | -| `AUTOSCHEMA_ENABLED` | No | true | Yes | -| `ASYNC_REPLICATION_DISABLED` | No | false | No | -| `ASYNC_INDEXING` | Yes | true | No | -| `DEFAULT_QUANTIZATION` | No | RQ-8 | No | +| [`MAXIMUM_ALLOWED_COLLECTIONS_COUNT`](/deploy/configuration/env-vars/index.md#MAXIMUM_ALLOWED_COLLECTIONS_COUNT) | No | 1000 | No | +| [`AUTOSCHEMA_ENABLED`](/deploy/configuration/env-vars/index.md#AUTOSCHEMA_ENABLED) | No | true | Yes | +| [`ASYNC_REPLICATION_DISABLED`](/deploy/configuration/env-vars/index.md#ASYNC_REPLICATION_DISABLED) | No | false | No | +| [`ASYNC_INDEXING`](/deploy/configuration/env-vars/index.md#ASYNC_INDEXING) | Yes | true | No | +| [`DEFAULT_QUANTIZATION`](/deploy/configuration/env-vars/index.md#DEFAULT_QUANTIZATION) | No | [RQ-8](/weaviate/configuration/compression/rq-compression.md) | No | | `CORS_ALLOW_ORIGIN` | Yes | https://console.weaviate.cloud | Yes (to allow any) | ## User management & permissions @@ -28,9 +28,9 @@ These settings control authentication and authorization for your cluster. These | Setting | Default value | | --- | --- | -| `AUTHORIZATION_RBAC_ENABLED` | true | -| `AUTHENTICATION_DB_USERS_ENABLED` | true | -| `AUTHENTICATION_OIDC_ENABLED` | true | +| [`AUTHORIZATION_RBAC_ENABLED`](/deploy/configuration/env-vars/index.md#AUTHORIZATION_RBAC_ENABLED) | true | +| [`AUTHENTICATION_DB_USERS_ENABLED`](/deploy/configuration/env-vars/index.md#AUTHENTICATION_DB_USERS_ENABLED) | true | +| [`AUTHENTICATION_OIDC_ENABLED`](/deploy/configuration/env-vars/index.md#AUTHENTICATION_OIDC_ENABLED) | true | For more information on authentication and authorization, see: - [Authentication](/cloud/manage-clusters/authentication) @@ -50,8 +50,8 @@ These settings control default query behavior. | Setting | Default value | | --- | --- | -| `QUERY_DEFAULTS_LIMIT` | 10 | -| `QUERY_MAXIMUM_RESULTS` | 100000 | +| [`QUERY_DEFAULTS_LIMIT`](/deploy/configuration/env-vars/index.md#QUERY_DEFAULTS_LIMIT) | 10 | +| [`QUERY_MAXIMUM_RESULTS`](/deploy/configuration/env-vars/index.md#QUERY_MAXIMUM_RESULTS) | 100000 | ## Modules