Лучшие практики для хранения / курирования знаний об операциях в организации [закрыто]

Это несколько более широкий вопрос, связанный с темой, с которой, как мне кажется, сталкивается каждая организация / бизнес, когда появляется более одного человека DevOps: как хранить и систематизировать знания об операциях в организации, чтобы они оставались актуальными , легко доступно и полезно новичкам?

Цель этого вопроса - собрать образец решения, из которого люди смогут выбрать. Моя компания / организация (пока) не нашла хорошего способа решения этой проблемы.

Определение: операционные знания - то, что необходимо знать, чтобы выполнять работу, поддерживать инфраструктуру в рабочем состоянии и обновлять ее.

Некоторые примеры. В каких регионах AWS находится наш основной кластер RDS? Где и как мы храним наши секреты? Какая настройка балансировки нагрузки для нашей веб-страницы? Какова наша роль / структура пользователей в Postgres? Как настраивается VPN и что нужно для добавления нового пользователя (создание сертификатов и т. Д.))? Каковы шаги для развертывания новой версии кода XYZ в производственной среде?

Как ваша организация справляется с этим? У вас есть собственная вики (какая?), Вики Github, документы Google, Evernote, файлы разметки в репозитории git, документы Word (?!?) На центральном сервере или что-то еще?

1
задан 5 February 2019 в 04:46
2 ответа

Как только ваша команда выходит за рамки 3 или 4 человек, вам нужен библиотекарь - кто-то, ответственный за то, чтобы документация была написана, последовательна и поддерживалась. Очевидно, что это не работа на полный рабочий день, но это жизненно важно. Когда никто не отвечает за поддержание документа/вики/хранилища/общего пользования, документация становится черствой. А когда она просрочена, люди перестают использовать документ/хранилище, и вещи остаются в голове у людей.

.
3
ответ дан 3 December 2019 в 16:43

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

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

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

.
3
ответ дан 3 December 2019 в 16:43