Hcl-get usage

Описание

hcl-get это программа-клиент для сервиса по сбору данных проб оборудования пользователей дистрибутивов ALT Linux, которая позволяет как осуществить загрузку своих данных на сервер, так и получить данные от сервера по запросу (данные об оборудовании и данные, загруженные самими пользователями — комментарии к их данным об оборудовании/софте).

Пакеты rpm для установки и srpm с исходным кодом для сборки

Пакеты актуальных версий клиента hcl-get, а также подробные инструкции по их установке (нужно установить два пакета) располагается на форуме в теме, которая посвящена разработке и клиента и сервиса.

Рекомендуемая к использованию минимальная версия hcl-get — 0.3.99.37, которая должна работать и на системах, базирующихся на бранче p5.1/младше, также возможна работа на более старых бранчах, но должно быть обеспечено наличие в системе пакета system-report версии не ниже 0.0.6. Владельцам p8/сизифа следует иметь ввиду ошибку altbug #32222.

Использование клиента hcl-get для сервиса по сбору проб оборудования

Отправка пробы на сервер

Предположим, что созрело решение поделиться своими данными об оборудовании с другими пользователями сервиса. Для этого надо дать команду

hcl-get -r

если на машине, с которой отправляются данные, имеется доступ в cеть Интернет, при этом собранные данные будут сразу отправлены на сервер. Если такового доступа по какой-либо причине на машине нет, то и это не беда — можно подготовить необходимые для отправки данные командой

hcl-get -p

которая создаст два файла:

1. Зашифрованный .gpg файл для отправки с другой машины. Это можно сделать двумя способами:

• в браузере через форму загрузки файлов на странице сервиса
• если полученный файл .pgp предварительно скопировать на другую машину, где есть Интернет, в ~/.hcl-get/gpg (создать каталог, если он не существует), то командой

hcl-get -r имя.gpg

если файл .pgp располагается по другому пути, то командой

hcl-get -r /полный/путь/до/файла.gpg

При выполнении команд hcl-get -r и hcl-get -p будет запрошен пароль root, после чего несколько утилит в фоновом режиме соберут всю необходимую информацию.

2. Архив .tar.(xz|bz2|gz) может быть скопирован на любую другую машину, с которой будет удобнее добавлять/удалять комментарий к пробе, в каталог ~/.hcl-get. Без этого файла добавление/удаление комментария невозможно. Если вы не планируете оставлять комментарий к своей пробе оборудования или не хотите использовать никакие другие возможности сервиса кроме отправки своих данных об оборудовании, то данный файл можно просто удалить.

При любом из способов отправки:

Если отправка данных прошла без ошибок, то сервис сообщит:

• либо об успешной загрузке данных и выдаст номер, который присвоен загруженной пробе оборудования, при этом архив с пробой будет сохранён в ~/.hcl-get/номер-пробы.tar.(xz/bz2/gz);
• либо об ошибке, если имеют место быть несоответствия отправляемых данных требованиям сервиса;
• либо о том, что данные отправляемой пробы уже имеются в базе.

После выдачи номера успешно загруженной пробе может пройти до 3 минут прежде, чем обработанная информация об этой пробе будет доступна для обзора. Это связано с тем, что процесс обработки загружаемых данных происходит независимо от процессов загрузки данных или добавления комментариев.

Получение информации о пробе

После того, как данные добавлены на сервер и им присвоен номер, можно обратиться за содержимым этих данных командой

hcl-get -gr номер

где номер - числовой код присвоенный пробе сервисом. Данные пробы вместе с комментарием (если он добавлен), можно получить командой

hcl-get -g номер

Проверка проб на наличие в базе сервера

Может случиться так, что часть проб-архивов может быть произвольным образом переименована и в их названиях (hcl-get сохраняет успешно отправленные данные в архив ~/.hcl-get/номер.tar.(xz/bz2/gz)) будут отсутствовать числовые номера проб либо они будут в названии, но могут не соответствовать их нумерации на сервисе. В этом случае можно проверить, был ли загружен некоторый архив на сервис (и у него есть номер) либо нет:

• в простейшем случае для этого можно вызвать диалоговый режим

hcl-get -t

• если требуется проверить файл, расположенный в ~/.hcl-get, то это можно сделать командой

hcl-get -r имя.tar.(xz/bz2/gz)

• если файл с пробой располагается по другому пути, то команда для этого будет

hcl-get -r /полный/путь/имя.tar.(xz/bz2/gz)

Работа с комментариями

Теперь, когда проба оборудования успешно загружена на сервер (дожидаться обработки данных пробы прежде, чем добавлять комментарий, вовсе необязательно: если проба была успешно загружена на сервер и ей был присвоен номер, то комментарий можно добавлять сразу же после этого события), хотелось бы написать несколько строк о работоспособности имеющегося оборудования. Другими словами, мы хотим прокомментировать сухой язык статистики, которым составлены отчёты о нашем оборудовании.

Пишем либо мысленно набрасываем сам комментарий на тему отправленных ранее данных, с учётом следующих условий (использование любого текстового редактора на выбор и применяемого форматирования не являются частью условий):

• длина комментария в данный момент ограничена пятью килобайтами (на мой взгляд, этого вполне достаточно, но этот лимит может быть пересмотрен)
• кодировка комментария может быть либо utf-8 либо ascii и это должен быть обычный текстовый файл (но не .doc и т.п.) с произвольным расширением (например, это может быть и .log файл) либо вообще без расширения
• для удобства манипулирования комментарием, если вы хотите отправлять его файлом, лучше всего комментарий сохранить в файл ~/.hcl-get/номер.txt, где номер соответствует номеру комментируемой пробы, но можно сохранить файл и в любое другое место, главное при этом помнить полный путь до файла с комментарием

Если комментарий не планируется слишком большим и вполне умещается на одной строке (в рамках разумного), то всё вышеперечисленное можно пропустить и перейти к отправке. В простейшем случае, чтобы отправить комментарий достаточно запустить диалоговый режим добавления комментария к пробе оборудования

 hcl-get -c

Можно несколько конкретизировать запрос, например, указав номер пробы и комментарий в одной строке

 hcl-get -c номер комментарий

или файл комментария, располагающийся в домашней директории ~/.hcl-get и имеющий имя с расширением

 hcl-get -c имя.расширение

в последнем случае и в случае, описанном чуть ниже, будет выдан список найденных в директории ~/.hcl-get проб и запрошено на выбор:

• номер строки, которая содержит информацию о нужном файле пробы из всего списка обнаруженных в ~/.hcl-get
• имя архива с расширением, если файлом пробы является архив из директории ~/.hcl-get либо полный путь к архиву с пробой, если он располагается вне каталога ~/.hcl-get), также данный запрос будет выдан в случае, если не удалось обнаружить проб в ~/.hcl-get

 hcl-get -c /полный/путь/имя.расширение

если файл комментария располагается по пути /полный/путь/имя.расширение.

См. справку по программе для полного представления о возможностях конкретизировать запрос на добавление комментария.

Получение содержимого комментария

После того, как комментарий успешно отправлен, к его содержимому можно обратиться командой

 hcl-get -gc номер

где номер присвоен пробе оборудования сервисом.

Получение содержимого лог файлов

Просмотреть список доступных логов для пробы можно командой

hcl-get -gl номер

где номер присвоен пробе сервисом. Содержимое конкретного лога из списка по команде выше можно получить командой

hcl-get -gl номер лог

Поиск

Если в базе присутствуют данные, которые кто-либо загружал, то можно выполнить поиск по базе, который не чувствителен к регистру. Поиск можно выполнять по следующим категориям данных:

• поиск среди данных проб

hcl-get -qr что_ищем

• поиск среди комментариев

hcl-get -qc что_ищем

• поиск среди данных проб и комментариев

hcl-get -q что_ищем

Статистика сервиса

Количество загруженных на сервис проб и количество добавленных комментариев можно узнать, выполнив команду

hcl-get -a

Получить количество добавленных комментариев

hcl-get -ac

Получить количество загруженных проб

hcl-get -ar