Лучший способ документировать процедуру настройки / внесенные изменения

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

Существует ли какой-либо универсальный подход (пакет), в котором редактор (vim) автоматически отслеживает сделанные изменения и в лучшем случае объединяет их с историей? Так что в итоге у меня есть хорошая документация. Если crontab -e и т. д. будет включено, было бы здорово.

2 ответа

Для этого я написал плагин writebackup. Это превратилось в полный набор плагинов:

  • Плагин writebackupVersionControl дополняет этот скрипт дополнительными командами и расширяет :WriteBackup Команда с большим количеством проверок, но не обязательна.
  • Плагин writebackupToAdjacentDir реализует конфигурацию WriteBackup-dynamic-backupdir, которая помещает файлы резервных копий в соседний каталог резервных копий, если таковой существует. Это помогает, когда резервные копии не могут быть помещены в один и тот же каталог.
  • Плагин writebackupAutomator автоматически записывает резервную копию при первой записи в день файла, который был заархивирован в прошлом, но еще не сегодня. Это может быть ваша сеть безопасности, когда вы забудете сделать резервную копию.

Итак, после создания резервной копии мне не нужно думать о ее явном запуске. Я могу просматривать различия и даже восстанавливать предыдущие версии. Конечно, если вы можете использовать "полную" систему контроля версий (например, Git или Subversion), используйте это. Но этот хорош для всех небольших изменений конфигурации, распределенных по файловой системе.

Другой (хороший) подход - иметь (центральный, на сервер) журнал установки / конфигурации, который вы ведете вручную. writebackup все еще может помочь вам получить разницу, так что вы можете вставить это в журнал.

etckeeper - хороший способ достичь этого. На самом деле он отслеживает не все сделанные изменения, а все, что находится в / etc, что составляет большинство файлов конфигурации. Больше информации здесь:https://ubuntu.com/server/docs/tools-etckeeper

Другие вопросы по тегам