IBM Cloud Docs
「IBM Cloud にデプロイ」ボタンの作成

「IBM Cloud にデプロイ」ボタンの作成

作成した公開アプリを Git で共有する場合、「IBM Cloud にデプロイ」ボタンを用意しておくと、他のユーザーがそのコードを試し、ツールチェーンを使用して IBM Cloud にデプロイできるので、効率的に共有できます。 このボタンは最小限の構成で済み、マークアップをサポートする場所ならどこにでも挿入できます。 他のユーザーがこのボタンをクリックすると、元のアプリには影響を与えることなく、新しい Git リポジトリーにそのコードのクローン・コピーが作成されます。

他のユーザーがこのボタンをクリックすると、以下のアクションが発生します。

  1. そのユーザーがアクティブな IBM Cloud アカウントを持っていなければ、アカウントを作成する必要があります。 トライアイル・アカウントまたは実アカウントを作成できます。

  2. ユーザーは、 Delivery Pipeline アイコンをクリックして、リージョン、リソース・グループ、およびアプリ名を選択できます。 推奨アプリ名はツールチェーンと同じ名前であり、元の Git リポジトリー名と現在時刻で構成されます。 ツールチェーン名は編集することもできます。

  3. Git リポジトリーの新しいプライベート・クローン、コード変更を作成してデプロイするためのパイプライン、および問題トラッカーを含むツールチェーンが作成されます。

    .bluemix ディレクトリーに toolchain.yml ファイルが含まれていれば、ツールチェーンのツール統合を指定するためにそのファイルが使用されます。 toolchain.yml ファイルについて詳しくは、 カスタム・ツールチェーン・テンプレートの作成を参照してください。

  4. アプリがビルド・ファイルを必要とする場合、ビルド・ファイルが自動的に検出されて、アプリがビルドされます。

  5. ビルドとデプロイメントのプロセスのためにパイプラインが構成されている場合、pipeline.yml ファイルを使用してアプリがデプロイされます。

  6. アプリがコンテナーを必要とする場合、IBM Cloud Kubernetes Service を定義する pipeline.yml ファイルとイメージを定義する Dockerfile の両方を使用して、IBM Cloud Kubernetes Service にアプリがデプロイされます。

  7. そのユーザーが選択した IBM Cloud 組織にアプリがデプロイされます。

このボタンの例

パブリック Git Repos and Issue Tracking リポジトリーのアプリ・ボタンの例を以下に示します。

「 IBM Cloud ボタン

パブリック GitHub リポジトリーのアプリ・ボタンの例を以下に示します。

「 IBM Cloud ボタン

ボタンの作成

「IBM Cloud にデプロイ」ボタンを作成するには、以下のいずれかのスニペット・テンプレートをコピーして変更します。 URL に Git リポジトリーとブランチを指定します。

HTML でのボタンの作成

HTML でボタンを作成するには、このスニペットをコピーして、パブリック Git リポジトリー URL とブランチを挿入します。

<a href="https://cloud.ibm.com/devops/setup/deploy?repository=<git_repository_URL>&branch=<git_branch>"><img src="https://cloud.ibm.com/media/docs/images/icons/Deploy_to_cloud.svg" alt="Deploy to IBM Cloud" target="_blank"></a>

スニペットのリポジトリー URL に branch パラメーターを含めない場合、「IBM Cloud にデプロイ」ボタンのデフォルトはリポジトリーのマスター・ブランチになります。

Markdown でのボタンの作成

Markdown でボタンを作成するには、このスニペットをコピーして、パブリック Git リポジトリー URL とブランチを挿入します。

[![Deploy to IBM Cloud button](https://cloud.ibm.com/media/docs/images/icons/Deploy_to_cloud.svg)](https://cloud.ibm.com/devops/setup/deploy?repository=<git_repository_URL>&branch=<git_branch>)

スニペットのリポジトリー URL に branch パラメーターを含めない場合、「IBM Cloud にデプロイ」ボタンのデフォルトはリポジトリーのマスター・ブランチになります。

ボタン・スニペットの使用

「IBM Cloud にデプロイ」ボタン・スニペットを作成した後、それをブログ、記事、Wiki、README ファイルなど、アプリを宣伝したい場所に挿入できます。

「 IBM Cloud へのデプロイ」ボタンのスニペットをカスタマイズする際には、両方のテンプレートが SVG 形式および英語の外部ボタン・イメージへのデフォルト・パスを使用することを考慮してください。 イメージをローカルに保管する場合は、イメージをダウンロードし、Git リポジトリーに保管できます。 イメージの相対ロケーションを使用するようにパスを調整してください。

リポジトリーに関する考慮事項

「IBM Cloud にデプロイ」ボタンで使用するリポジトリーについて、以下の考慮事項を検討してください。

ビルド・ファイルの要件

アプリのデプロイ前にビルドが必要な場合は、リポジトリーにビルド・ファイルを含める必要があります。 リポジトリーのルート・ディレクトリーでビルド・スクリプト・ファイルが検出されると、デプロイメントの前にコードの自動ビルドが起動します。

サポートされるビルダーとしては、以下のものがあります。

  • Ant: build.xml。 ./output/ フォルダーに出力をビルドします。
  • Gradle: /build.gradle。これは、 . フォルダーに出力をビルドします。
  • Grunt: . フォルダーに出力をビルドする /Gruntfile.js
  • Maven: /pom.xml。これにより、 ./target/ フォルダーに出力がビルドされます。

パイプライン・ファイルの要件

ツールチェーン用のパイプラインを構成するには、.bluemix ディレクトリーに pipeline.yml ファイルを配置します。 ツールチェーンがインスタンス化されると、そのディレクトリー内の pipeline.yml ファイルごとにパイプラインが作成されます。

パイプライン・ファイルを作成するには、 カスタム・ツールチェーン・テンプレートの作成 の資料にあるサンプル・ファイルを参照してください。 Web インターフェースでパイプラインを定義する場合と同様に、ステージとジョブを作成し、入力と環境変数を設定し、スクリプトを追加することによって、テキストでパイプラインを定義します。 また、 このデモンストレーション・プロジェクトで、より複雑なパイプライン・ファイルをいくつか確認することもできます。

コンテナー Dockerfile の要件

IBM Cloud Kubernetes Service を使用してアプリをコンテナーにデプロイするには、リポジトリーのルート・ディレクトリーに Dockerfile を含め、.bluemix ディレクトリーに pipeline.yml ファイルを含める必要があります。

Dockerfile は、アプリのビルド・スクリプトのようなものとして機能します。 リポジトリーで Dockerfile が検出されると、アプリは、コンテナーにデプロイされる前に自動的にイメージにビルドされます。 アプリがイメージにビルドされる前にアプリ自体をビルドする必要がある場合は、Dockerfile に加えてアプリのビルド・スクリプトを含めてください。

Dockerfile の作成について詳しくは、 Docker の資料を参照してください。 Kubernetesについて詳しくは、 IBM Cloud Kuberenete Serviceを参照してください。

コンテナー専用の pipeline.yml を手動で作成するには、 GitHubを参照してください。