Weaviate Cloud Services

     

Overview

Weaviate Cloud Services (WCS) is a managed SaaS service that requires no maintenance at your end. Accordingly, it may be the easiest way to run Weaviate.

WCS can be accessed via the console.

• You can learn more about the console in this guide.
• You can sign up here and create a sandbox instance.

Sandbox expiry

The sandbox is free, but it will expire after 30 days. After this time, all data in the sandbox will be deleted.

If you would like to preserve your sandbox data, you can retrieve your data with our cursor API, or contact us to upgrade to a production SaaS product (in private beta at the time of writing).

Sign in

1. Visit https://console.weaviate.io/
2. Click Sign in with the Weaviate Cloud Services or create an account.
3. After signing in you will be able to create a Weaviate cluster.

Create a cluster

1. Press the "Create a Weaviate Cluster" button.
2. Configure the cluster:
   1. Set a unique name for your cluster – note: The name will become part of the URL used to access this instance.
   2. Select the Subscription Tier.
   3. Choose your Weaviate version (we recommend always using the latest version).
   4. Choose if you want to use authentication.
3. Press Create.

caution

Not all Weaviate modules may be available in WCS environments.

The WCS configuration screen will indicate which modules are available.

Access a cluster

After a while, you cluster will become available on some-endpoint.weaviate.network.

Follow the below guide to test connection to the cluster depending on whether you have enabled authentication or not.

Test connection without authentication

You can test the connection using curl; or with a Weaviate client library.

$ curl https://some-endpoint.weaviate.network/v1/meta

The response should look like the following:

{
    "hostname": "http://[::]:8080",
    "modules": {
        "[MODULE-NAME]": {
            // config values
        }        
        ...  // other modules
    },
    "version": "1.18.2"
}

Test connection with authentication

With authentication enabled, any anonymous requests will yield a 401 response such as below:

{
  "code": 401,
  "message": "anonymous access not enabled, please provide an auth scheme such as OIDC"
}

The easiest way to connect to a WCS instance with authentication is with a Weaviate client library. Please refer to the documentation on WCS authentication for your preferred library in the provided links below:

• Python
• JavaScript
• Go
• Java

However, if you want to test the connection with curl, you can do so in one of two ways:

Test connection to the OIDC endpoint

As a WCS instance is also an OIDC token issuer, its OIDC information endpoint is publicly available.

$ curl https://some-endpoint.weaviate.network/v1/.well-known/openid-configuration

{
  "clientId": "wcs",
  "href": "https://auth.wcs.api.weaviate.io/auth/realms/SeMI/.well-known/openid-configuration"
}

Obtain authentication token manually and pass it on with curl

You can also obtain an authentication token manually as described here, and pass it on.

$ curl -H "Authorization: Bearer {Bearer}" https://some-endpoint.weaviate.network/v1/meta

The response should look like the following:

{
    "hostname": "http://[::]:8080",
    "modules": {
        "[MODULE-NAME]": {
            // config values
        }        
        ...  // other modules
    },
    "version": "1.18.2"
}

More Resources

If you can't find the answer to your question here, please look at the:

1. Frequently Asked Questions. Or,
2. Knowledge base of old issues. Or,
3. For questions: Stackoverflow. Or,
4. For issues: GitHub. Or,
5. Ask your question in the Slack channel: Slack.