Компонент Storage Service

Storage Service - обеспечивает функционирование хранилища резервных копий: запись, чтение и получение информации о резервных копиях.

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

Подсказка

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

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

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

Команда	Описание
storage-service init keys	Запуск генерации пары криптографических ключей (приватного и публичного), необходимых для защитного преобразования учетных данных для подключения к хранилищам DDBoost
storage-service init ddboost-creds	Выполнение инициализации локального хранилища секретов c учетными данными необходимыми для подключения к хранилищам DDBoost
storage-service init ddboost-creds check	Выполняет проверку возможности чтения из локального хранилища секретов

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

storage-service init keys

Описание:

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

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

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

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

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

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

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

Синтаксис:

storage-service init keys [flags]

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

Нет.

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

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

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

Важно

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

storage-service init ddboost-creds

Описание:

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

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

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

Важно

• Перед выполнением команды убедитесь, что параметр ddboost.enc_creds_path конфигурационного файла storage-service.yaml заполнен.
• Если выполняется Добавление хранилищ DDBoost без остановки Storage Service (S2) и для имеющихся хранилищ DDBoost уже используется локальное хранилище секретов, то перед выполнением storage-service init ddboost-creds не требуется предварительно запускать storage-service init keys.

Синтаксис:

storage-service init ddboost-creds [flags]

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

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

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

  echo '{"creds": [{"address": "ip_adress_1", "username": "user_example_1", "password": "password_example_1"}, {"address": "ip_adress_2", "username": "user_example_2", "password": "password_example_2"}]}' | storage-service init ddboost-creds

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

  storage-service init ddboost-creds --file ddboost.creds.json

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

  {
    "creds": [
      {
        "address": "<ip_address_1>",
        "username": "<user_example_1>",
        "password": "<password_example_1>"
      },
      {
        "address": "<ip_address_2>",
        "username": "<user_example_2>",
        "password": "<password_example_2>"
      }
      // ...
    ]
  }

  Важно

  • Значение поля address для каждого хранилища должно совпадать со значением параметра ddboost.storages.address из файла storage-service.yaml для соответствующего хранилища.
  • При добавлении учетных данных для новых хранилищ передайте полный список учетных данных: как для уже зарегистрированных, так и для новых хранилищ. Это правило действует как при использовании флага --file, так и при передаче данных через стандартный ввод.

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

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

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

storage-service init ddboost-creds check

Описание:

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

Синтаксис:

storage-service init ddboost-creds check [flags]

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

Нет.

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

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

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