Game > Smart Downloader > プラグインガイド

Smart Downloader Jenkins Plugin

Smart Downloader Jenkins Pluginを通して、NHN Cloud Smart Downloaderの新規ビルドアップロード機能を便利に使用できます。

Pluginインストール

Jenkinsの最小要件

Jenkins 2.60.1以降のバージョンが必要です。Jenkins 2.60.1は、Java 8の実行が可能なJenkins LTSの最初のリリースです。

参考： https://jenkins.io/changelog-stable

1. Jenkins Pluginダウンロード

下記リンクからsmartdl-uploader.hpiファイルをダウンロードします。 Download ： smartdl-uploader.hpi

2. インストール

[Jenkins] > [Jenkins管理] > [プラグイン管理] > [詳細設定] > [プラグインアップロード]メニューで「1. Jenkins Pluginダウンロード」を通してダウンロードしたsmartdl-uploader.hpiファイルを選択してアップロードします。

正常にインストールが完了すると、インストールされたプラグインリストタブで下記[図1]のようにインストールされた内容を確認できます。

図1

[図1]インストールされたプラグインリスト

Plugin使用

事前準備

Smart Downloader Jenkins Pluginを使用するためには、「NHN Cloud APIセキュリティー設定」が必要です。

NHN Cloud APIセキュリティー設定： https://console.toast.com/securitySetting

1. 認証設定

[Jenkins] > [Credentials] > [System]メニューでGlobal credentials選択し、Add CredentialsメニューからNHN Cloud認証を追加します。 下の[図2]のように、KindをNHN Cloud Credentialsに選択し、NHN Cloud UserID、NHN Cloud AccessKeyID、NHN Cloud SecretKeyを入力します。

図2

[図2]認証設定

  • Scope [必須] ： Global選択
  • ID ： Jenkinsで内部的に使用するCredential ID値。未入力の時は、自動的にユニークなID値が作成されます。
  • Description ：該当のNHN Cloud認証の説明を入力できます。
  • NHN Cloud UserID [必須] ： NHN Cloud接続アカウント
  • NHN Cloud AccessKeyID [必須] ： NHN Cloud APIセキュリティー設定メニューで発行されたAccessKeyID
  • NHN Cloud SecretKey [必須] ： NHN Cloud APIセキュリティー設定メニューで発行されたSecretKey

参考： [必須]と表示された値は、必須入力値です。この値が未入力の場合は、プラグインが正常に実行されません。

2. プロジェクト構成

[Jenkins] > プロジェクト選択 > [構成] > [ビルド後の措置]メニューで「SmartDL Uploader」を追加します。 下の[図3]のように設定値を入力します。

図3

[図3]プロジェクト構成

  • NHN Cloud Credentials [必須]： 1.認証設定を通して追加したNHN Cloud Credentialを選択します。無効な認証キーが入力された場合、認証に失敗し、プラグインが使用できません。
  • Enable Upload [必須] ：プラグイン動作の有効 / 無効を決定するオプション値です。プラグイン設定が保存された状態を維持しながらプラグインの動作を無効にすることができます。
  • ProjectID [必須] ： Smart Downloaderを使用するNHN Cloud Project ID。下の[図4]のようにNHN Cloudコンソールプロジェクト設定メニューで確認できます。
  • Appkey [必須] ： Smart Downloader Appkey。下の[図5]のように、NHN Cloud Smart DownloaderコンソールのURL & Appkey画面で確認できます。
  • Service Name [必須] ：新規ビルドアップロードを処理するSmart Downloaderサービス名を入力します。
  • Path [必須] ：アップロードするフォルダのパスを入力します。フォルダアップロードのみサポートし、単一ファイルのアップロードはサポートしません。

参考： [必須]と表示された値は、必須入力値です。この値が未入力の場合は、プラグインが正常に実行されません。

図4

[図4] NHN Cloudプロジェクト設定
図5
[図5] Smart Downloader Appkey確認

3. 結果確認

プロジェクトビルド後のログを通して、Plugin実行結果を確認できます。

図6

[図6]コンソールログ

またSmart Downloaderコンソール内の「サービス詳細情報」ページでビルドアップロード履歴を確認できます。 Pluginを通してビルドをアップロードすると、Last UploaderにPluginを実行させたサーバーIPが表示されます。

図7

[図7]サービス詳細情報

Pluginの実行結果が失敗の場合、コンソールログのエラーメッセージを参照してください。

Pipeline環境設定

Smart Downloader Pluginのインストールと設定は上記と同じように進めますが、[2. プロジェクト構成(図3参考)]の「ビルド後のアクション」設定の代わりにPipeline設定を行います。 [Jenkins] > [プロジェクト選択] > [構成] > [Pipeline]メニューで以下のスクリプト内容を最後に追加します。

図8

[図8] Pipeline設定参考

node() {
    stage ('Smart Downloader'){
    step([$class:'BuildUploaderPublisher',
        credentialsId: '<NHN Cloud Credentials>',
        projectId: '<NHN Cloud Project ID>',
        appkey: '<Smart Downloader Appkey>',
        serviceName: '<Smart Downloaderサービス名>',
        path: '<アップロードするフォルダのパス>',
        enableUpload: 'enable'
    ])
    }
}

項目の詳しい設定値は上の[2.プロジェクト構成]項目の[図3]と説明を参照してください。

参考事項

JenkinsでMaster/Slave nodeを構成して使用する場合は必ずNode情報を設定してください。

図9-1

[図9-1] Node設定参考1

図9-2

[図9-2] Node設定参考2

図9-3

[図9-3] Node設定参考3 - Pipeline設定

  • Node設定は、各プロジェクトの構成に合わせて設定して使用してください。
目次
TOP