Это продолжение Начало работы с DevOps, часть 1 Анкет
Иногда это просто. фото Джессика Льюис на Неспособный .
Документация
Давайте передадим всю нашу грязную прачечную. Я знаю, просто Чтение Слово заставляет некоторых людей съеживаться. Документация не для DOERS.
Почему я должен документировать, как что -то сделать, если я уже знаю, как это сделать?
Документация — это отпечатки пальцев тех, которые были до вас. Конечно, один Тип документации — начальная загрузка среды разработки, но, честно говоря, документация происходит во многих формах.
Если вы помните в моем первая часть Я отмечаю, что чем больше думают, что вы выбираете из развития, тем больше ваш мозг может сосредоточиться на других, более важных вещах.
Вот несколько примеров форм документации:
- Как настроить среду разработки
- Журналы ошибок и все остальное, что заставляет приложение петь
- RESTFUL API -структура конечной точки, параметры и ответ объекты
- Как правило, все, что кто -то выиграет от знания
Если вы посмотрите на это так, вы (и ваша команда) знаете только то, что вы документируете.
Есть новый парень/девушка? Попросите их проверить вашу документацию. Если они находят какие -либо обходные пути или небольшие нюансы, которые соответствуют настройке разработчика, это их задача — обновить документацию.
Единственный источник истины, децентрализованный
Я люблю Markdown язык. Это легко использовать. Мне не нужно снимать руки от клавиатуры, и она читается человеком даже в необработанной форме.
Лучше всего, потому что это открытый текст … Угадайте, что управляет простым текстом волшебным образом? Вы уже догадались, GIT делает!
Это верно, Gumshoes ! Конечно, вы можете хранить свою документацию в вики, но где находится место, которое все девто должен иметь доступ к? Исходный код!
Что мне нравится в этом методе, так это то, что ваша документация поддерживается с исходный код. Для частной команды это очень полезно и очень легко поддерживать. Он всегда будет жить с исходным кодом, независимо от того, какой инструмент вы используете для размещения своего кода (GitHub, Bitbucket и т. Д.).
Для публичных проектов по -прежнему имеет смысл иметь вики или какую -то форму проведенной документации; Тем не менее, убедитесь, что другие аспекты проекта также документированы.
Когда вы его строите
Это одно, чтобы построить его на своей машине, И ты должен, Но вы также должны использовать инструмент сборки, такой как Jenkins, Travis CI или Circle CI.
Главная причина? Чисто. У него нет всех старых версий из 80 пакетов NPM, которые вы загружали, чтобы попробовать.
Если вам интересно, CI означает непрерывную интеграцию. Это первая половина CI/CD. Второе — непрерывная доставка.
CI, для меня, где все это объединяется. Ваш инструмент CI должен быть хорошо настроенной машиной. Он должен выдержать вашу среду разработки за считанные минуты, запустить ваши тесты, создать приложение, пометить версию и развернуть артефакт в репозиторий.
Настройка вашего инструмента CI должен имитировать документацию, которую вы написали, чтобы заставить свою среду разработки. Какие инструменты вы должны были установить на командную строку? Какие разрешения вам нужно было установить и забыть в файлах и папках?
Все те одноразовые вещи, которые вы сделали несколько месяцев назад и забыли после того, как ваша среда настроена? Тебе нужно это.
Ваш инструмент CI, если все сделано правильно, следует буквально позволить вам снять репозиторий без настройки окружающей среды. Да, вы должны иметь возможность клонировать свой репо, написать код в базовом редакторе, как Блокнот, и выдвинуть свой код. Ваш CI должен справиться с остальными.
Реально, это подразумевает большой код написания рисков вышеупомянутым образом, но если у вас есть надлежащие проверки и балансы в игре и сборка, успешны, отправьте этот код!
https://medium.com/media/9ce89463e75d7ea78029937e2b6f94f5/href
Давайте восстановим.
Ваш инструмент CI должен
- Встаньте свою среду развития
- Заполните свой код
- Запустите свои модульные тесты, сохраните свои интеграционные тесты на потом
- Вывод отчет о покрытии кода
- Оставьте релиз
- развернуть артефакт релиза в репозиторий
После того, как вы получите артефакт выпуска в вашем репозитории, давайте развернем его в тестовой среде и протестируйте его еще! Именно на данный момент мы могли бы запустить наши интеграционные тесты, так как мы находимся в живой среде. Вы также можете провести несколько ручных испытаний и базовых тестов на дым.
Отличить это Симпатичная
Это большое время для вашей сборки, чтобы получить высшее образование! Если у вас есть среда тестирования, вы также должны иметь среду для QA. Строители должны быть отполированы и красивы, чтобы QA мог сделать свое дело. Именно здесь автоматизация может произойти для тестирования конца 2-й энд, и исследовательское тестирование может произойти с людьми.
После того, как у вас будет довольно отточенная упаковка, и все ваши преданные функции соответствуют принятым критериям, пришло время отправить вашу сборку на производство.
Благодарю вас
К настоящему времени у вас должна быть представление о том, чтобы получить ваше приложение в руки другого человека (или машины), который не сочинял его, чтобы использовать его.
Помимо этого, вы попадаете в сферу жизненного цикла приложения и как управлять ребенком в реальном мире с реальными нагрузками и сетевыми махинациями.
Надеюсь, вам понравилась эта короткая серия.
Оригинал: «https://dev.to/sublimegeek/getting-started-with-devops-part-2-1k5f»