From 4882b609dc58f142b9d7169a7eb27f1e47767bcc Mon Sep 17 00:00:00 2001 From: Joseph Cardillo Date: Fri, 14 Nov 2025 13:44:49 -0500 Subject: [PATCH 1/2] initial commit for weaviate documentation --- .../marketplace-docs/guides/weaviate/index.md | 69 +++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 docs/marketplace-docs/guides/weaviate/index.md diff --git a/docs/marketplace-docs/guides/weaviate/index.md b/docs/marketplace-docs/guides/weaviate/index.md new file mode 100644 index 00000000000..96c1178d01d --- /dev/null +++ b/docs/marketplace-docs/guides/weaviate/index.md @@ -0,0 +1,69 @@ +--- +title: "Deploy Weaviate through the Linode Marketplace" +description: "Learn how to deploy Weaviate, an AI-native vector database with GPU-accelerated semantic search capabilities, on an Akamai Compute Instance." +published: 2025-11-14 +keywords: ['vector database','database','weaviate'] +tags: ["marketplace", "linode platform", "cloud manager"] +external_resources: +- '[Weaviate Official Documentation](https://docs.weaviate.io/weaviate)' +aliases: ['/products/tools/marketplace/guides/weaviate/','/guides/weaviate-marketplace-app/'] +authors: ["Akamai"] +contributors: ["Akamai"] +license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)' +marketplace_app_id: 1902904 # Need to update +marketplace_app_name: "Weaviate" +--- + +[Weaviate](https://www.weaviate.io/) is an open-source AI-native vector database designed for building advanced AI applications. It stores and indexes both data objects and their vector embeddings, enabling semantic search, hybrid search, and Retrieval Augmented Generation (RAG) workflows. This deployment includes GPU acceleration for transformer models and comes pre-configured with the sentence-transformers model for high-performance semantic search capabilities. + +## Deploying a Marketplace App + +{{% content "deploy-marketplace-apps-shortguide" %}} + +{{% content "marketplace-verify-standard-shortguide" %}} + +{{< note >}} +**Estimated deployment time:** Weaviate should be fully installed within 5-10 minutes after the Compute Instance has finished provisioning. +{{< /note >}} + +## Configuration Options + +- **Supported distributions**: Ubuntu 24.04 LTS +- **Recommended plan**: All GPU plan types and sizes can be used. + +### Weaviate Options + +{{% content "marketplace-required-limited-user-fields-shortguide" %}} + +{{% content "marketplace-custom-domain-fields-shortguide" %}} + +{{% content "marketplace-special-character-limitations-shortguide" %}} + +## Getting Started after Deployment + +### Obtain Your API Keys + +Weaviate is a database service accessed programmatically through its API, not through a web-based UI. Your deployment includes two API keys stored in a credentials file. + +1. Log in to your Compute Instance via SSH or Lish. See [Connecting to a Remote Server Over SSH](/docs/guides/connect-to-server-over-ssh/) for assistance, or use the [Lish Console](/docs/products/compute/compute-instances/guides/lish/). + +1. Once logged in, retrieve your API keys from the credentials file: + + ```command + cat /home/$USER/.credentials + ``` + + The credentials file contains two API keys: + - **Admin API Key**: Full read/write access to all Weaviate operations + - **User API Key**: Read-only access for querying data + +### Connect Your Application to Weaviate + +To integrate Weaviate into your application, use one of the official client libraries. Weaviate provides native clients for multiple programming languages, allowing you to perform all database operations including creating schemas, importing data, and running vector searches. + +See the [Weaviate Client Libraries documentation](https://docs.weaviate.io/weaviate/client-libraries) for installation instructions and API references. + +For complete examples and advanced usage, refer to the [Weaviate Quickstart Guide](https://docs.weaviate.io/weaviate/quickstart) and the client library documentation for your preferred language. + + +{{% content "marketplace-update-note-shortguide" %}} \ No newline at end of file From 89b488622f5c4642beceedd0b9d529942dcbe571 Mon Sep 17 00:00:00 2001 From: jddocs Date: Fri, 5 Dec 2025 15:17:16 -0500 Subject: [PATCH 2/2] copy edits and dictionary.txt entry --- ci/vale/dictionary.txt | 1 + docs/marketplace-docs/guides/weaviate/index.md | 16 ++++++++-------- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/ci/vale/dictionary.txt b/ci/vale/dictionary.txt index 10ee9a02a4b..7841fa1ba55 100644 --- a/ci/vale/dictionary.txt +++ b/ci/vale/dictionary.txt @@ -2845,6 +2845,7 @@ wazuh wc wchar wchar_t +Weaviate webadmin webalizer webapp diff --git a/docs/marketplace-docs/guides/weaviate/index.md b/docs/marketplace-docs/guides/weaviate/index.md index 96c1178d01d..660676bcba2 100644 --- a/docs/marketplace-docs/guides/weaviate/index.md +++ b/docs/marketplace-docs/guides/weaviate/index.md @@ -1,7 +1,8 @@ --- title: "Deploy Weaviate through the Linode Marketplace" description: "Learn how to deploy Weaviate, an AI-native vector database with GPU-accelerated semantic search capabilities, on an Akamai Compute Instance." -published: 2025-11-14 +published: 2025-12-05 +modified: 2025-12-05 keywords: ['vector database','database','weaviate'] tags: ["marketplace", "linode platform", "cloud manager"] external_resources: @@ -22,8 +23,8 @@ marketplace_app_name: "Weaviate" {{% content "marketplace-verify-standard-shortguide" %}} -{{< note >}} -**Estimated deployment time:** Weaviate should be fully installed within 5-10 minutes after the Compute Instance has finished provisioning. +{{< note title="Estimated deployment time" >}} +Weaviate should be fully installed within 5-10 minutes after your instance has finished provisioning. {{< /note >}} ## Configuration Options @@ -43,14 +44,14 @@ marketplace_app_name: "Weaviate" ### Obtain Your API Keys -Weaviate is a database service accessed programmatically through its API, not through a web-based UI. Your deployment includes two API keys stored in a credentials file. +Weaviate is a database service accessed programmatically through its API rather than through a web-based user interface. Your deployment includes two API keys stored in a credentials file. -1. Log in to your Compute Instance via SSH or Lish. See [Connecting to a Remote Server Over SSH](/docs/guides/connect-to-server-over-ssh/) for assistance, or use the [Lish Console](/docs/products/compute/compute-instances/guides/lish/). +1. Log in to your instance via SSH or Lish. See [Connecting to a Remote Server Over SSH](/docs/guides/connect-to-server-over-ssh/) for assistance, or use the [Lish Console](/docs/products/compute/compute-instances/guides/lish/). -1. Once logged in, retrieve your API keys from the credentials file: +1. Once logged in, retrieve your API keys from the `.credentials` file: ```command - cat /home/$USER/.credentials + sudo cat /home/$USER/.credentials ``` The credentials file contains two API keys: @@ -65,5 +66,4 @@ See the [Weaviate Client Libraries documentation](https://docs.weaviate.io/weavi For complete examples and advanced usage, refer to the [Weaviate Quickstart Guide](https://docs.weaviate.io/weaviate/quickstart) and the client library documentation for your preferred language. - {{% content "marketplace-update-note-shortguide" %}} \ No newline at end of file