Немного дольше, немного дешевле · Экономия 28% за 6 месяцев или 50% за год, единым платежом Смотрите тарифы ↗

Планирование сервиса · 5 мин чтения

Дайте вашей общей вики полный небольшой план.

Общая вики требует большего, чем просто место для страниц. Назначьте ответственного, составьте карту зависимостей, определите небольшую модель прав и проверку восстановления, включая вложения. Этот рабочий лист поможет группе решить, что она готова поддерживать.

Перед началом

  • Список людей, которые будут читать, редактировать и администрировать вики.
  • Документация для выбранной вами вики и её предполагаемой версии.
  • Место для операционных заметок и отдельное контролируемое место для учётных данных восстановления.

1. Опишите задачу, которую будет выполнять вики.

Начните с одного предложения: «Участники используют эту вики, чтобы найти актуальные инструкции по работе нашей общей мастерской». Эта гипотетическая цель уже, чем «выложить всё в интернет». Она предполагает управляемый первый набор: процедуры открытия, заметки об оборудовании и решения встреч. Личные контактные данные и учётные данные доступа требуют отдельных решений; удобное поле поиска — не причина их собирать.

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

2. Создайте одну страницу для зависимостей.

Используйте этот пример как начальную карту, затем замените каждое предположение структурой выбранного приложения. «Ответственный» — это тот, кто может объяснить и восстановить этот компонент, не обязательно тот, кто его установил.

ЧастьЧто должно быть в записной книжкеВопрос восстановления
Веб-приложениеВерсия, расположение конфигурации и ответственный за сервисМожет ли другой сопровождающий пересобрать ту же версию?
База данныхДвижок, версия и метод резервного копированияКакой снимок соответствует этим файлам?
Изображения и вложенияПути хранения и оценка ростаОткрывается ли схема на восстановленной странице?
DNS и HTTPSВладелец доменной учётной записи и метод работы с сертификатомКто может восстановить доступ без вики?
Электронная почта и запланированные задачиОтправитель, расписание и ответственный за сбоиЧто продолжает работать при сбое доставки?

Запишите также поиск: является ли он частью приложения, пересобираемым индексом или отдельным сервисом? Не считайте, что индекс можно отбросить, пока документация приложения не подтвердит, как его пересобрать.

3. Разделите чтение, редактирование и администрирование.

В примере с мастерской участники читают процедуры, небольшая группа редакторов их изменяет, а два уполномоченных сопровождающих управляют учётными записями. Администрирование хостинга — отдельная обязанность. Запишите, кто может публиковать страницу, загружать файлы, экспортировать контент и менять разрешения. Решите, как увольняющийся участник теряет доступ и кто проверяет поддерживаемые им страницы.

Правила разрешений приложения могут сочетаться неожиданным образом. BookStack, например, объединяет возможности ролей пользователя и поддерживает переопределения на уровне контента; разрешения полки не каскадируются автоматически на её книги. Проверяйте фактический результат с обычными учётными записями участников, а не только с административной. Роли и разрешения BookStack.

4. Храните набор для восстановления в одном месте.

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

В качестве конкретного примера приложения: руководство BookStack по резервному копированию охватывает записи базы данных, конфигурацию, загруженные изображения, вложения и темы. Его конфигурация включает ключ, относящийся к зашифрованным данным приложения, поэтому копирование только видимых страниц упускает важный материал для восстановления. Следуйте собственной процедуре приложения для вашей версии. Резервное копирование и восстановление BookStack.

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

5. Согласуйте процедуру, которую группа сможет соблюдать.

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

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

6. Проверьте полезный путь, затем зафиксируйте пробелы.

На отдельной тестовой копии попросите второго сопровождающего найти образец страницы, открыть её вложение, внести разрешённое изменение и попробовать действие, которое его учётной записи не должно быть разрешено. Проверьте результат поиска после изменения контента. Запишите ожидаемые и наблюдаемые результаты; один успешный вход не доказывает, что вики удобна или правильно ограничена.

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

7. Оставьте путь для выхода.

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

Ваш готовый план должен помещаться рядом с инвентаризацией сервисов, а не заменять его. Продолжите с папкой портируемого экспорта и учебным восстановлением. Цель — вики, которую другой уполномоченный человек сможет понять и восстановить; это руководство не устанавливает никаких приложений.

Документация к этому примечанию

Используйте документацию для версии, которую вы фактически запускаете. Эти примеры — материал для планирования, а не запись теста на Hoszen VPS.