Данная мини-статья является отсылкой к созданию более правильного окружения для разработки.
В современном мире WEB-разработки, разработчики уже давно перестали устанавливать окружение для разработки: PHP, WEB-сервер, СУБД и т.д. на свой локальный компьютер, на котором производят разработку.
Во-первых, установка и настройка занимает драгоценное время и силы.
Во-вторых, если разработчик работает на нескольких компьютерах (компьютер в офисе, дома, ноутбук), то достаточно проблематично настроить идентичное окружение везде и синхронизировать его настройку между всеми своими компьютерами. Эта проблема называется проблемой идентичности состояния, когда предполагается, что состав, версии и конфигурация всего ПО должна быть максимально идентичной.
В-третьих, если вы не один разработчик, то еще тяжелее поддерживать идентичность окружения на всех ваших компьютерах и на всех компьютерах ваших коллег. Здесь поддержать идентичное состояние еще сложней, так как от вас уже почти ничего не зависит.
В четвертых, состояние окружения вашего рабочего компьютера скорее всего не совпадает и не может совпадать с состоянием окружения вашего боевого (продакшн) сервера. Ведь у вас же Windows со всеми его причудами в конфигурировании, а на боевом сервере что-то однозначно другое.
В конечном итоге, если вы продолжите устанавливать окружение для разработки на свой локальный компьютер, то поймаете себя на мысли, что половина вашего рабочего времени проходит в попытках синхронизировать настройки окружения, а состояние вашей локальной операционной системы очень быстро превратится в свалку.
Избежать этого хаоса вам поможет виртуализация окружения разработки. Вам нужна виртуальная машина, которая бы разворачивалась по заданному вами сценарию, чтобы ее можно было развернуть одним кликом на любом компьютере под любой операционной системой. Пока вы будете пить кофе, ваша виртуальная машина будет готова. Также вам нужны какие-то средства для быстрого и простого управления такой виртуальной машиной (запуск, остановка, реконфигурация).
Также вам необходимо, чтобы ваш рабочий каталог с проектом отражался на каталог внутри виртуальной машины. Например, чтобы каталог локальной машины D:\myProjects, где хранятся ваши проекты, соответствовал каталогу виртуальной машины /var/myProjects или подобному.
Еще хотелось бы иметь возможность полноценно выполнять отладку с использованием PHP-Xdebug, причем приложение должно выполняться в виртуальной среде, на виртуальной машине, а управлять им вы могли с локальной. Уже нравится? Идем дальше!
Всего этого и много чего еще можно добиться используя виртуализацию с использованием Vagrant . О Vagrant в интернете написано очень много. Смысла дублировать здесь никакого нет, иначе статья будет не мини, как обещалось в начале, а макси.
Скажу лишь несколько слов. Vagrant - это специальный набор скриптов, которые работают с гипервизорами (виртуальными машинами), такими как vmWare, VirtualBox, Parallels и другими, для упрощения взаимодействия с этими виртуальными машинами.
Для Vagrant существуют готовые образы операционных систем, называемых «коробками » (boxes). Коробка — это, по сути, просто образ уже установленной и настроенной операционной системы, на основании которого строится виртуальная машина. Часто авторы коробок собирают их для поддержки в разных гипервизорах (приложениях для работы с виртуальными машинами). Мне по душе гипервизор VirtualBox, потому что я начал работать с Vagrant еще тогда, когда поддерживался только он, да и до сих пор больше всего коробок выпускаются именно под VirtualBox. Сейчас же вы можете выбрать гипервизор на свой вкус, главное, чтобы он поддерживался той коробкой, которую вы собираетесь использовать.
Использование Vagrant решает проблему идентичности состояния окружения разработки, не зависимо от операционной системы на хост-машине (так называется ваш локальный компьютер, за которым вы работаете). Гостевая операционная система, выполняемая на виртуальной машине, всегда будет одна и также. К сожалению, Vagrant рассчитан только на обеспечения идентичности состояния при разработке . На сервер невозможно установить Vagrant (точнее, конечно, возможно, но лучше этого не делать), так как виртуализация с использованием Vagrant работает на уровне виртуальной машины, что, очевидно, не подходит для продакшена. Зато Vagrant совершенно одинаково работает под разными операционными системами. Если члены вашей команды предпочитают разные ОС или работают над проектом из разных мест, где могут использоваться разные ОС.
Виртуальная машина, управляемая Vagrant-ом, представляет собой полноценный виртуальный сервер, на котором установлена операционная система и весь необходимый набор приложений и служб.
Стоит сказать, что помимо виртуализации целиком всей операционной системы, вместе со всеми приложениями и службами, также существует решение контейнеризации отдельных служб прямо на локальном компьютере.
Правда полноценно контейнеризация работает только в операционной системе Linux, на остальных же операционных системах для запуска контейнеризации используются виртуальные машины, что делает использование контейнеризации не таким удобным инструментом. Но при использовании контейнеризации мы получаем возможность повторить идентичность состояния в том числе и на сервере в продакшене, что в некоторых проектах может быть очень важно.
Одним из самых распространенных и популярных способов работы с контейнерами в Linux является приложение Docker, о котором я напишу в другой статье. А пока что вернемся к виртуализации с использованием Vagrant.
Чтобы развернуть коробку в виртуальную машину, нужен файл конфигурации, в котором описаны все параметры развертывания. Такой файл называется Vagrantfile и написан он с применением синтаксиса Ruby (на котором и написан Vagrant). Я не стану заставлять вас писать такой файл вручную. Чаще всего вы можете найти уже готовый файл в описании установки вашей коробки, в который нужно внести руками лишь некоторые изменения. Но все это индивидуально для каждой коробке. В любом случае Вы найдете инструкции по развертыванию виртуальной машины на ее основе в инструкциях к ней. На всякий случай еще раз повторю ссылку на хранилище коробок .
Для начала вам необходимо установить гипервизор и затем установить сам Vagrant. Чтобы виртуальные машины могли выполняться, необходимо, чтобы ваш процессор поддерживал виртуализацию и она была обязательно включена в BIOS.
Давайте для начала, чтобы уж точно всё получилось, остановимся на гипервизоре VirtualBox . Это замечательный бесплатный гипервизор от Oracle, который очень быстро и просто устанавливается и сразу же работает без танцев с бубном.
Перед тем как начать установку, убедитесь, что путь к вашей домашней папки, а также путь к файлам ваших проектов не содержат кириллических символов. Если всё же кириллические символы есть, то нужно создать два каталога, например D:\VagrantHome и D:\VirtualBoxMachines. В первом будут находиться файлы Vagrant, а во втором файлы виртуальных машин VirtualBox. Теперь создайте переменную окружения с именем VAGRANT_HOME и значением D:\VagrantHome. Перезагрузитесь.
Теперь можно скачать и установить VirtualBox . После установки откройте окно приложения и перейдите в Файл-Настройки-Общие. Если вы создавали каталог, подобный D:\VirtualBoxMachines, то укажите путь к нему здесь, где «Папка для машин по умолчанию». После этого окно приложения можно закрыть.
Теперь перейдем к установке Vagrant . Скачайте и установите в тот каталог, который предлагается по умолчанию. Раньше была проблема, если указать другой каталог, правда это было 2 года назад, но тем не менее страх остался. Перезагрузитесь, как того требует установщик.
Последнее, что пригодится - это git . Это клиент, необходимый для работы с системой контроля версий git. Если вы еще не знакомы с этим, обязательно ознакомьтесь , зачем это и для чего. Вам понравится.
Во время установки будьте осторожны. Раз уж мы с вами разрабатываем на PHP, то наши файлы не зависимо от операционной системы должны иметь окончания строк вида \n или LF . Это значит, что нам не нужно автоматически преобразовывать концы строк в файлах нашего исходного кода. Поэтому во время установки git, когда будет предложено выбрать, как обрабатывать окончания строк на экране установки «Configuring the line ending conversions», выбирайте второй вариант «Checkout as-is, commit Unix-style line endings.» и git не будет изменять окончания строк в \r\n , как это принято для разработки в других языках программирования.
Описанные процедуры были больше для Windows, однако вы можете точно так же установить VirtualBox и Vagrant в других операционных системах. Смысл тот же.
Вы можете воспользоваться различными коробками, например, поставляемыми с фреймворками или рекомендуемыми к использованию ими же.
Если Вы разрабатываете (или только хоттите начать разрабатывать) на фреймворке Yii2 , то шаблоны приложений (базовый и расширенный) уже содержат файл конфигурации Vagrantfile , который использует коробку bento/ubuntu-16.04 . Вся конфигурация: развертывание (provision), конфигурация nginx и конфигурация самой виртуальной машины описаны в различных файлах, находящихся в каталоге vagrant в корне приложения.
Если Вы внимательно изучите Vagrantfile, то найдете там места, в которых подключаются эти конфигурационные файлы. В данном случае, на одно приложение создается отдельная виртуальная машина, что очень удобно, если необходимо сохранить целостность окружения разработки между всеми вашими машинами и машинами ваших коллег.
В файле Vagrantfile вы найдете параметр config.vm.synced_folder , который указывает каталоги для отображения (синхронизации). В данном случае, текущий каталог хост-машины (вашего компьютера) отображается на каталог /app на виртуальной. Все файлы, которые находятся у вас в текущем каталоге, также незамедлительно доступны на виртуальной машине в каталоге /app.
Если в Вашем проекте появляется необходимость в использовании нового расширения PHP, либо в какой-то другой зависимости, то вам достаточно добавить ее в файл vagrant/provision/once-as-root.sh, который представляет собой сценарий установки и настройки виртуальной машины. Как только Вы это сделаете и отправите измененный файл в репозиторий - ваши коллеги получат все эти изменения и введя всего одну команду перенастроят свои виртуальные машины. Таким образом вам не придется рассказывать и запоминать что куда установить и как настроить - все сохранено в сценариях автоматического развертывания виртуальной машины.
Еще один способ использования виртуализации - использовать одну виртуальную машину для всех ваших проектов. Именно такой подход применен в отдельной виртуальной машине от авторов Laravel, которая называется Homestead . Стоит отметить, что Homestead также может быть развернута в качестве виртуальной машины для одного проекта, подобно описанному выше варианту, но мы ниже рассмотрим именно вариант использования одной машины для всех проектов. Как запустить Homestead для одного проекта, .
В данном случае, файлы конфигурации виртуальной машины не принадлежат какому-то одному проекту, а хранятся отдельно. Основная конфигурация вынесена вообще в домашний каталог пользователя. С одной стороны это неудобно, так как теряется удобная синхронизация настроек виртуальной машины между рабочими станциями, но с другой стороны у вас всего одна виртуальная машина, которая идеально настроена изначально «из коробки» и имеет очень простой, гибкий и очень мощный способ конфигурирования.
Чтобы воспользоваться данной коробкой, вам необходимо загрузить файлы из репозитория и создать пару RSA-ключей (открытый и закрытый). Как это сделать описано .
Есть еще множество готовых наборов конфигураций для различных коробок, чтобы разработчик не тратил время на самостоятельное конфигурирование. Каждый выбирает удобную для себя смесь возможностей.
Итак. VirtualBox и Vagrant у нас установлены. Теперь пришло время начать их использовать. Мы договорились, что будем использовать коробку Laravel/Homestead . Инструкция по ее развертыванию доступна . Ознакомьтесь обязательно с ней, так как она может содержать более актуальную информацию. Я же дальше опишу простые шаги.
Еще раз договоримся, что все наши проекты красиво лежат в каталоге D:\myProjects , разложенные по папочкам. Именно на этот каталог мы будем опираться далее. Вы же должны заменить его на свой.
Далее необходимо будет вводить команды в командную строку. Однако, я рекомендую использовать вместо привычной командной строки интерпретатор git-bash , который идет в комплекте с git под Windows. Запустите его и перейдите в каталог с проектами, выполнив команду
Cd /D/myProjects
(обратите внимание на слеши на путь с использованием буквы диска). Теперь необходимо сначала скачать саму коробку, а затем скачать с репозитория набор конфигурационных файлов развертывания для нее. Выполняем:
Vagrant box add laravel/homestead git clone https://github.com/laravel/homestead.git Homestead
Итак, коробка загружена, конфигурация тоже. Теперь необходимо запустить инициализацию этой конфигурации (скрипт просто скопирует файлы на свои места). Затем установим плагин, позволяющий автоматически управлять host-файлом на вашей локальной машине. Выполните (В примере указана ветка с версией 7.0.1 — актуальной на момент написания статьи. Вам же нужна самая последняя ветка):
Cd Homestead git checkout v7.0.1 ./init.sh vagrant plugin install vagrant-hostmanager
После этого в вашем домашнем каталоге должен появиться каталог.homestead, содержащий файл Homestead.yaml - это конфигурационный файл в формате YAML, который вы должны открыть любым редактором кода и отредактировать. Давайте посмотрим, что там внутри. Я покажу уже отредактированный файл, который использую я в тестовой конфигурации. Вы же можете обратиться к документации по конфигурированию Homestead для более подробной информации.
Ip: "192.168.22.2" memory: 2048 cpus: 2 provider: virtualbox folders: - map: d:\myProjects to: /home/vagrant/www sites: - map: hmvc.app to: /home/vagrant/www/hmvc/public - map: yiibasic.app to: /home/vagrant/www/yii2basic/web databases: - homestead
Здесь видно, что IP адрес виртуальной машины 192.168.22.2, ей выделено 2 Гб ОЗУ и 2 ядра процессора. Провайдер (гипервизор) - VirtualBox.
Далее следует список каталогов локальной системы folders , отображаемых на каталоги виртуальной машины. У меня такой один — каталог d:\myProjects (указан в директиве map) отображается на каталог /home/vagrant/www (указан в директиве to) внутри виртуальной машины. То есть все файлы и каталоги внутри него будут автоматически доступны внутри виртуальной машины по указанному пути.
В самом низу примера — базы данных databases . Я использую одну базу данных с именем homestead.
У вас в файле ниже еще имеется другая информация, например информация о пробросе портов с локальной машины на виртуальную. При необходимости вы можете использовать эту возможность.
После того, как конфигурационный файл составлен, просто запускаем виртуальную машину. Возвращаемся в интерпретатор git-bash и, находясь в каталоге /D/myProjects/Homestead выполняем команду vagrant up .
Первый запуск этой команды приведет к развертыванию виртуальной машины из коробки и конфигурированию ее согласно файлам конфигурации. Чтобы остановить виртуальную машину, находясь в каталоге /D/myProjects/Homestead, выполните vagrant halt . Последующие запуски виртуальной машины будут происходить значительно быстрее, так как уже будет готовый образ виртуальной машины, развернутый из коробки и настроенный.
Если вы что либо меняете в файле конфигурации, то достаточно запустить развертывание принудительно, выполнив команду vagrant provision . Все изменения в конфигурации будут применены к текущей виртуальной машине.
Так как описанный способ использования виртуальной машины Homestead подразумевает глобальную установку для использования всеми проектами на локальной машине, то хотелось бы иметь возможность управления данной виртуальной машиной не из каталога d:\myProjects\Homestead, а из любого места.
Это очень легко настроить. Обратитесь к данному пункту документации , чтобы узнать как это сделать для разных операционных систем.
Использование виртуальных машин в разработке WEB-приложений значительно экономит время и силы для настройки окружения и поддержания его в актуальном состоянии на нескольких рабочих станциях. Разработчик не тратит время на настройку веб-сервера под Windows, которая иногда требует шаманского опыта и не тратит нервы на устранение непрекращаемого потока ошибок. Особенно, если вы только что решили, что хотите начать заниматься разработкой, вам не стоит тратить нервы на развертывание окружения в Windows.
Разница в потребляемых ресурсах виртуальной машины и того варианта, если бы вы развернули окружение локально в Windows, стремится к нулю. Удобство от использования виртуальной машины стремится к максимуму. Дополнительным опытом при использовании такого способа разработки будет пассивное изучение нормальных операционных систем, вроде Debian или Ubuntu.
Манипуляции с виртуальными машинами производятся либо через командную строку, либо через нажимание кнопочек в IDE PhpStorm (в меню Tools-Vagrant). Основные команды управления:
vagrant up - запускает виртуальную машину. Если виртуальная машина еще не построена, то сначала строит ее (при необходимости скачивает образ коробки).
vagrant halt - останавливает виртуальную машину.
vagrant reload - перезагружает виртуальную машину.
vagrant ssh - открывает ssh соединение с виртуальной машиной.
vagrant provision - производит перепостроение виртуальной машины (например, если изменили файлы конфигурации).
Остальные команды можно узнать введя vagrant help .
Удачного использования!
Что такое Vagrant?
Я бы описал Vagrant - как надстройка над виртуальными машинами (VirtualBox, VMWare) со своей инфраструктурой. Vagrant позволяет с помощью заранее подготовленных инструкций развернуть подобие серверного окружения на своей локальной машинке (сколько часов отладки было потрачено из-за отличий окружений (dev, test, prod), в которых запускается разрабатываемое ПО). Поговаривают, что Vagrant в силах решить эти проблемы. Проверим так ли это, и не принесет ли он больше сложностей нежели профита.
Определения
# название бокса на основе которого будет разворачиваться виртуалка
config.vm.box = "lucid10x64"
# Проброс портов (8080 нашей машинки на 80 виртуалки)
config.vm.network:forwarded_port, host: 8080, guest: 80
# 2х сторонняя синхронизация каталога (локальный, виртуальный)
config.vm.synced_folder "/home/stas/www/vagrant/src", "/var/www"
Примечание
По умолчанию текущий каталог проекта (в котором находится Vagrantfile ) уже синхронизируется с директорией /vagrant (в корневой на виртуальной системы). DocumentRoot веб сервера Apache завернут на этот же каталог. Поэтому, дополнительно синхронизацию на /var/www указывать не нужно, но я привел этот конфиг как пример для бокса, у которого не будет предустановленного Apache .
Примечание
Для проверки окружения виртуальной машины, нужно создать файл index.php
внутри вашего проекта и перезагрузить конфиг Vagrant
:
vagrant reload
После этого откройте в браузере страницу http://localhost:8080 - это и будет ваш index.php
.
Подготовить окружение виртуальной машины (provision , обеспечение) под наш проект мы можем несколькими способами. Один из них, это запуск shell скрипта, в котором прописываются все действия необходимые для настройки окружения. Давайте установим mc ( пример установки Apache). Создайте в корне проекта файл bootstrap.sh :
#!/usr/bin/env bash
apt-get update
apt-get install mc
И пропишите в Vagrantfile что необходимо запустить этот скрипт после старта виртуальной машины:
config.vm.provision:shell, :path => "bootstrap.sh"
Перезагрузите конфиг с обновлением обеспечения :
vagrant reload --provision
Управление
Команды для управления виртуальной машиной:
vagrant ssh # подключиться по SSH под юзером vagrant
vagrant suspend # поставить на паузу
vagrant halt # выключить
vagrant reload # перезагрузить конфиг (без выполнения provision)
vagrant reload --provision
vagrant destroy # удалить виртуалку
vagrant box list # cписок доступных "боксов"
Будьте бдительны!
Пользователь vagrant имеет право выполнять команды под рутом (sudo ) без пароля.
Кастомизация
VAGRANT_HOME
- переменная окружения, содержит путь к каталогу с VagrantBox"ами (как установить переменную окружения
).
Вопросы
В: Где будет расположен/скрипты код, с которым мы работаем? Постоянно синхронизироваться? А это быстро?
О: Код, с которым вы работаете будет располагаться в локальном каталоге. Каталог проекта уже по дефолту синхронизируется с виртуальной машиной.
В: Сколько времени займет развертывание типичного LAMP сервера?
О: Скачивание Vagrant Box ~ 20 мин. Если файл конфигурации уже описан, тогда все зависит от окружения и зависимых пакетов - все зависимости будут скачиваться и устанавливаться (если только они не включены в сам бокс). Если вы только начинаете настройку окружения и виртуалки - готовьтесь потратить от часа на описание нужного окружения.
В: Средний расход ресурсов на обслуживание одного LAMP окружения?
О: Прикидываю как бы замерять расход памяти по нескольким процессам...
Ваше первое виртуальное окружение Vagrant
Настройка проекта
Образы виртуальных машин (Виртуальные боксы)
Настройка SSH
Обеспечение для виртуальных боксов (Provisioning)
Проброс портов (Port Forwarding)
Пакетирование (Packaging)
Остановка виртуальных боксов (Teardown)
Быстрая пересборка
Н ачало
Vagrant это менеджер ваших виртуальных окружений для разработки. Фактически он является надстройкой над программой VirtualBox от Oracle , и обеспечивает быстрое создание и настройку виртуальных машин. Созданные таким образом виртуальные машины - боксы (boxes) используются разработчиками web-приложений для построения необходимой среды разработки. Затем они могут быть упакваны в специальные контейнеры (боксы), для установки и использования другими разработчиками в команде.
Г де взять VirtualBox
Vagrant полностью зависит от программы VirtualBox и использует ее для создания виртуальных образов. Основным назначением VirtualBox является полная виртуализация x86 оборудования. Это проект с открытым исходным кодом, который обеспечивает виртуализацию на профессиональном уровне и может быть использована как на серверах так и на десктопных компьютерах для построения виртуальных сред. VirtualBox доступен для Windows , Mac OS X , Linux и Solaris .
На текущий момент Vagrant поддерживает VirtualBox 4.0.x, 4.1.x и 4.2.x.
У становка Vagrant
Чтобы установить Vagrant , необходимо скачать соответствующий пакет или установщик с этой страницы загрузки и установить его, используя стандартную процедуру установки приложения на вашей системе. В операционных систмах Windows и Mac OS X после установки приложения будет доступна команда Vagrant из командной строки. На остальных систмах вам необходимо будет самим добавить этот путь /opt/vagrant/bin в переменную окружения PATH .
Если вы не нашли для вашей системы установщик Vagrant, то вы можете установить его используя RubyGems с помощью команды gem install vagrant . Но помните, что установка из пакетов или через установщик является наиболее предпочтительным способом установки приложения.
В аше первое виртуальное окружение Vagrant
В командной строке набирите:
$ vagrant init precise32-box
$ vagrant up
Эти команды необходимы для запуска виртуальной машины с помощью Vagrant . Учтите, что команды выше запускают полнофункциональную виртуальную машину на операционной системе Ubuntu 12.04LTS precise с объемом памяти по-умолчанию в 512Мб.
П реимущества от использования Vagrant
Многие Web-разрабочики используют виртуальное окружение для разработки своих Web-приложений. Все большую популярность сейчас набирают облачные сервисы для построения и развертывания виртуальных окружений для продакшена и разработки, начиная от EC2 , Rackspace Cloud и заканчивая более специализированными как EngineYard и Heroku . Vagrant реализует схожие принципы при создания виртуальных машин для локальной разработки и тестирования ваших приложений на рабочем компьютере. Такая организация работы повышает гибкость и продуктивность как вас так и вашей команды при разработке web-приложений.
Для развертывания и настройки виртуальных окружений Vagrant использует достаточно зарекомендовавшие себя технологии виртуализации в лице VirtualBox от Oracle и технологии автоматицированного развертывания приложений от Chef и Puppet .
П реимущества для одного разработчика
Использование однотипного окружения разработки для разных проектов расчитанных для разных версий языков программирования и фреймворков зачастую очень трудная задача. Как быть, если один проект работает на PHP4, второй на PHP 5.2.x, а третий на PHP 5.3.x или 5.4.x и его необходимо тестировать в той версии языка на которую он расчитан?
Ставить кучу разных версий языков и сервисов и загружать рабочую машину, не вариант, т.к. рано или позно ваша система начнет долго загружаться, тормозить и глючить. Еще один момент, заключается в том, что каджый из рабочих проектов работает в продакшене на сервере, где стоит определенное окружение, поэтому при разработке такого проекта надо, чтобы окружение на компьютере разработчика точно соответсвовало окружению на рабочем сервере, чтобы разработчик мог быть полностью уверен в том, что у него не будет неприятных сюрпризов при развертывании своего web-приложения на рабочем сервере.
Vagrant решает эти проблемы. С помощью него вы можете создавать виртуальные машины с окружением необходимым для каждого конкретного проекта. При переключении с одного проекта на другой, вы просто парой команд останавливаете одну виртуальную машину и поднимаете другую нужную для другого проекта. Все гениально и прсто!
П реимущества для команды разработчиков
Все участники команды в идеале должны иметь одинаковое окружение разработки: одинаковые версии, зависимости, настройки и т.д. ведь по идее команда работает над общими проектами. Но что если часть команды работает над проектом с одной версий базы данных, к примеру, MySQL , а другая часть - над проектом где используется PostgreSQL или MSSQL . Что если одному участнику команды нужно приступить к разработке другого проекта, у которого другая версия языка или базы данных и т.д. Вобщем, сплошная головная боль, приводящая к замедлению разработки и уменьшению эффективности команды.
В этом случае Vagrant позволяет команде создавать и использовать готовые образы виртуальных окружений для соотвествующих проектов. Когда другой участник команды присоединяется к разработке другого проекта, он просто берет у своих коллег образ виртуальной машины для этого проекта и разворачивает этот образ у себя. Все, за считанные минуты разработчик получает готовое окружение и может спокойно приступать непосредственно к своей части работы.
П реимущества для компании
Если у вас крупная компания и вы работаете на крупным развивающимся проектом, то вам пстоянно приходится добавлять какие-то новые компоненты в инфраструктуру приложения, например, различные системы кеширования, обработчики событий, сервера баз данных и т.д. В этом случае Vagrant предоставляет вам средство для создания и распространения готовых окружений разработки. Теперь если к вам в компанию приходит новый сотрудник то ему нет необходимости тратиь массу времени на начальную настройку всей своей системы, чтобы присоединиться к разработке приложения.
Н астройка проекта
После того как вы установили Vagrant на свою систему, все его управление осуществляется через команду vagrant . У этой команды есть множество необходимых подкомманд, например, vagrant up - для запуска виртуальной машины, vagrant ssh - для подключения по ssh , vagrant package - для создания пакета текущего виртуального окружения готового к развертыанию на другом компьютере и т.д. Чтобы просмотреть все доступные команды, просто наберите в командной строке команду vagrant .
V agrantfile
Н астройка Vagrant проекта
Первым шагом для любого проекта Vagrant является создание корневой директории проекта и инициализация проекта:
$ mkdir my_vagrant_project
$ cd my_vagrant_project
$ vagrant init
команда vagrant init создаст файл Vagrantfile. Пока мы оставим этот файл как есть, но далее мы будем его редактировать для настройки виртуальной машины нашего проекта.
Н астройка Web-проекта
Теперь когда Vagrant настроен, давайте создадим небольшой web-проект, который будем потом использовать для демострации работы Vagrant . Создайте в корне Vagrant проекта (где расположен файл Vagrantfile ) индексный html файл:
$ echo "
В принципе на этом настройка web-проета закончена.
О бразы виртуальных машин (Виртуальные боксы)
Следующим шагом после инициализации проета, является создание базового бокса. Vagrant не создает виртуальную машину с нуля. Он импортирует базовый образ виртуальной машины и запускает его, применяя затем все необходимые настройки заданные в конфигурационном файле Vagrantfile. Это упрощает жизнь пользователям Vagrant , т.к. им не надо тратиь время на настройку параметров виртуальной машины, таких как выделенная виртуальная память, объем диска, сетевые интерфейсы и пр.
П олучение базового образа виртуальной машины
В самом начале статьи мы уже скачали базовый образ 32-битной системы Ubuntu 12.04LTS precise и добавили его в Vagrant . Обратите внимание, что если вы уже скачали образ, то вам не нужно повторно каждый раз его скачивать при последующем запуске. Vagrant поддерживает загрузку образов как из Интернета, так и с вашего жесткого диска. В самом начале статьи мы запустили следующую команду:
$ vagrant box add precise32-box http://files.vagrantup.com/precise32.box
После ее выполнения Vagrant скачал образ и сохранил его в системной папке пользователя на диске. При этом этот образ был автоматических добавлен в глобальное пространство текущей установки Vagrant на вашем компьютере, т.е. теперь для всех проетов, которые вы будете создавать этот образ будет доступен для выбора при развертывания виртуального окружения. Также, каждый добавленный таким способом образ имеет уникальное имя, в данном примере, это precise32-box .
Адрес http://files.vagrantup.com/precise32.box мы использовали только один раз в самом начале, теперь подключать базовый образ мы будем из локального хранилища на жестком диске.
У даление виртуальных боксов
Таже просто как добавить, виртуальные боксы можно и удалить. Для этого используйте команду:
$ vagrant box remove my_box
При этом бокс удаляется физически с диска. После этого ни одна виртуальная машина созданная ранее на основе этого бокса не сможет быть запущена.
Н астройка проета для использования нужного виртуального бокса
Теперь, когда виртуальный бокс с именем precise32-box был добавлен в Vagrant мы можем добавлять его в наши проеты. Это делается путем записи в конфигурационный файл Vagrantfile следующей строчки:
П роверка настройки
На данный момент мы произвели самую базовую настройку нашего виртуального окружения. Мы не задали переброс портов (port forwarding) , свое обспечение для окружения (provisioning) и т.д. Но даже с такой базовой настройкой у нас получилась полнофункциональная виртуальная машина. Вы можете в этом убедится набрав следующую команду vagrant up из корневой директории проекта Эта команда запустит виртуальную машину. Чтобы остановить запущенную виртуальную машину и очистить место на диске, которое она занимала, нужно выполнить команду vagrant destroy :
$ vagrant up
$ vagrant destroy
Н астройка SSH
Vagrant предоставляет полный доступ к виртуальной машине через SSH протокол при помощи команды vagrant ssh . После запуска этой команды откроется терминал и вы увидите приблизительно следующее приглошение командной строки:
$ vagrant ssh
vagrant@vagrantup:~$
ВНИМАНИЕ: для пользователей Windows
Т.к. ssh-клиент по-умолчанию не распространяется на Windows платформе, то при запуске команды vagrant shh на Windows машине Vagrant выведет вместо окна терминала - окно с необходимой информацией для подключения к виртуальной машине по shh протоколу через ssh-клиент PuTTY :
PuTTY не распознает стандартные openssh ключи, поэтому вам придется преобразовать данный приватный ключь в формат .ppk с помощью утилиты puttygen , которая идет в комплекте с PuTTY .
Д оступ к файлам проекта с виртуальной машины
В запущенной через Vagrant виртуальной машине вы найдете расшаренную директорию, в которой находятся файлы вашего проекта. Эта директория располагается на виртуальной машине по этому пути: /vagrant . С виртуальной машины содержимое данной директории доступно как для чтения так и для записи.
О беспечение для виртуальных боксов (Provisioning)
Мы запустили с помощью Vagrant виртуальную машину, настроили подключение через ssh , и что дальше? Для нас как для разработчиков эта машина не представляет никакого инетерса, т.к. на ней, пока, ничего не установлено кроме оперционной системы Ubuntu . Для разработки нашего web-проекта нам необходимо из получившейся заготовки виртуальной машины сделать полноценное виртуальное окружение - максимально точную копию того, что у нас находится на рабочем сервере. Для этого нам надо установить нужное программное обеспечение, к примеру, nginx или Apache , php , ruby , MySQL и т.д., т.е обеспечить наш виртуальный бокс необходимой провизией (Provisioning)
Для этих целей Vagrant позволяет использовать на выбор одно из двух решений - это Chef (Chef-Solo) или Puppet . Также, при необходимости, вы можете расширять Vagrant и использовать другие средства автоматизированного развертывания приложений (но это уже не относится к теме данной статьи).
Н астройка Chef и Vagrant
В данной статье мы воспользуемся заранее приготовленными рецептами для Chef , чтобы продемонстрировать развертывания виртуальной машины. Для этого отредактируем конфигурационный файл Vgarantfile:
Vagrant::Config.run do |config|
Config.vm.box = "precise32-box"
# Enable and configure the chef solo provisioner
Config.vm.provision:chef_solo do |chef|
# We"re going to download our cookbooks from the web
Chef.recipe_url = "http://files.vagrantup.com/getting_started/cookbooks.tar.gz"
# Tell chef what recipe to run. In this case, the `vagrant_main` recipe
# does all the magic.
Chef.add_recipe("vagrant_main")
З апуск!
После настройки провизий для виртуальной машины, просто запускаем команду vagrant up . Vagarnt запустит виртуальную машину из образа и установить необходимы софт прописанный в рецептах. Если ваша виртуальная машина уже была запущена к этому моменту и вы ее не выключали, то просто перезагрузите ее командой vagrant reload , чтобы изменения вступили в силу.
После того как Vagrant завершит все необходимые действия и настройки системы, у вас будет полноценный настроенный web-сервер на виртуальной машине. Однако, пока вы еще не сможете увидеть свой web-проект на ней через браузер на вашем рабочем компьютере, т.к. мы еще не настроили проброс портов (port forwarding) .
Чтобы убедится всеже что наш простой сайт уже работает, вы можете подключится по ssh к виртуальной машине и в командной строке ssh-терминала набрать следующее:
$ vagrant ssh
vagrant@vagrantup:~$ wget -qO- 127.0.0.1
vagrant@vagrantup:~$
П роброс портов (Port Forwarding)
Проброс портов позволяет задать номер порта на гостейвой машине (в данном случае на нашей виртуальной машине), который будет доступен извне на хост машине (т.е. на нашем рабочем компьютере). Это позволит нам обращаться к web-серверу установленному на виртуальной машине из браузера на нашем рабочем компьютере.
З адание номера порта для проброса
В данном случае мы хотим пробросить порт на котором работает сервер Apache. Проброс порта настраивается в файле Vagrantfile следующим образом:
Vagrant::Config.run do |config|
# Forward guest port 80 to host port 4567
Config.vm.forward_port 80, 4567
Как вы видите мы задали проброс портов с 80 порта (guest posrt) на виртуальной машине на 4567 порт (host port) на нашем рабочем компьютере. Теперь надо запустить виртуальную машину командой vagrant up или если она уже запущена, то перезагрузить командой vagrant reload . После этого можно в адресной строке браузера набрать адрес http://127.0.0.1:4567/ и он откроет нашу страничку с приветсвием:
Hello from a Vagrant VM
П акетирование (Packaging)
Итак, мы получили готовое для использования виртуальное окружение для нашего web-проекта. Но представьте ситуацию, что вы не один, а состоите в команде и вам надо обеспечить своих коллег такимже виртуальным окружением как и у вас. Что делать? Vagrant предоставляет для этого случая возможность создавать пакеты (packages) виртуального окружения. Эти готовые пакеты вы отдаете своим коллегам и они устанавливают их у себя на компьютере.
Пакеты (Packages) это готовые к установке образы вашего виртуального окружения, которое могут быть быстро развернуты на других компьютерах. Обычно они имеют расширение .box и называются боксами. Опционально в этот бокс вы можете включить сам конфигурационный файл Vagrantfile .
Перед тем как создать бокс убедитесь что ваше виртуальное окружение проинициализировано и запущено командой vagrant up .
С оздание VagrantFile"а
Сначала мы должны создать конфигурационный файл Vagrantfile , который затем будет помещен в созданный виртуальный бокс. На этот этапе важно убетиться, что ваше виртуальное окружение запущено командой vagrant up и работает HTTP доступ к нему. Теперь создаем файл Vagrantfile.pkg , который будет использоваться как Vagrantfile только для созданного бокса. Файл должен содержать следующую конфигурацию:
Vagrant::Config.run do |config|
# Forward apache
Config.vm.forward_port 80, 8080
$ vagrant package --vagrantfile Vagrantfile.pkg
vagrant package возьмет текущее запущенное виртуальное окружение и упакует его в бокс package.box в текущую директорию откуда была запущена команда (т.е. в корне нашего Vagrant проета). Опция --vagrantfile указывает, что бокс должен включать в себя файл Vagrantfile.pkg , чтобы при развертывании на другом компьютере была автоматически выполнена проброска портов (более попдробно см. ).
Созданный бокс можно теперь отдать другому участнику команды, чтобы он скопировал его к себе на рабочий комьютер и установил или выложить его в интернет, тогда его можно будет потом просто скачать на нужный компьютер и запустить. Бокс запускается на другом компьютере следующим образом:
$ vagrant box add my_box /путь/к/боксу/package.box
$ vagrant init my_box
$ vagrant up
После выполнения этих команд другой участник вашей команды получит готовое к работе виртуальное окружение (точную копию вашего виртуального окружения).
О становка виртуальных боксов (Teardown)
Чтобы завершить запущенное виртуальное окружение в Vagrant S uspend - уход в спящий режим с сохранением текущего состояния системы
Завершение работы с уходом в спящий режим выполняется командой vagrant suspend . При этом происходит сохранение текущего состояни виртуального окружения и затем завершение его работы. Для возобновления работы достаточно выполнить команду vagrant resume .
Основное преимущество данного режима завершения работы - это то, что возобнавление работы происходит очень быстро, быстрее чем при всех остальных режимах завершения работы, т.к. сосхраняется предыдущее состояние виртуальной машины. Однако этот режим требует дополнительного места на жестком диске - приблизительно в 1 Гб для сохранения состояния системы.
H alting - обычное завершение работы
Это завершение работы выполняется командой vagrant halt . При этом выполняется обячное завершение работы (как в обычной Linux системе при выполнении команды halt ). Чтобы возобновить работу виртуального окружения после такого выключения надо выполнить команду vagrant up .
При таком завершении работы не требуется дополнительное место на диске, т.к. состяние системы не сохраняется. Возобновление работы при этом длится немного дольше чем в предыдущем случае, т.к. виртуальное окружение загружается как при загрузке обычного компьютера.
D estroing - завершение работы с очисткой всех файлов бокса
Наконец, последний - третий способ выключения виртуального окружения. Выполняется командой vagrant destroy . При этом происходи завершение работы с полной очисткой места на диске, которое занимало виртуальное окружение. Чтобы возобновить работу необходимо также как и в предыдущем случае выполнить команду vagarnt up .
Основное преимущество этого способа в том, что вы экономите до 1 Гб места на жестком диске. Но при этом возобновление работы будет самым долгим процессом, т.к. Vagrant"у придестя заново ставить весь необходимы софт из рецептов. Обычно не рекомендуется пользоваться данным способом завершения работы, если только вы не стремитесь любой ценой сэконмить место на жестком диске, что при текущих размерах современных жестких дисков крайне редкая необходимость.
Б ыстрая пересборка
Давайте предположим такую ситуацию: вы закончили работу над проектом, сдали его заказчику, получили оплату. Прошло пол года, год и вот босс говорит вам, что надо возобновить работу на проетком для этого заказчика. У вас за это время могло много чего поменятся на рабочем компьютере, вы снесли и переустановили операционную систему, обнвовили софт, да мало-ли что еще могло произойти?
Не переживайте! Все что необходимо вам сделать чтобы возобновить работу над проектом это просто заново запустить виртуальный бокс командой vagrant up . Вот и все. Через пять минут может больше или меньше, когда Vagrant запустит виртуальную машину и установит весь нужный софт вы спокойно можете приступить к разработке вашего старого проекта.
Vagrant — это средство для управления виртуальными средами. Vagrant полностью решает такие проблемы, как: у вас на компьютере сайт работает, а на сервере нет. Или когда код написанный вашим колегой работает у него, но не хочет работать у вас.
Основа Vagrant’а — это box’ы. Box — это файл с полностью настроенной и готовой к использованию виртуальной средой. Например, я в работе использую связку Nginx + PHP-FPM + MySQL (LEMP) и у меня есть готовый box , который настроен идентично моему рабочему серверу. Box’ы удобно передавать коллегам для обеспечения идентичной среды разработки у всей команды.
Все настройки виртуальной машины (сколько выделять памяти, какие каталоги делать общими с вашей основной системой и пр.) содержатся в одном файле, который называется Vagrantfile. Также с помощью этого файла можно указать какие команды должны быть выполнены при первом запуске Vagrant. Например, можно создать базу данных с определённым именем или настроить Nginx.
Vagrant используется из командной строки. Команды лакончины, просты для запоминания и логичны. Так, например, чтобы запустить виртуальную среду достаточно выполнить команду: vagrant up . Обычно, последовательность работы с Vagrant выглядит следующим образом:
Тысячи готовых box’ов на все случаи жизни можно найти на сайте HashiCorp . Кроме настроенных сред там есть чистые установки популярных операционных систем. Такие box’ы можно использовать как основу для своего собственного box’а, если нужно что-то специфичное. Собственные box’ы также можно распространять, если зарегистрироваться на указанном выше сайте.
— это программа-ассистент по сборке и управлению виртуальными машинами. С её помощью можно автоматизировать процесс развёртывания кастомных (с пользовательскими настройками) виртуальных машин.
Суть работы Vagrant в том, что она с помощью написанных специально для этой программы конфигурационных файлов, собирает виртуальные машины, в которых уже применены определённые настройки. Авторы некоторых систем распространяют их в виде такого конфигурационного файла Vagrant и получив этот файл мы можем собрать на своём компьютере эту ОС. Мы можем использовать конфигурации по умолчанию или вносить в них изменения. В результате будут получаться ОС от автора, но с определённым тюнингом.
Поскольку Vagrant это всего лишь надстройка над VirtualBox , то начать нужно с установки VirtualBox .
Теперь, когда VirtualBox уже есть в вашей системе, то поищите vagrant в стандартных репозиториях вашей системы — скорее всего, он там уже есть.
Для установки в Ubuntu, Linux Mint, Debian, Kali Linux и их производные выполните команду
Sudo apt install vagrant
Для установки в Arch Linux, BlackArch и их производные выполните команду:
Sudo pacman -S vagrant
Как установить Vagrant в Windows
Для Vagrant в Windows также имеется графический установщик, скачайте его и выполните установку.
В качестве папки установки Vagrant выбирает не C:\Program Files\, а другую папку, это позволяет программе проще работать с разрешениями и правами доступа:
После перезагрузки откройте командную строку Windows. Это можно сделать нажав Win+x , в открывшемся окне выберите Windows PowerShell (администратор) . В открывшемся окне для перехода из PowerShell в командную строку введите
В этой консоли выполните команду:
Должна появиться стандартная справка по пользованию программой:
Если возникнет ошибка, либо просто для профилактики, выполните обновление плагинов:
Vagrant plugin update
vagrant-vbguest — это плагин Vagrant, который автоматически устанавливает в гостевые системы VirtualBox Guest Additions — гостевые дополнения VirtualBox.
Независимо от операционной системы, плагин должен устанавливаться одинаково следующей командой:
Vagrant plugin install vagrant-vbguest
Если в Windows у вас проблемы с установкой этого плагина, то попробуйте следующую команду:
C:\vagrant\vagrant\embedded\bin\gem.bat install vagrant-vbguest
Также в Windows файервол может запросить разрешение для выхода в сеть программой:
Плагин vagrant-vbguest запускается и используется по умолчанию всеми виртуальными машинами. Он запускается автоматически сразу после старта коробки (так в Vagrant называют виртуальные машины). Получается что он работает каждый раз при загрузке коробки, то есть при использовании команд vagrant up или vagrant reload . Он не будет работать при команде vagrant resume (или vagrant up на приостановленной коробке) чтобы не тратить время при возобновлении работы виртуальной машины.
Чтобы отключить этот плагин, в настройках виртуальных машин установите vbguest.auto_update на false .
Vagrant собирает виртуальные машины исходя из конфигурационного файла Vagrantfile . Вы можете создавать и использовать для быстрого развёртывания свои варианты, либо устанавливать различные операционные системы подготовленные другими. Большой сборник содержится в , там вы можете выбрать заинтересовавшую вас коробку и собрать, а затем запустить с помощью команды вида:
Например, offensive-security подготовили kali-linux-light ,
тогда установка и запуск выполняются командами:
Vagrant init offensive-security/kali-linux-light vagrant up
Примеры других популярных систем:
Для разных систем выделите отдельные папки, то есть запускайте приведённые выше команды в разных папках.
Vagrant умеет не только скачивать и запускать коробки, он также умеет запускать внутри них пользовательские скрипты — поэтому некоторые системы могут устанавливаться сложнее, чем показано здесь. Для них может потребоваться скачивание полного архива. Затем нужно будет перейти в папку, содержащую файл Vagrantfile и уже там запустить vagrant up .
