Лучшие практики для сохранения / курации организационных знаний ops
Это несколько более широкий вопрос по теме, с которой, я думаю, каждая организация / бизнес сталкивается, когда есть более одного сотрудника DevOps: как сохранить и оценить знания об организационных операциях, чтобы они оставались актуальными, легкодоступными и полезными новичкам?
Цель этого вопроса - собрать образец решений для людей на выбор. Мой бизнес / организация еще не нашла хорошего способа решения этой проблемы.
Определение: операционные знания - это то, что необходимо знать, чтобы добиться цели, поддерживать работоспособность инфраструктуры и быть в курсе.
Несколько примеров: В каких регионах AWS находится наш основной кластер RDS? Где и как мы храним наши секреты? Как настроена балансировка нагрузки для нашей веб-страницы? Какова наша роль / структура пользователя в Postgres? Как настраивается VPN и что нужно для добавления нового пользователя (создания сертификатов и т. Д.)? Какие шаги для развертывания новой версии кода XYZ в производство?
Как ваша организация справляется с этим? Вы запускаете свою собственную вики (какую?), Вики Github, документы Google, Evernote, файлы уценки в git-репо, документы Word (?!?) На центральном сервере или что еще?
2 ответа
Когда ваша команда выходит за рамки 3-4 человек, вам нужен библиотекарь - человек, который отвечает за обеспечение того, чтобы документация была написана, согласована и поддерживалась. Это явно не работа на полный рабочий день, но это жизненно важно. Когда никто не отвечает за ведение документа /wiki/repository/Sharepoint, документация устаревает. И как только он устареет, люди перестанут использовать документ / хранилище, и все останется в головах людей.
Некоторые организации начинают с вики для базы знаний. Это достаточно легко отслеживать для небольшой команды, и не требует больших усилий для создания. Знание какого-либо языка разметки полезно, хотя есть веб-панели, которые сводят процесс публикации к странице разработки.
Существует тенденция использовать документы Google, потому что они являются общими, совместными и могут быть организованы. Сначала это работает хорошо, но склонно к дезорганизации, и функция поиска не работает с большим и стареющим набором данных (пропускает совсем немного). Но если вы можете держать это организованно, это дешево и просто. По сути, это то же самое, что и подход "картотеки" NAS, и обычно он будет хранить все, что вам нужно.
Платформа управления документами, такая как Confluence, хорошо работает для крупных организаций, так как она предназначена для разделения обязанностей по ведению документации между группами, а также для обеспечения четких функций управления версиями и совместного использования. Его легко поддерживать организованным и интегрировать с различными диаграммами или другими системами с богатым контентом. Кривая обучения больше, чем с вики или классическим подходом "картотеки".