Skip to content
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
5 changes: 0 additions & 5 deletions docs/cloud/manage-clusters/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,6 @@ description: "Configure authentication options for Weaviate Cloud clusters by ad
image: og/wcd/user_guides.jpg
---

import WCDAPIKeys from "/docs/cloud/img/wcs-api-keys.jpg";
import WCDAddAPIKeys from "/docs/cloud/img/wcs-add-key-details.jpg";
import WCDDelAPIKeys from "/docs/cloud/img/wcs-delete-api-key.jpg";
import RestartTheCluster from "/_includes/wcs/restart-warning.mdx";

[Weaviate Cloud (WCD)](/go/console?utm_content=cloud) uses [RBAC (Role-Based Access Control)](/weaviate/configuration/rbac/index.mdx) to manage authentication. Below, you can find guides on how to create, edit, rotate and delete API keys for accessing Weaviate Cloud.

### Create an API key
Expand Down
8 changes: 0 additions & 8 deletions docs/cloud/manage-clusters/authorization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,6 @@ description: "Role-Based Access Control (RBAC) configuration guide for Weaviate
image: og/wcd/user_guides.jpg
---

import Link from "@docusaurus/Link";
import WCDCreateRole from "/docs/cloud/img/weaviate-cloud-roles-create.png";
import WCDCreateRoleForm from "/docs/cloud/img/weaviate-cloud-roles-create-form.png";
import WCDEditRole from "/docs/cloud/img/weaviate-cloud-roles-edit.png";
import WCDEditRoleForm from "/docs/cloud/img/weaviate-cloud-roles-edit-form.png";
import WCDDeleteRole from "/docs/cloud/img/weaviate-cloud-roles-delete.png";
import WCDDeleteRoleForm from "/docs/cloud/img/weaviate-cloud-roles-delete-form.png";

[Weaviate Cloud (WCD)](/go/console?utm_content=cloud) uses [RBAC (Role-Based Access Control)](/weaviate/configuration/rbac/index.mdx) to manage authorization. Below, you can find guides on how to create, edit and delete user roles and manage their permissions.

## Create a role
Expand Down
6 changes: 2 additions & 4 deletions docs/cloud/manage-clusters/connect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: "Multiple connection options and methods for accessing your Weaviat
image: og/wcd/user_guides.jpg
---

import CompareURLs from "/docs/cloud/img/wcs-console-url-check.jpg";

[Weaviate Cloud (WCD)](/go/console?utm_content=cloud) offers multiple options on how to connect to your cluster:

- **[Connect with APIs](#connect-with-an-api-programmatically)**:
Expand Down Expand Up @@ -147,7 +145,7 @@ This section has solutions for some common problems. For additional help, [conta
To reset your Weaviate Cloud password, follow these steps:

1. Go to the Weaviate Cloud [login page](/go/console?utm_content=cloud).
1. Click on click the login button.
1. Click the login button.
1. Click `Forgot Password`.
1. Check your email account for a password reset email from Weaviate Cloud.
1. Click the link and follow the instructions to reset your password. The link is only valid for five minutes.
Expand Down Expand Up @@ -195,7 +193,7 @@ weaviate.exceptions.WeaviateGRPCUnavailableError: gRPC health check could not be

**Solution**: Verify the cluster URL is correct and update the URL if needed.

When a Shared Cloud cluster is updated, the cluster URL may change slightly. Weaviate Cloud still routes the old URL, so some connections work, however the new gRPC and the old HTTP URLS are different so connections that require gRCP fail.
When a Shared Cloud cluster is updated, the cluster URL may change slightly. Weaviate Cloud still routes the old URL, so some connections work, however the new gRPC and the old HTTP URLs are different so connections that require gRPC fail.

To check the URLs, open the Weaviate Cloud Console and check the details panel for your cluster. If you prefix Cluster URL with `grpc-`, the Cluster URL and the Cluster gRPC URL should match. Compare the Cluster URL with the connection URL in your application. The old URL and the new URL are similar, but the new one may have an extra subdomain such as `.c0.region`. If the URLs are different, update your application's connection code to use the new Cluster URL.

Expand Down
9 changes: 9 additions & 0 deletions docs/cloud/manage-clusters/default-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import AdvancedOptions from "/docs/cloud/img/weaviate-cloud-cluster-advanced-set
| [`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) | Yes (<span class="callout">1</span>) |
| [`DEFAULT_VECTOR_INDEX`](/deploy/configuration/env-vars/index.md#DEFAULT_VECTOR_INDEX) | No | Set by the cluster's [optimization profile](/cloud/manage-clusters/create#optimization-profile) | Yes (via the optimization profile) |
| `CORS_ALLOW_ORIGIN` | Yes | https://console.weaviate.cloud | Yes (to allow any) (<span class="callout">3</span>) |
| [`REPLICATION_MINIMUM_FACTOR`](/deploy/configuration/env-vars/index.md#REPLICATION_MINIMUM_FACTOR) | Yes | 3 (for HA clusters) | No |

Expand All @@ -37,6 +38,14 @@ import AdvancedOptions from "/docs/cloud/img/weaviate-cloud-cluster-advanced-set
</div>
<br />

:::note Default vector index and the optimization profile

`DEFAULT_VECTOR_INDEX` is not set directly. It is determined by the [optimization profile](/cloud/manage-clusters/create#optimization-profile) you pick when you create the cluster: the `Cost Optimized` profile makes HFresh the default vector index, and the `Performance Optimized` profile makes HNSW the default. Free clusters support the `Cost Optimized` profile only.

The profile only sets the default for new collections. An explicit vector index in a [collection definition](/weaviate/manage-collections/vector-config) always takes precedence.

:::

## User management & permissions

These settings control authentication and authorization for your cluster. These settings are not user configurable.
Expand Down
4 changes: 1 addition & 3 deletions docs/cloud/platform/create-account.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ description: "How to create and delete user accounts in the Weaviate Cloud conso
image: og/wcd/user_guides.jpg
---

import LandingRegister from "/docs/cloud/img/wcs-landing-page-register.jpg";

Weaviate Cloud (WCD) offers an interactive console. Create a user account, then login to manage WCD clusters, run queries, and configure your organization details.

## Create a new user account and sign in {#create-a-new-user-account}
Expand Down Expand Up @@ -57,7 +55,7 @@ To delete your account from Weaviate Cloud (WCD):

1. Remove organization members: If you own an organization, you must remove all other members from it first.
2. Navigate to the [Account Page](https://console.weaviate.cloud/account).
4. In the **Danger Zone** section, click **Delete Account** to permanently remove your account.
3. In the **Danger Zone** section, click **Delete Account** to permanently remove your account.

If you encounter any issues, please contact our [Weaviate Support](https://support.weaviate.io).

Expand Down
5 changes: 1 addition & 4 deletions docs/cloud/platform/multi-factor-auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ description: "Enhanced security setup with multi-factor authentication for Weavi
image: og/wcd/user_guides.jpg
---

import MFAOneTime from "/docs/cloud/img/mfa-one-time-code.jpg";
import MFAEnableIcon from "/docs/cloud/img/mfa-enable-icon.jpg";

Multi-factor authentication (MFA) increases the security of browser logins. MFA is not enabled by default.

## Enable multi-factor authentication
Expand Down Expand Up @@ -85,7 +82,7 @@ To disable MFA, [contact support](https://support.weaviate.io).

If you use a JavaScript/TypeScript client to connect a browser hosted application to Weaviate, do not enable MFA for that client's account.

There is no way to pass the the one-time authentication code to the application, so the application cannot connect to Weaviate Cloud.
There is no way to pass the one-time authentication code to the application, so the application cannot connect to Weaviate Cloud.

Use API keys to connect browser based client applications to Weaviate Cloud.

Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/platform/users-and-organizations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Organizations group user accounts together. An organization owns its clusters an
- Organization management
- Billing configuration

Be cautious when granting elevated roles (`Owner`, `Admin`) in production — those users can modify the organization, its clusters, and its billing.
Be cautious when granting elevated roles (`Owner`, `Admin`) in production. Those users can modify the organization, its clusters, and its billing.

## Manage organizations {#manage-organizations}

Expand Down
23 changes: 9 additions & 14 deletions docs/cloud/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ image: og/docs/quickstart-tutorial.jpg
# tags: ['getting started']
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<span class="badge badge--secondary">Expected time: 30 minutes</span>
<br />
<br />
Expand Down Expand Up @@ -254,20 +251,18 @@ import QueryNearText from "/_includes/code/quickstart/quickstart.query.neartext.
Run this code to perform the query. Our query found entries for `DNA` and `species`.

<details>
<summary>Example full response in JSON format</summary>
<summary>Example response</summary>

```json
{
{
"answer": "DNA",
"question": "In 1953 Watson & Crick built a model of the molecular structure of this, the gene-carrying substance",
"category": "SCIENCE"
},
{
"answer": "species",
"question": "2000 news: the Gunnison sage grouse isn't just another northern sage grouse, but a new one of this classification",
"category": "SCIENCE"
}
"answer": "DNA",
"question": "In 1953 Watson & Crick built a model of the molecular structure of this, the gene-carrying substance",
"category": "SCIENCE"
}
{
Comment on lines +261 to +262
"answer": "species",
"question": "2000 news: the Gunnison sage grouse isn't just another northern sage grouse, but a new one of this classification",
"category": "SCIENCE"
}
```

Expand Down
4 changes: 2 additions & 2 deletions docs/cloud/tools/collections-tool.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -292,10 +292,10 @@ Some collection settings that are not available in the console can be updated pr
<summary>Enable TTL step by step</summary>

1. Open the [Weaviate Cloud console](/go/console?utm_content=cloud).
2. Select you organization and cluster in the left sidebar.
2. Select your organization and cluster in the left sidebar.
3. Open the `Collections` tool from the left sidebar and select the collection you want to modify.
4. Click the pencil icon next to the Time to live (TTL) field.
5. Select you desired [TTL settings](/weaviate/manage-collections/time-to-live.mdx) and save them.
5. Select your desired [TTL settings](/weaviate/manage-collections/time-to-live.mdx) and save them.

</details>

Expand Down
Loading