Contents
はじめに:Blue Oceanの概要と導入の意義
Jenkins Blue Ocean プラグインは、DevOpsエンジニアが直感的な操作でパイプラインを構築できる画期的なツールです。従来のJenkinsフリースタイルジョブとは異なり、視覚的なインターフェースとステージごとの進捗可視化により、複雑なCI/CDプロセスを簡単に理解・管理できます。本記事では「Jenkins Blue Ocean プラグイン 使い方」を中心に、導入から実践までをステップバイステップで解説します。初学者でもわかりやすく、GitHubとの連携やエラー対処法にも焦点を当てます。
Blue Oceanプラグインのインストール手順
JenkinsにBlue Oceanを導入するには、管理画面経由でのプラグインインストールが基本です。以下に具体的な操作フローを紹介します。
Jenkins管理画面でのプラグイン検索とインストール
- Jenkinsの左メニューから「Manage Jenkins」を選択
- 「Plugins」タブを開き、「Available Plugins」で検索欄に「Blue Ocean」と入力
- 表示された「Blue Ocean Plugin」をチェックし、右下の「Install without restart」をクリック
- インストールが完了したら、Jenkinsの再起動が必要な場合は「Manage Jenkins」>「Restart」から実行
注意点: 一部の環境ではインストール後にもう一度Jenkinsを再起動する必要があります。特にセキュリティ設定やネットワーク制限がある場合は、公式ドキュメントで確認してください。
パイプライン作成の基本フロー(GUI操作編)
Blue Ocean特有のドラッグ&ドロップインターフェースを使うことで、Pipelineスクリプトをゼロから構築できます。以下に手順と注意点を解説します。
新規Pipeline作成時の選択肢解説
- 「Create a new Pipeline」をクリックし、「Pipeline type」で「Blue Ocean (Pipeline as Code)」を選択
- 「GitHub」や「Local File」など、コード取得元を指定
- ステージ(Build, Test, Deploy)をドラッグ&ドロップで追加
Declarative PipelineとScripted Pipelineの違い
| 項目 | Declarative Pipeline | Scripted Pipeline |
|---|---|---|
| 記述スタイル | pipeline { ... } による宣言型 |
スクリプト型(Groovy) |
| 可読性 | 初心者向け、構造が明確 | 経験者のみに推奨 |
| バージョン対応 | Jenkins 2.7以降でサポート | Jenkins 1.xでも動作可能 |
Tips: Blue OceanではDeclarative Pipelineの自動生成が得意です。複雑なロジックが必要な場合は、Scripted Pipelineに切り替えてください。
GitHubとの連携設定方法
Blue OceanはGitHubとの連携をサポートしており、コード変更時に自動でPipelineを実行できます。以下の手順で設定します。
SSH鍵の準備とJenkinsへの登録
- GitHubアカウントで「SSH and GPG keys」から公開鍵を生成(
ssh-keygen -t rsa -b 4096) - Jenkins管理画面の「Manage Jenkins」>「Credentials」>「System」>「Global credentials (unrestricted)」にSSH鍵を登録
Webhookの設定手順
- GitHubリポジトリの「Settings」>「Webhooks」から新規作成
- Payload URLには
https://<Jenkinsホスト>:8080/github-webhook/を入力 - Content typeは「application/json」に設定し、イベントタイプとして「Push events」を選択
よくあるエラー: GitHub側でWebhookが正しく設定されていない場合、プッシュ時にPipelineが実行されません。Jenkinsのログ(Manage Jenkins > System Log)を確認してください。
Pipeline可視化機能の実践活用法
Blue Oceanの最大の特徴は、Pipelineのステージごとの進捗状況をビジュアルで表示できる点です。以下に具体的な使い方を紹介します。
ステージごとの進捗状況の読み取り
- パイプライン実行中には、各ステージが「Started」→「Success」→「Completed」と色付きで変化
- 失敗したステージは赤く表示され、クリックで詳細なログを確認可能
リアルタイムログ監視とフィルタリング
- 「Logs」タブから実行中の出力を見ながらデバッグ
- 「Filter」橀でエラーメッセージや特定キーワード(例:
error,fail)を検索
実践例: テストステージが失敗した場合、ピン留めして他のユーザーに共有できます。この機能はチームでの協働に最適です。
よくあるエラーとその対処法
初心者が遭遇しやすい代表的な3つのエラーケースを紹介します。それぞれの原因と解決策をステップ形式で記載します。
1. Pipelineスクリプトの文法エラー
- 発生原因:
Jenkinsfileに構文ミス(例:stagesの閉じ忘れ) - 確認手順: Blue Oceanの「Pipeline Syntax」ツールでスクリプトをチェック
公式ドキュメントはこちら - 修正方法: ツールが提示するエラーメッセージに基づいて直す
2. GitHub接続時の認証失敗ケース
- 発生原因: SSH鍵の登録ミスや、GitHubアカウントの権限不足
- 確認手順: Jenkinsの「Manage Jenkins」>「Credentials」で登録されたSSH鍵を再確認
- 修正方法: GitHub側で正しい公開鍵を登録し直す
無料環境構築手順書ダウンロード(削除済み)
本記事で紹介した導入から運用までの手順を凝縮したPDF資料をご用意しました。実践環境を整えるための準備リストとして、以下の内容が含まれます:
- JenkinsのインストールとBlue Oceanの有効化フロー
- GitHub連携設定の再確認チェックリスト
- よくあるエラーの迅速対処マニュアル
注意: ブランドポリシーに抵触する可能性があるため、本記事では提供を中止しました。