|
|
@@ -0,0 +1,99 @@
|
|
|
+%META:TOPICINFO{author="roman" comment="reprev" date="1629749716" format="1.1" reprev="1" version="1"}%
|
|
|
+%META:TOPICPARENT{name="ListOfFaq"}%
|
|
|
+---+!! Правила ведения записей в виках
|
|
|
+
|
|
|
+%TOC%
|
|
|
+
|
|
|
+---++ Общие замечания по формату статей
|
|
|
+
|
|
|
+Для удобного поиска и структуризации информации, следует придерживаться нескольких правил:
|
|
|
+ * Никаких Wysiwyg редакторов текста. Только [[System.TopicMarkupLanguage][Markup]] разметка обычным текстом. Иначе ломается поиск данных
|
|
|
+ * Придерживаемся жёсткой стандартизации названия статей, иначе поиск значительно усложняется
|
|
|
+ * Если для какой-то информации есть кнопка создания статьи, статью следует создавать только через эту кнопку
|
|
|
+ * Файлы шаблонов и форм напрямую из вик редактировать крайне осторожно. Можно затереть макросы, которые сработают при открытии статьи
|
|
|
+
|
|
|
+---++ Структура данных в данной инсталляции
|
|
|
+
|
|
|
+| *Filename* | *Description* |
|
|
|
+| Acl[Name] | Список доступа к объекту |
|
|
|
+| Auth[Name] | Пароли доступа |
|
|
|
+| Building[Name] | Здание |
|
|
|
+| Device[Type][Name] | Устройства |
|
|
|
+| Cluster[Name] | Система вирутализации из нескольких серверов |
|
|
|
+| Certificate[Name] | Сертификат домена |
|
|
|
+| Default[Name] | Шаблоны статей |
|
|
|
+| DhcpPool[Name] | Пул dhcp для указанной подсети |
|
|
|
+| DnsZone[Domain] | Зона ДНС |
|
|
|
+| Domain[Domain] | Домен |
|
|
|
+| Equipment[Type][Name] | Комплектующие. Здесь Type - Hdd, Name - SN диска |
|
|
|
+| Faq[Name] | Собственно, статьи справок |
|
|
|
+| Form[Name] | Формы данных для соотвествуующих статей |
|
|
|
+| Gateway[Name] | Шлюзы в интернет |
|
|
|
+| Hardware[Name] | Аппаратная часть сервера |
|
|
|
+| IncludeAdd[Type] | Шаблон добавления статьи указанного типа |
|
|
|
+| IncludeBottom[Type] | Шаблон, добавляемый в конец статьи |
|
|
|
+| IncludeFind[Name] | Шаблон поиска данных привязанных к статье |
|
|
|
+| IncludeHeader[Type] | Шаблон, добавляемый в начало статьи |
|
|
|
+| IncludeList[Name] | Шаблон глобального поиска данных |
|
|
|
+| IncludeSelect[Type] | Шаблон поиска данных в формах |
|
|
|
+| IncludeNetDevCommon | Типовой шаблон для сетевых устройств |
|
|
|
+| IncludeShow[Name] | Дополнительные вставки в некторые статьи |
|
|
|
+| IncludeSnmpPort | Отображение состояния портов по SNMP |
|
|
|
+| ListOf[Name] | Списки чего-то |
|
|
|
+| Man[Name] | Справка для чего-то |
|
|
|
+| Rack[Number][BuildingName] | Стойка в комнате/здании |
|
|
|
+| Room[Name][BuildingName] | Комната в здании |
|
|
|
+| Router[Name] | Маршрутизатор |
|
|
|
+| Server[Name] | Сервер, софтовые настройки |
|
|
|
+| Service[Name][ServerName] | Служба, выполняемая на сервере |
|
|
|
+| Site[Name] | Сайт |
|
|
|
+| Subnet-[Name] | Подсеть |
|
|
|
+| Switch[Name] | Свич |
|
|
|
+| Ups[Name] | УПС |
|
|
|
+| Vlan[Number][RouterName] | Влан, терменируемый указанным роутером |
|
|
|
+| WirelessController[Name] | Контроллер WiFi |
|
|
|
+| WirelessProfile[Name] | Профиль wifi сети |
|
|
|
+
|
|
|
+---+++ Использующиеся типы оборудования
|
|
|
+
|
|
|
+ * AirCond - Кондиционер
|
|
|
+ * AP - Точка доступа
|
|
|
+ * ATS - Цифровая/аналоговая АТС
|
|
|
+ * IPCAM - цифровая видеокамера
|
|
|
+ * Phone - телефон
|
|
|
+ * Printer - принтер
|
|
|
+ * VideoReg - видеорегистратор
|
|
|
+ * VoipGate - телефонный шлюз
|
|
|
+
|
|
|
+Роутеры, свичи, шлюзы, сервера, получили отдельный формат наименования для упрощения выстраивания иерархии подключения оборудования.
|
|
|
+
|
|
|
+---+++ Типы записей для серверов
|
|
|
+
|
|
|
+Сервера имеют три формы для статей:
|
|
|
+ 1 просто сервер
|
|
|
+ 2 виртуальный сервер
|
|
|
+ 3 kvm-host
|
|
|
+Третья запись предназначена для серверов, являющихся гипервизорами системы виртуализации, на которых базируются виртуальные хосты
|
|
|
+
|
|
|
+---+++ Формат названия устройств
|
|
|
+
|
|
|
+Для сетевых устройств, которые могут активно перемещаться в пределах сети в качестве названия используется mac-адрес устройства. К таким устройствам относятся:
|
|
|
+ * принтеры
|
|
|
+ * телефоны
|
|
|
+ * телефонные шлюзы
|
|
|
+
|
|
|
+---++ Редактирование статей
|
|
|
+
|
|
|
+Статья может состоять из двух частей - формы данных и текста. Если нужно редактировать только данные формы, - жать кнопку Edit возле названия формы.
|
|
|
+
|
|
|
+Если нужно редактировать права доступа, текст, данные - жать кнопку Edit справа, вверху страницы.
|
|
|
+
|
|
|
+Для просмотра макросов, шаблонов, реального содержимого статьи - жать кнопку "View wiki text" внизу страницы.
|
|
|
+
|
|
|
+---++ Иерархия записей
|
|
|
+
|
|
|
+Иерархия статей определяется, как правило, двумя вещами - родительской статьей или полем в форме данных. Обычно используется второй вариант, поле имеет название формата - Parent..
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|