Утилита резервного копирования copywala-vdb

copywala-vdb - утилита командной строки для резервного копирования и восстановления данных векторной СУБД Vector DB.

Список консольных команд

Подсказка

Для всех команд доступны флаги:

• -h|--help – показать справку по команде;
• -c|--config <path to copywala-vdb config> – по умолчанию используется /etc/pbr/copywala-vdb.yaml.

Для перехода к информации о команде нажмите на ее описание в таблице.

Команда	Описание
copywala-vdb help	Справка по командам утилиты copywala-vdb
copywala-vdb version	Вывод версии установленной утилиты copywala-vdb
copywala-vdb completion	Генерация скрипта для автодополнения команд утилиты copywala-vdb
copywala-vdb config set	Изменение конфигурационного файла компонента Copywala VDB
copywala-vdb config show	Просмотр параметров конфигурационного файла компонента Copywala VDB
copywala-vdb create-backup	Создание резервной копии в ручном режиме
copywala-vdb cwl info <path to cwl archive>	Просмотр информации о CWL-архиве
copywala-vdb cwl verify <path to cwl archive>	Валидация контрольных сумм файлов в CWL-архиве
copywala-vdb db info	Вывод информации об экземпляре БД
copywala-vdb healthcheck	Проверка работоспособности
copywala-vdb init <name>	Выполнение инициализации утилиты copywala-vdb
copywala-vdb init keys	Запуск генерации пары криптографических ключей (приватного и публичного), необходимых для защитного преобразования учетных данных
copywala-vdb init creds vdb	Выполнение инициализации локального хранилища секретов, содержащего учетные данные для подключения к Vector DB
copywala-vdb init creds ddboost	Выполнение инициализации локального хранилища секретов c учетными данными необходимыми для подключения к хранилищам DDBoost
copywala-vdb init creds check	Выполняет проверку возможности чтения из локального хранилища секретов
copywala-vdb restore <backup-uri>	Распаковка CWL-архива со снепшот-файлами в заданную директорию
copywala-vdb upload-snapshot	Загрузка снепшота в Vector DB
copywala-vdb storage backups <instance-name>	Вывод списка резервных копий из хранилища
copywala-vdb storage instances <name-prefix>	Вывод списка с именами экземпляров баз данных, доступных в хранилище

Описание команд

copywala-vdb help

Описание:

Выводит справку по всем командам утилиты copywala-vdb или по определенной команде, если в параметрах указано имя команды.

Синтаксис:

copywala-vdb help [command] [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

• [command] – имя команды, по которой необходимо получить справку.
• [flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml

copywala-vdb version

Описание:

Выводит версию установленной утилиты copywala-vdb.

Синтаксис:

copywala-vdb version [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml

Сценарии использования:

Вывод версии установленной утилиты copywala-vdb.

copywala-vdb completion

Описание:

Генерирует скрипт автодополнения команд утилиты copywala-vdb. Сгенерированный скрипт необходимо сохранить в файл и подключить его в конфигурации командной оболочки.

Синтаксис:

copywala completion <оболочка> [flags]

Обязательные параметры:

<оболочка> – укажите используемую командную оболочку:

• bash
• fish
• powershell
• zsh

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml

copywala-vdb config set

Описание:

Изменяет значение параметра restore_instance_name (уникальное имя экземпляра агента для восстановления), расположенного в конфигурационном файле copywala-vdb.yaml.

Синтаксис:

copywala-vdb config set [flags]

Обязательные параметры:

Флаг	Описание
-n|--restore-instance-name <instance-name>	Задает уникальное имя экземпляра агента для восстановления данных. Если параметр instance_name уже указан в файле copywala-vdb.yaml, его значение будет заменено на указанное в команде. Если параметр отсутствует, он будет добавлен в copywala-vdb.yaml с переданным значением.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml

Сценарии использования:

Изменение конфигурационного файла компонента Copywala VDB.

copywala-vdb config show

Описание:

Выводит параметры конфигурационного файла copywala-vdb.yaml, расположенного в /etc/pbr/copywala-vdb.yaml (если в параметрах команды явно не указан другой файл).

Синтаксис:

copywala-vdb config show [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml

Сценарии использования:

Просмотр параметров конфигурационного файла компонента Copywala VDB.

copywala-vdb create-backup

Описание:

Запуск создания резервной копии в ручном режиме.

Синтаксис:

copywala-vdb create-backup [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml

Сценарии использования:

Создание резервной копии вручную.

copywala-vdb cwl info

Описание:

Выводит информацию о CWL-архиве.

Синтаксис:

copywala-vdb cwl info <path to cwl archive> [flags]

Обязательные параметры:

<path to cwl archive> – путь к CWL-архиву резервной копии о котором необходимо посмотреть информацию.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml

Сценарии использования:

Просмотр информации о CWL-архиве.

copywala-vdb cwl verify

Описание:

Выполняет проверку целостности резервной копии, анализируя структуру архива, контрольные суммы файлов и метаданных, включая заголовок и служебные блоки.

Синтаксис:

copywala-vdb cwl verify  <path to cwl archive> [flags]

Обязательные параметры:

<path to cwl archive> – путь к CWL-архиву резервной копии для которого необходимо выполнить проверку.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml
--max-allowed-failures <failures num>	Максимально допустимое количество ошибок при проверке, после превышения которого операция будет прервана. По умолчанию используется значение -1, это означает, что проверка выполняется полностью, без досрочного завершения независимо от числа ошибок

Сценарии использования:

Валидация контрольных сумм файлов в CWL-архиве.

copywala-vdb db info

Описание:

Выводит информацию об экземпляре базы данных, к которому подключена утилита copywala-vdb. По умолчанию информация выводится в YAML-формате (если в параметрах команды не указан флаг --json).

Синтаксис:

copywala-vdb db info [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml
--json	Вывод информации в JSON-формате

Сценарии использования:

Вывод информации об экземпляре БД.

copywala-vdb healthcheck

Описание:

Запускает проверку работоспособности утилиты copywala-vdb.

Синтаксис:

copywala-vdb healthcheck [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml

Сценарии использования:

Проверка работоспособности Copywala VDB.

copywala-vdb init

Описание:

Запускает процесс инициализации утилиты copywala-vdb.

Синтаксис:

copywala-vdb init <agent_name> [flags]

Обязательные параметры:

<agent_name> – уникальное имя агента.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml

Сценарии использования:

Инициализация copywala-vdb.

copywala-vdb init keys

Описание:

Запускает генерацию пары криптографических ключей (приватного и публичного), необходимых для защитного преобразования учетных данных.

В результате выполнения будет сгенерирована пара ключей:

• приватный – /var/pbr/copywala/priv.key;
• публичный – /var/pbr/copywala/priv.key.pub.

Ключи защитного преобразования хранятся локально в зашифрованном виде и используются только внутренними механизмами copywala-vdb.

Путь к приватному ключу настраивается в конфигурационном файле copywala-vdb.yaml параметром:

app:
  creds_private_key_path: /var/pbr/copywala/priv.key # значение по умолчанию

Публичный ключ с постфиксом .pub будет сохранен в той же директории, что и приватный.

Синтаксис:

copywala-vdb init keys [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml
--force	Принудительная замена существующего файла с ключом (повторная генерация), если он уже существует

Важно

При принудительной повторной генерации (--force) необходимо повторно инициализировать локальное хранилище copywala-vdb init creds vdb также с флагом --force.

Сценарии использования:

Включение использования локального хранилища секретов для подключения к Vector DB.

copywala-vdb init creds vdb

Описание:

Выполнение инициализации локального хранилища секретов, содержащего учетные данные для подключения к Vector DB. Выполнение команды возможно только после запуска copywala-vdb init keys, так как над файлом, который создается командой copywala-vdb init creds vdb, выполняется защитное преобразование с использованием ранее сгенерированного приватного ключа.

В результате выполнения будет создан файл /var/pbr/copywala/vdb.creds, содержащий данные, прошедшие защитное преобразование.

Путь для хранения данного файла настраивается в конфигурационном файле copywala-vdb.yaml параметром:

vdb:
  use_enc_creds: true    
  enc_creds_path: /var/pbr/copywala/vdb.creds

При включении use_enc_creds учетные данные для доступа к Vector DB загружаются из файла, расположенного по пути enc_creds_path.

Синтаксис:

copywala-vdb init creds vdb [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml
--force	Принудительная замена существующего файла с учетными данными
--file <path to file>	Загрузка секретов из json-файла

Способы передачи учетных данных:

• Передача через стандартный ввод. Пример:

  echo '{"username": "user_example", "password": "password_example"}' | copywala-vdb init creds vdb

• Передача через файл с помощью флага --file:

  copywala-vdb init creds vdb --file vdb.creds.json

  Файл должен быть в формате JSON и обязательно содержать поля username и password:

  {
    "username": "<user_example>",
    "password": "<password_example>"
  }

Сценарии использования:

Включение использования локального хранилища секретов для подключения к Vector DB

copywala-vdb init creds ddboost

Описание:

Выполнение инициализации локального хранилища секретов c учетными данными для подключения к хранилищам DDBoost. Выполнение команды возможно только после запуска copywala-vdb init keys, так как над файлом, который создается командой copywala-vdb init creds ddboost, выполняется защитное преобразование с использованием ранее сгенерированного приватного ключа.

В результате будет создан зашифрованный файл с учетными данными по пути, указанному в параметре ddboost.enc_creds_path конфигурационного файла copywala-vdb.yaml (пример значения):

ddboost:
  enc_creds_path: /var/pbr/copywala/ddboost.creds

Важно

Перед выполнением команды убедитесь, что в copywala-vdb.yaml задано значение для параметра ddboost.enc_creds_path.

Синтаксис:

copywala-vdb init creds ddboost [flags]

Обязательные параметры:

Нет.

В команде должны быть переданы учетные данные одним из способов:

• Передача через стандартный ввод. Пример:

  echo '{"username": "user_example", "password": "password_example"}' | copywala-vdb init creds ddboost

• Передача через файл с помощью флага --file:

  copywala-vdb init creds ddboost --file ddboost.creds.json

  Файл должен быть в формате JSON и обязательно содержать поля username и password:

  {
    "username": "<user_example>",
    "password": "<password_example>"
  }

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml
--force	Принудительная замена существующего файла с учетными данными
--file <path to file>	Загрузка секретов из json-файла

copywala-vdb init creds check

Описание:

Запускает проверку возможности чтения из локального хранилища секретов. В результате выполнения команды отображается загруженное из хранилища имя пользователя.

Синтаксис:

copywala-vdb init creds check [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml
--force	Данный флаг не применим к этой команде
--file <path to file>	Проверка секретов из json-файла

Сценарии использования:

Включение использования локального хранилища секретов для подключения к Vector DB.

copywala-vdb restore

Описание:

Распаковка CWL-архива со снепшот-файлами в заданную директорию.

Синтаксис:

copywala-vdb restore <archive uri or path> [flags]

Обязательные параметры:

<archive uri or path> – путь к CWL-архиву со снепшотом / снепшотами из которых требуется восстановить данные.

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml
--destination <path_to_destination>	Путь к директории, в которую необходимо произвести восстановление. Если данный флаг не задан, архив со снепшотами будет распакован в директорию, указанную в конфигурационном файле copywala.yaml параметре restore_data_path
--cpuprofile <path_to_file>	Включает сбор профиля использования CPU и сохраняет результаты в указанный файл (<path to file>) для последующего анализа производительности

Сценарии использования:

Восстановление данных из резервной копии.

copywala-vdb storage backups

Описание:

Выводит список существующих резервных копий текущего экземпляра или другого необходимого экземпляра.

Синтаксис:

copywala-vdb storage backups <instance-name> [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

• [instance-name] – уникальное имя агента.

• [flags] – доступны следующие флаги:

  Флаг	Описание
  -h|--help	Показать справку по команде
  -c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml
  -u|--destination-uri <path to backups>	Путь до хранилища резервных копий. Если параметр не указан, используется значение из конфигурационного файла copywala-vdb.yaml параметр backup_destination_uri

Сценарии использования:

Вывод списка резервных копий из хранилища.

copywala-vdb storage instances

Описание:

Выводит список с именами экземпляров баз данных, для которых имеются резервные копии в хранилище.

Синтаксис:

copywala-vdb storage instances <name-prefix> [flags]

Обязательные параметры:

Нет.

Опциональные параметры:

• <name-prefix> – префикс имени экземпляра, используемый для фильтрации списка: выводятся только те экземпляры, имена которых начинаются с указанного значения.

• [flags] – доступны следующие флаги:

  Флаг	Описание
  -h|--help	Показать справку по команде
  -c|--config <path to copywala-vdb config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml

Сценарии использования:

Вывод списка с именами экземпляров баз данных, доступных в хранилище.

copywala-vdb upload-snapshot

Описание:

Загрузка определенного снепшот-файла в Vector DB.

Синтаксис:

copywala-vdb upload-snapshot [flags]

Обязательные параметры:

Флаг	Описание
-m|--checksum <path_to_checksum>	Путь к файлу c контрольной суммой снепшота
-n|--collection <collection_name>	Имя коллекции в БД. Требуется для указания, в какую коллекцию будет загружен снепшот
-s|--snapshot <path_to_snapshot>	Путь к снепшот-файлу, который необходимо загрузить

Опциональные параметры:

[flags] – доступны следующие флаги:

Флаг	Описание
-h|--help	Показать справку по команде
-c|--config <path_to_copywala-vdb_config>	Использовать конфигурационный файл, отличный от файла по умолчанию: /etc/pbr/copywala-vdb.yaml
--cpuprofile <path_to_file>	Включает сбор профиля использования CPU и сохраняет результаты в указанный файл (<path to file>) для последующего анализа производительности

Сценарии использования:

Загрузка снепшота в Vector DB.