:Switch to a custom storage service

Background information

Qoder CN administrators and organization global administrators (for the Qoder CN Enterprise Dedicated Edition) can switch the storage service for the enterprise knowledge base from the built-in Qoder CN storage to a custom storage service in the enterprise management console.

Prerequisites

• Network requirements:

  • If your storage service supports public network access, the Qoder CN Enterprise Dedicated Edition can connect to it directly. For enhanced data security, you can configure an IP address whitelist to control access.

  • If your storage service does not support public network access, you must configure a VPC to enable communication between the Qoder CN Enterprise Dedicated Edition and your storage service. You must also enable Qoder CN reverse access to allow the Enterprise Dedicated Edition to retrieve resources from your storage service.

• Prepare your storage services:

  • Object storage: For more information, see Alibaba Cloud OSS guide.

    Compatible products	Alibaba Cloud OSS, Amazon S3, Tencent Cloud COS, Huawei Cloud OBS, open-source MinIO
    Required permissions	The authorized account must have the following permissions: List objects in a bucket (List): List all objects in the bucket. Read object content (Read): Read the content of objects in the bucket. Upload new objects (Put): Upload new objects to the bucket. Delete objects (Delete): Delete objects from the bucket.
    Storage class	Standard (non-archival)
    Version	All versions are compatible.
    Storage capacity	At least 10 GB (expandable based on usage).

  • Vector database: For more information, see Alibaba Cloud Elasticsearch configuration guide.

    Compatible products	Elasticsearch Enterprise Edition, Elasticsearch open-source edition
    Version	Version 8.15 or later
    Required permissions	The authorized account must have the following permissions: Create index (create_index): Create a new index. If the create index request includes an alias, the manage permission is also required. Write documents (write, create_doc): Perform all write operations on documents, including indexing, updating, deleting, bulk operations, and updating mappings. Read documents (read): Perform read-only operations, such as count, explain, get, mget, scripts, search, and scroll. Delete documents (delete): Delete documents from an index. Privileges for specific operations: The user must have privileges for the create_index, read, delete, and index operations.
    CPU requirements	Minimum: 4-core 8 GB Recommended: 8-core 16 GB Optimal: 16-core 32 GB
    Storage capacity	At least 300 GB (expandable based on usage).
    Configure an IP address whitelist (optional)	We recommend adding the egress IP address of your Qoder CN instance to the IP address whitelist of your Alibaba Cloud Elasticsearch instance. To obtain your instance's egress IP address, submit a ticket.

How it works

The enterprise knowledge base uses two types of storage: an object storage service and a vector database. The object storage service stores uploaded files, such as documents or code packages, while the vector database stores the chunked and vectorized data.

Qoder CN supports migrating both the object storage and vector database services to maximize the security and privacy of your knowledge base. The following diagram provides an overview of the end-to-end process, from migration to usage:

1. Configuration: In the Alibaba Cloud Management Console, a Qoder CN administrator or an enterprise administrator configures public or private network access. They then configure the storage service migration in the Qoder CN enterprise management console.

2. Usage: With the migration settings in effect, after an administrator uploads a knowledge base file, Qoder CN saves the file to your object storage service and the vector data to your vector database.

Procedure

1. Log on to the Alibaba Cloud Management Console and configure network access for Qoder CN Enterprise Dedicated Edition.

   Public network access

   If your storage service supports public network access, you can configure it for the Qoder CN Enterprise Dedicated Edition. You can also add an IP address whitelist to control access for enhanced security.

   Private network access

   If your storage service does not support public network access, configure a VPC to enable communication between it and the Qoder CN Enterprise Dedicated Edition. You also need to enable Qoder CN reverse access to allow the Enterprise Dedicated Edition to retrieve resources from your storage service.

2. Log on to the Qoder CN enterprise management console. On the Knowledge Base page, click Storage Migration.

3. On the Storage Migration page, configure the connection settings for your object storage and vector database. After entering the required information, click Test Connection to verify the connection. If the connection is successful, click Save. A "Migration completed" message confirms that the migration is successful.

   Important

   Important: The new settings take effect immediately upon saving. This action permanently deletes all content from the Qoder CN-provided knowledge base and resets the knowledge base in the Qoder CN enterprise management console to an empty state.

   This action is irreversible from the enterprise management console. To switch back to the built-in Qoder CN storage service, submit a ticket.

4. After the switch is complete, Qoder CN saves any data you upload to the knowledge base to your configured object storage service.

Frequently asked questions

If you cannot upload files to the enterprise knowledge base after switching to your own storage service, it may be due to a connection issue. Go to the Storage Migration page and check if the connection to your storage service is active.