ニフクラ ブログ

ニフクラやクラウドの技術について、エンジニアが語るブログです。

ニフティクラウドタイマーを使ってTravis CIのビルドを定期的に実行する

ニフティクラウドタイマーを使ってTravis CIのビルドを定期的に実行する方法です。

個人的に書いた、ニフティクラウドタイマーを使ってTravis CIで定期的にビルドを実行するを少し修正したものです。

タイマーって何?という方はニフティクラウドタイマーのご紹介をご覧ください。

前提条件

この記事の手順を実施するためには下記の項目を満たしている必要があります。

  • GitHubのアカウントを持っている
  • GitHubのPersonal settingsでPersonal access tokenを取得済み(GITHUB_TOKENとする)
  • Travis CIのアカウントを持っている
  • Travis CIで定期的にビルドしたい何かがある(ない場合は適当なプロジェクトをGitHubに作成し、Travis CIに登録してください)
  • ニフティクラウドのアカウントを持っている

手順

手順1: Travis CIのAccess TokenをGitHubのPersonal access tokenを使って取得する

下記のコマンドを実行し、Travis CIのAccess Tokenを取得します。GITHUB_TOKENの部分には、ご自身のGitHubのPersonal access tokenを入れてください。

curl -s -X POST -H 'Content-Type: application/json' -H 'Accept: application/vnd.travis-ci.2+json' https://api.travis-ci.org/auth/github -d '{"github_token":"GITHUB_TOKEN"}'

成功すると、下記のようなレスポンスが返ってきます。

{"access_token":"TRAVIS_TOKEN"}

TRAVIS_TOKENの部分にTravis CIのAccess Tokenが入っているので、メモしておきます。

Travis CIのAPI認証について、詳しくは公式ドキュメントをご参照ください。

手順2: curlで実行してみる

ここで、APIの実行が可能か確認するため、下記のようにcurlでAPIを叩いてみます。

{TRAVIS_TOKEN}に先ほど取得したTravis CIのAccess Tokenを、{ACCOUNT}にアカウント名、{REPOSITORY}にリポジトリ名を入れてください。

body='{
"request": {
  "branch":"master"
}}'

curl -s -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Travis-API-Version: 3" \
  -H "Authorization: token {TRAVIS_TOKEN}" \
  -d "$body" \
  https://api.travis-ci.org/repo/{ACCOUNT}%2F{REPOSITORY}/requests

成功すると、ビルドが実行されます。

Travis CIのAPIからのビルドの実行について、詳しくは公式ドキュメントをご覧ください。

手順3: ニフティクラウドタイマーの設定

設定は簡単で、前項でcurlで実行した、HTTPのリクエストの内容を設定するだけです。

1.ニフティクラウドにログインし、左上のメニューから、タイマーを選択します。

サービスメニュー

2.「タイマー作成」ボタンをクリックします。

3.タイマー名とスケジュールを設定し、「詳細設定へ」をクリックします。メモも設定できます。

タイマー作成 01 基本設定

タイプはHTTPにします。ほかのタイプにはサーバー起動、停止、再起動、削除、設定変更、イメージとして保存、スナップショット取得、MQTT、Fluentdがあります。

タイマー作成 02 詳細設定

HTTPを選択するとURL、メソッド、ヘッダー、ボディが設定できるようになるので、下記のように設定し、「通知設定へ」をクリックします。{TRAVIS_TOKEN}にTravis CIのAccess Tokenを、{ACCOUNT}にアカウント名、{REPOSITORY}にリポジトリ名を入れてください。

  • URL

    https://api.travis-ci.org/repo/{ACCOUNT}%2F{REPOSITORY}/requests
    
  • メソッド

    POST
    
  • ヘッダー

    Content-Type: application/json
    Accept: application/json
    Travis-API-Version: 3
    Authorization: token {TRAVIS_TOKEN}
    
  • ボディ

    {
      "request": {
        "branch":"master"
      }}
    

通知の設定をします。

タイマー作成 03 通知設定

確認して、「作成する」をクリックします。

これで、設定は完了です。定期的にビルドが実行され、実行の履歴を作成したタイマーの実行履歴タブで確認できます。

実例: Travis CIとニフティクラウドタイマーを使って、毎日最新のCoreOSをインポートする

最後に、実際にこの仕組みを使ってCoreOSのインポートを定期的に実行している例をご紹介します。

元々Jenkinsサーバーを立てて定期的に実行していたのですが、タイマーを使うことでサーバーなしで実行できるようになりました。

実行しているスクリプトや.travis.ymlGitHubに置いてあります。

中身を見るとわかるのですが、ニフティクラウド CLIを使っているため、ニフティクラウド上の大抵の操作はこの仕組みを用いて定期的に実行できるということがわかります。

ビルドの様子もTravis CIで見られます。

新しいバージョンが出て、インポートされたときのみ成功と判定しています。(成功しているビルド

このように定期的に実行している作業をニフティクラウドタイマーに置き換えることで、サーバーの運用から解放され、エンジニアの負担を少し軽くすることができます。

いろいろなことに使えそうなので、今後も何か思いついたときにはブログに書きたいと思います。