Часто на большом предприятии вам нужно будет представлять изменения в кабине (изменить консультативный совет), прежде чем получить одобрение, чтобы внести какие-либо изменения в вашей инфраструктуре. Но управление версиями ваших диаграмм и документов/инфраструктурного кода/что на самом деле было развернуто, может быть сложно.
Документация часто хранится в отдельном магазине документов (например, SharePoint).
Я использую Azure DevOps, чтобы управлять рабочими элементами здесь, но вы можете вставить собственную (проблемы JIRA, GitHub).
- Проблемы для решения
- Решение
- Новый процесс создания документов
- Диаграмма
- Результаты
- Разделительные документы из инфраструктурного кода часто вызывают устаревшие документы, поскольку они не всегда в курсе в SharePoint.
- Решения о том, когда/почему изменения были реализованы, трудно отслеживать.
- Храните документы в Git (контроль источника), непосредственно с инфраструктуру.
- Используйте запросы на потяну в Azure DEVOPS для одобрения кабины изменений документов (и отслеживать любые изменения, которые были запрошены документам).
- Каждая папка приложения имеет папку Docs (с llds, hlds, диаграммы Visio, и т. Д.)
- Инженер будет иметь историю в Azure DEVOPS, чтобы сделать анализ и дизайнерскую работу и создать документ
- Они создадут ветку, чтобы внести изменения в документы в этой папке, совершить филиал и представить запрос на тягу, когда они будут завершены.
- Когда запрос на тягу запросится на Master, выпускной трубопровод копирует папку Docs в папку в SharePoint.
- PR назначается члену кабины для кабины.
- Затем они принимают это в кабину, и могут просматривать документы в SharePoint или в репозитории.
- Если одобрено это объединяется в Master, а новая история может быть создана для следующего спринта для выполнения реализации.
- Если отказано, они могут создавать ошибки против запроса на тягу в Azure DEVOPS, те могут быть назначены инженеру, который может внести изменения, а папка Docs будет скопирована снова в папку SharePoint
- Версительные документы и код хранятся вместе одновременно.
- Изменен любой временной код, вы увидите, не будет ли документация не обновлена, а также знают, что фактически изменилось.
- Часть процесса запроса на тягах для совершения кода, может быть обновлена документация, если это необходимо.
- Все разговоры вокруг изменения документов будут видны в запросе на тягу. Комментарии можно увидеть/обсуждаться внутри запроса на тягу, а ошибки, созданные и назначаемые для любых необходимых изменений. (Это покажет нам утвержденную дату, и увидит, кто/когда были приняты решения для внесения изменений)
Теперь у нас есть документация и инфраструктурный код, хранящийся вместе и версимый в одном месте.
Следующий пост будет установить это в Azure DevOps или, возможно, действия GitHub.
Что вы думаете об этом подходе?
Как вы храните свою документацию для вашего инфраструктурного кода?
Оригинал: «https://dev.to/owendavies/storing-devops-documentation-in-git-and-managing-cab-approvals-with-pull-requests-42a4»