Телепортация MODX. Решаем проблемы деплоя

Этапы разработки

• Установка MODX
• Настройка (ЧПУ, имя сайта, почта и тд.)
• Установка дополнений
• Заполнение дерева (структура)
• Наполнение шаблонов и чанков
• Творческий процесс разработчика

Известные недостатки MODX

• Элементы в БД
• Необходимость работы через админпанель
• Git? Бесполезен

Перенос сайта

• FTP
• SSH (SFTP)
• scp / rsync / ...
• PhpMyAdmin / mysqldump
• Vapor
  • только для MODX Revo 2.2+
  • только MODX Cloud

OK. Перенесли

И тут заказчик решает добавить на сайт новый раздел

Неужели нет решения?

• SE Manager + StaticSaver + git
• ElementHelper + git
• Cast
• Gitify
• Общие недостатки

SE Manager + StaticSaver + git

ElementHelper + git

Cast

Gitify

Общие проблемы

• Однонаправленность
• Недостаток документации
• Сложность для обычного пользователя

Teleport

Teleport - это расширяемый набор скриптов для работы с одним или несколькими локальными экземлярами MODX Revolution.

MODX Cloud

Установка

1. Создать папку teleport там, где удобно. Обычно в /home/username
2. Скачать в нее teleport.phar

Каталоги

• profile - в нем будут размещены профили сайтов
• workspace - в нем будут размещены собранные пакеты

Как работает?

1. Создание профиля
2. Упаковка сайта в пакет
3. Перенос пакета в нужное место
4. Создание профиля целевого сайта
5. Распаковка и установка обновлений

Что умеет?

• Profile
• Extract
• Inject
• Push
• UserCreate
• Packages/GC

Profile

				php teleport.phar \
				    --action=Profile \
				    --name="MySite" \
				    --code=mysite \
				    --core_path=/path/to/mysite/modx/core/ \
				    --config_key=config
			

Extract

				php teleport.phar \
				    --action=Extract \
			 	    --profile=profile/mysite.profile.json \
			 	    --tpl=phar://teleport.phar/tpl/complete.tpl.json
			

Inject

				php teleport.phar \
				    --action=Inject \
				    --profile=profile/mysite.profile.json \
				    --source=workspace/mysite_develop-120315.1106.30-2.2.1-dev.transport.zip
			

Push

				php teleport.phar \
				    --action=Extract \
				    --profile=profile/mysite.profile.json \
				    --tpl=phar://teleport.phar/tpl/complete.tpl.json \
				    --target=s3://mybucket/snapshots/ \
				    --push
			

UserCreate

				php teleport.phar \
				    --action=UserCreate \
				    --profile=profile/mysite.profile.json \
				    --username=superuser \
				    --password=password \
				    --sudo \
				    --active \
				    --fullname="Test User" \
				    --email=testuser@example.com
			

Packages/GC

				php teleport.phar \
				    --action=Packages/GC \
				    --profile=profile/mysite.profile.json
			

Шаблоны

• Запакованы в phar: phar://teleport.phar/tpl/*.json.tpl
• Формат - json
• 11 шаблонов из коробки: changeset, complete, complete_db, develop, elements, packages, resource_children, resources, settings, user, users

Извлекает определенный набор изменений, зафиксированный обратной функцией, заданной в настройках MODX.

Извлекает все настройки из первого сайта для импорта во второй, обновляет и дополняет существующие.

Извлекает все объекты ядра, файлы и пользовательские таблицы из первого сайта и заменяет все это во втором.

Извлекает все объекты ядра и пользовательские таблицы, без файлов.

Извлекает все пакеты из первого сайта и устанавливает во втором.

Извлекает все объекты ядра, файлы и пользовательские таблицы из первого сайта для импорта во второй, дополняет существующие объекты и таблицы.

Извлекает все элементы и связанные с ними данные из первого сайта для импорта во второй, обновляет и дополняет существующие.

Извлекает все ресурсы из первого сайта для импорта во второй, обновляет и дополняет существующие.

Извлекает все ресурсы, которые являются потомками заданного родительского ресурса.

Излекает одного указанного пользователя и сопутствующие данные из первого сайта для импорта во второй.

Излекает все пользователей из первого сайта для импорта во второй, обновляет и дополняет существующих.

Собственные шаблоны

				{"name":"elements", "vehicles":[]}
			

• Обычный json
• Отношения и условия как в map-файлах modx

Пример собственного шаблона

				{"name":"elements", "vehicles":[
			        {
			            "vehicle_class":"xPDOFileVehicle",
			            "object":{
			                "source":"{+properties.modx.core_path}components",
			                "target":"return MODX_CORE_PATH;"
			            },
			            "attributes":{
			                "vehicle_class":"xPDOFileVehicle"
			            }
			        }
			    ]}
			

Пример собственного шаблона

							{"name":"elements", "vehicles":[
							    {
							        "vehicle_class":"xPDOObjectVehicle",
							        "object":{
							            "class":"modPropertySet",
							            "criteria":["1 = 1"],
							            "graph":{
							                "Category":[]
							            },
							            "package":"modx"
							        },
							        "attributes":{
							            "preserve_keys":false,
						

							            "update_object":true,
							            "unique_key":"name",
							            "related_objects":true,
							            "related_object_attributes":{
							                "Category":{
							                    "preserve_keys":false,
							                    "update_object":true,
							                    "unique_key":"category"
							                }
							            }
							        }
							    },
							]}
						

Телепортация A в B

Телепортация modx.by

				php teleport.phar --action=Profile \
				--name="modxbydevalronikscom" --code=modxbydevalronikscom \
				--core_path=/var/www/modx.by.dev.alroniks.com/www/core/ \
				--config_key=config
			

Телепортация modx.by

				php teleport.phar --action=Profile \
				--name="modxby" --code=modxby \
				--core_path=/var/www/modx.by/www/core/ \
				--config_key=config
			

Телепортация modx.by

				php teleport.phar --action=Extract \
				--profile=profile/modxbydevalronikscom.profile.json /
				--tpl=phar://teleport.phar/tpl/elements.tpl.json /
				--target=/var/www/modx.by/www/core/packages/
				--push
			

Телепортация modx.by

				php teleport.phar --action=Inject \
				--profile=profile/modxby.profile.json \
				--source=/var/www/modx.by/www/core/packages/
modxbydevalronikscom_complete-141125.1702.46-2.3.2-pl.transport.zip
			

Проблемы

• complete и complete_db не подходит для установки через менеджер пакетов
• в конфиге нельзя исключить из упаковки отдельную папку
• не на все действия есть документация
• до сих пор нет документации по custom tpls

Планы

• Панель управления dev-экземлярами
• Автоматическая сборка пакетов
• Специальный репозиторий для обновлений
• Continuous Delivery через пакеты

Создание сложных интернет-магазинов и сайтов на MODX

• alroniks.com - команда
• klimchuk.by - личный и контакты
• modx.by - сообщество