Management on Vchord

Overview of the cloud object hierarchy

Mon, 01 Jan 0001 00:00:00 +0000

Managing your VectorChord Cloud project requires an understanding of the object hierarchy. The following diagram shows how objects in cloud are related. See below for a description of each object.

VectorChord Cloud Account

This is the account you used to sign up with VectorChord Cloud. Now supports signing up with an GitHub account.

Projects

A project is the top-level object in the hierarchy. It is a container for all clusters in the project and billing information. For more information, see Projects.

Projects

Mon, 01 Jan 0001 00:00:00 +0000

With VectorChord Cloud, everything starts with the project. It is the top-level object in the hierarchy. A project can hold as many Postgres clusters as needed. The maximum number of projects you can create and join is 5.

Learn more about projects and how to manage them in these sections:

Project Setting

In project setting, you can view and edit the project information. You can switch to another project by clicking the project name in the bottom left corner of the page. The default project is the first project we created for you when you signed up. In below diagram, you can change the name, invite members to the project, and leave the project.

Clusters

Mon, 01 Jan 0001 00:00:00 +0000

One or more clusters can be created in a project. A cluster is a collection of nodes that run a Postgres cluster.

Create a cluster

To create a new cluster, navigate to the VectorChord Cloud Console and click on the “Create Cluster” button.

You need to specify the following information:

Required:
- Plan: The plan you want to use for your cluster, for information about Cloud’s paid plan options, see Cloud plans.
- Cluster Name: A unique name for your cluster.
- Extension Settings:
  - Extension: We support two Vector Search extensions, pgvectors and its successor vectorchord
    - vectorchord: Scalable, Fast, and Disk-friendly Vector search in Postgres
    - pgvectors: Scalable, Low-latency and Hybrid-enabled Vector Search in Postgres. Revolutionize Vector Search, not Database.
    Warning
    
    The vectorchord only support server resource with NVMe SSD.
  - Image:
    - VectorChord, we provide a tag in a semantic version format, for example 16-v0.1.0:
      - 16 indicates the version number of Postgres major
      - v0.1.0 indicates VectorChord version number
    - pgvecto.rs, we provide a tag in a semantic version format, for example 16-v0.4.0-vectors-exts:
      - 16 indicates the version number of Postgres major
      - v0.4.0 indicates pgvecto.rs version number
      - vectors indicates the installation location of pgvecto.rs scheme, optional vectors,extensions, public. Please choose public if you want to use VectorChord Cloud on AWS RDS. If you’re going to use fdw on Supabase, please choose extensions.
      - exts indicates the cluster can install extensions from https://pgt.dev/.
- Cloud Provider Settings:
  - Cloud Provider: The cloud provider where your cluster will be deployed, currently only AWS is supported.
  - Region: The region where your cluster will be deployed.
- Resource Settings:
  - Type: We provide two types of resources, Performance and Capacity.
  - Server Resource:
    - Performance:
      - 1C/2G: Free tier, 1 core CPU, 2GB memory and 3Gi disk space.
      - 2C/8G: Enterprise tier, 2 core CPU, 8GB memory and 15Gi disk space.
      - 2C/16G: Enterprise tier, 2 core CPU, 16GB memory and 15Gi disk space.
      - 4C/32G: Enterprise tier, 4 core CPU, 32GB memory and 90Gi disk space.
    - Capacity:
      - 4C/32G NVMe SSD: Enterprise tier, 4 core CPU, 32GB memory and 850Gi NVMe SSD disk space.
- Postgres Settings:
  - Database Name: The name of the database that you will store vector data in.
  - Enable Connection Pooler: (default: false): Enable the connection pooler for your cluster.
  - Enable Restore Config: (default: false): Enable the restore config for your backup created in other clusters.
  - Optional:
    - Disk Size: Postgres PGData disk size, will change the default disk size.
    - Instances: The number of instances in the cluster. The default is 1.
    Warning
    
    Currently, vector index not support streaming replication.

Authorization

Mon, 01 Jan 0001 00:00:00 +0000

Topics related to role-based access control (RBAC) on your VectorChord Cloud clusters.

User Roles

We provide two types of roles for the project: Owner and Member.

Owner: The owner has full access to the project. The owner can invite members, create or delete clusters, and view the billing information.
Member: The member has read-only access to the project. The member can view the cluster information, but cannot create or delete clusters.

API Key Roles

API Key provide more fine-grained control over access to resources by assigning roles with specific permissions to users within the projects. We provide two types of roles for the API Key: Owner and Member.

Backup & Restore

Mon, 01 Jan 0001 00:00:00 +0000

Database backups are an integral part of any disaster recovery plan. Disasters come in many shapes and sizes. It could be as simple as accidentally deleting a table column, the database crashing, or even a natural calamity wiping out the underlying hardware a database is running on. The risks and impact brought by these scenarios can never be fully eliminated, but only minimized or even mitigated. Having database backups is a form of insurance policy. They are essentially snapshots of the database at various points in time. When disaster strikes, database backups allow the project to be brought back to any of these points in time, therefore averting the crisis.

Upgrade

Mon, 01 Jan 0001 00:00:00 +0000

You may need to upgrade your cluster and do not want to lose any data. You can upgrade the server resource like CPU, memory. Or you only want to upgrade the storage. The following sections will guide you through the process of upgrading your cluster.

Increasing server resource

If you want to increase the server resource like CPU and memory, the status of the cluster need to be Ready. And click the Upgrade button in the cluster detail page.

API Keys

Mon, 01 Jan 0001 00:00:00 +0000

On VectorChord Cloud, every project comes with a set of API keys. These keys are essential authentication tokens required for initiating terraform operations.

Role-based Access Control (RBAC)

Role-based Access Control (RBAC) is a crucial security mechanism in VectorChord Cloud, applicable to managing API calls. This system allows for fine-grained control over access to resources by assigning roles with specific permissions to users within the projects.

Terraform Integration Overview with VectorChord Cloud

Mon, 01 Jan 0001 00:00:00 +0000

This guide walks you through the process of installing and configuring the PGVecto.rs Cloud provider.

1. Prerequisites

Before you begin, ensure you have the following:

Terraform Installed: Download and install Terraform from here by following the provided instructions.
VectorChord Cloud Account: Access to VectorChord Cloud and your API Key are essential. Go to the VectorChord Cloud Console and create an API key. The API key must have the ProjectOwner permissions. For more information, see API Key.

Regions

Mon, 01 Jan 0001 00:00:00 +0000

Deploying to Regions

With VectorChord Cloud, you can deploy clusters to different Regions. When creating an cluster, pick a Region using the drop-down selector.

Tip

Don’t see the Region or Provider that you want? Please contact us at Discord, we are happy to help.

Workflow

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Workflow is a feature that allow you can use some pre-defined functions to complete some tasks. For example, you can use ExternalBuildIndex workflow to build index externally for your Postgres cluster. There are some advantages of using workflow:

Out Of Box: You can use the pre-defined functions to complete some tasks without writing any code.
Accelerate Tasks: You can use a server with a higher resource configuration than the PostgreSQL cluster to accelerate the task.
Cluster Stability: The workflow is executed in a separate server, which will not affect the stability of the PostgreSQL cluster.
Low Cost: You do not need to pay continuously like a database for high configuration resources for short-term tasks.

Supported Workflows

Supported workflows are as follows: