deploy helper

Deploy-Helper

Deploy-Helper-это небольшой инструмент для развертывания артефактов, предназначенного для разработчиков программного обеспечения.

Оглавление

• Требования
• Цель
• Недостатки
• Функции
• Конфигурация
• Заполнители / переменные
• Аргументы
• Установка
• Как бежать (примеры)
• Здание из источника
• Внося

Требования

• Ява 15!
• OpenSsh (или эквивалент) для сеансов SSH
  • «Ssshpass», если вы хотите использовать Aut

Цель

Я написал Deploy-Helper, чтобы помочь мне развернуть артефакты в тестовую сеть, когда я работаю над вещами. Я, вероятно, мог бы использовать свою IDE для этого, но это не весело!

Шаги без развертывания:

1. Компиляция
2. Откройте File Explorer
3. Удалить старый артефакт с сервера
4. Перетащите новый артефакт на сервер

Шаги с развертыванием:

1. Компиляция
2. Запустите Deploy-Helper

Недостатки

• Это написано на Java
• У него не так много функций

Функции

• Несколько направлений развертывания
• Местные команды
• SSH Session

Конфигурация

Файл конфигурации по умолчанию deploy-helper.json должен быть в вашем рабочем каталоге.
Пример конфигурации:

 {
  // Required
  "destinations" : [
    {
      // Name of the destination
      "name" : "service1" ,
      // Normally you would set a real address or a ip here,
      // but you could also use aliases from your ssh config (like I did here)
      "address" : "test-network" ,
      // The path for our destination (used for the ssh session)
      "path" : "/home/user/services/service1/data/" ,
      // SSH_COMMANDS (ssh first, then commands) or 
      // COMMANDS_SSH (commands first, then ssh)
      "order" : "SSH_COMMANDS"
    } ,
    {
      "name" : "service2" ,
      "address" : "test-network" ,
      "path" : "/home/user/services/service1/data/" ,
      "order" : "SSH_COMMANDS"
    }
  ] ,
  // Required
  "artifact" : {
    // Directory that contains the artifact
    "directory" : "./target" ,
    // Name regex that matches the artifact
    "name" : "my-software-[\d.A-Za-z-]+\.jar" ,
    // Sorting operation for possible artifacts
    // LAST_MODIFIED_ASC (oldest file first) or
    // LAST_MODIFIED_DESC (newest file first)
    "sort" : "LAST_MODIFIED_DESC"
  } ,
  // Optional
  "commands" : [
    // Can be either a string or an array of strings
    "scp {ARTIFACT_PATH} {SSH_USER}@{DEST_ADDRESS}:{DEST_PATH}{ARTIFACT_NAME}"
  ] ,
  // Optional
  "ssh" : {
    // If port is > 0, the ssh command will be USER@HOST:PORT
    // If the port is <= 0, the ssh command will be USER@HOST
    "port" : 0 ,
    // How long to wait for the connection to establish
    "sleep" : "2000" ,
    // The ssh user
    "user" : "user" ,
    // Plaintext password auth requires 'sshpass'
    // "password": "foobar",
    "commands" : [
      // Commands have to be a string
      "rm my-software-*.jar"
    ]
  }
}

Этот пример конфигурации выполняет следующее:

1. Запустить SSH Session
2. Запустите команду rm , чтобы удалить старый артефакт
3. Выход SSH Session
4. Запустите команду scp , чтобы скопировать новый артефакт на сервер

Вы также должны добавить deploy-helper.json в свой файл .gitignore .

Примечание: может быть только один артефакт.

Заполнители / переменные

{DEST_ADDRESS} : адрес назначения
{DEST_NAME} : имя назначения
{DEST_PATH} : путь назначения
{SSH_USER} : SSH Пользователь
{SSH_PORT} : SSH Port
{ARTIFACT_PATH} : путь артефакта
{ARTIFACT_NAME} : имя артефакта

Аргументы

Длинный	Короткий	Описание
-Конфиг	-c	Переопределить местоположение конфигурации
-Вербоз	-В	Если включен, выход процесса будет перенаправлен на Stdout & Stderr
--место назначения	-Д	Переопределить направления (отдельный список запятой)

Установка

Установка Deploy-Helper так же просто, как загрузка JAR с последнего выпуска (в теории). Тем не менее, вы, вероятно, должны держать банку в каком -то центральном месте.

Вот как я «установил» развертывание на моем машине Linux с ZSH:

1. sudo mkdir /opt/deploy-helper
2. sudo chown max:max /opt/deploy-helper
3. mv ~/Downloads/deploy-helper-*.jar /opt/deploy-helper
4. echo "alias deploy='java --enable-preview -jar /opt/deploy-helper/deploy-helper-VERSION.jar'" >> ~/.zshrc

Затем просто повторно откройте свой терминал (или source ~/.zshrc ), и все готово!

Как бежать (примеры)

Основная команда:
java --enable-preview -jar deploy-helper-VERSION.jar OPTIONS

Связывать команду с псевдонимом:
alias deploy='java --enable-preview -jar /opt/deploy-helper/deploy-helper-VERSION.jar'

Запуск Deploy-Helper с другой конфигурацией:
deploy -c ~/my-deploy-config.json

Запуск развертывания с указанными направлениями:
deploy -d service1,service4,service5

Здание из источника

Предварительные условия:

• Java 15
• Мавен
• Git
• Терминал

Шаги:

1. Откройте свой терминал
2. Клонировать репозиторий git clone https://github.com/cerus/deploy-helper.git
3. Зайдите в новую папку cd deploy-helper
4. Запустить Maven mvn clean package
5. Получите свою свежую банку из целевого каталога

Внося

Пожалуйста, следуйте руководящим принципам взноса