deploy helper

deploy-helper

Deploy-Helperは、ソフトウェア開発者をターゲットにしたアーティファクト展開のための小さなツールです。

目次

• 要件
• 目的
• 欠点
• 特徴
• 構成
• プレースホルダー /変数
• 議論
• インストール
• 実行方法（例）
• ソースからの建物
• 貢献

要件

• Java 15！
• SSHセッションのOpenSSH（または同等）
  • Plantext Password Authを使用する場合は、「Sshpass」

目的

Deploy-Helperを作成して、物事に取り組んでいるときにアーティファクトをテストネットワークに展開するのに役立ちました。私はおそらくそのために私のIDEを使用できたかもしれませんが、それは面白くありません！

Deploy-Helperのないステップ：

1. コンパイル
2. ファイルエクスプローラーを開きます
3. サーバーから古いアーティファクトを削除します
4. 新しいアーティファクトをサーバーにドラッグアンドドロップします

Deploy-Helperのステップ：

1. コンパイル
2. Deploy-Helperを実行します

欠点

• Javaで書かれています
• 機能はあまりありません

特徴

• 複数の展開宛先
• ローカルコマンド
• SSHセッション

構成

デフォルトの構成ファイルdeploy-helper.json作業ディレクトリにある必要があります。
configの例：

 {
  // 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セッションを開始します
2. rmコマンドを実行して、古いアーティファクトを削除します
3. SSHセッションを終了します
4. scpコマンドを実行して、新しいアーティファクトをサーバーにコピーします

また、 .gitignoreファイルにdeploy-helper.jsonを追加する必要があります。

注：アーティファクトは1つしかありません。

プレースホルダー /変数

{DEST_ADDRESS} ：宛先アドレス
{DEST_NAME} ：宛先名
{DEST_PATH} ：宛先パス
{SSH_USER} ：sshユーザー
{SSH_PORT} ：sshポート
{ARTIFACT_PATH} ：artifactパス
{ARTIFACT_NAME} ：artifact name

議論

長さ	短い	説明
-config	-C	構成場所をオーバーライドします
--verbose	-v	有効にした場合、プロセス出力はstdout＆stderrにリダイレクトされます
- 行き先	-d	目的地をオーバーライドする（コンマの分離リスト）

インストール

Deploy-Helperのインストールは、最新リリース（理論的に）からJARをダウンロードするのと同じくらい簡単です。ただし、おそらく瓶を何らかの中央の場所に保管する必要があります。

これは、ZSHを使用してLinuxマシンにDeploy-Helperを「インストール」した方法です。

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-Helperを実行してください：
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. ターゲットディレクトリから新鮮な瓶を入手してください

貢献

貢献ガイドラインに従ってください