最適化の概要

クラウド

Server v4.x

Server v3.x

このページの内容

このドキュメントでは、CircleCI 設定ファイルを最適化する方法をいくつか紹介します。各方法について簡単に説明し、ジョブを高速化するためのユースケースを紹介します。

ストレージコントロールのカスタマイズ

CircleCI Web アプリでは、ワークスペース、キャッシュ、アーティファクトのストレージ保存期間のカスタマイズをコントロールすることができます。この設定を確認するには、Plan > Usage Controls に移動します。デフォルトでは、保存期間はアーティファクトの場合は 30 日間、キャッシュやワークスペースの場合は 15 日間です。この日数はストレージの最大保存期間でもあります。アーティファクトの最大保存期間は 30 日間、キャッシュやワークスペースの最大保存期間は 15 日間です。

ストレージのカスタム設定の詳細は、データの永続化のページを参照してください。

Docker イメージの選択

プロジェクトに最適な Docker イメージを選択すると、ビルド時間が大幅に短縮されます。たとえば、言語の基本的なイメージを選択した場合は、パイプラインを実行するたびに依存関係とツールをダウンロードする必要があります。一方、それらの依存関係とツールが事前にインストールされているイメージを選択、ビルドした場合は、各ビルド実行時にダウンロードにかかる時間を節約できます。プロジェクトを設定し、イメージを指定するときには、以下の点を考慮してください。

CircleCI には多数の CircleCI イメージが用意されています。多くは公式の Docker イメージに基づいていますが、便利な言語ツールもプリインストールされています。
プロジェクトに特化した独自のイメージを作成することも可能です。そのサポートガイドとして、イメージを手動でビルドするためのガイドを提供しています。

Docker レイヤーキャッシュ

Docker レイヤーキャッシュは、ビルド内の Docker イメージの_ビルド時間_を短縮するのに役立つ機能です。日常的な CI/CD プロセスの中で頻繁に Docker イメージをビルドする場合、DLC は大変便利です。

DLC は、ジョブ内でビルドしたイメージレイヤーを_保存_し、それを後続のビルドで使用できるようにするという点で、前述の_依存関係のキャッシュ_に似ています。

詳細については、 Docker レイヤーキャッシュを参照してください。

依存関係のキャッシュ

ジョブの最適化にあたってまず検討すべき項目の 1 つがキャッシュです。ジョブで任意の時点のデータをフェッチする場合は、キャッシュを活用できる場合があります。一般的によく用いられるのが、パッケージマネージャーや依存関係管理ツールです。たとえば、プロジェクトで Yarn、Bundler、Pip などを利用すると、ジョブの実行中にダウンロードする依存関係は、ビルドのたびに再ダウンロードされるのではなく、後で使用できるようにキャッシュされます。

詳細については、依存関係のキャッシュガイドを参照してください。

ワークフロー

ワークフローは、一連のジョブとその実行順序を定義する機能です。設定の任意の時点で 2 つのジョブを互いに独立して実行しても問題のないステップがある場合は、ワークフローを使用すると便利です。ワークフローには、CI/CD を強化するための機能もいくつか用意されています。詳細については、ワークフローを参照してください。

ワークフローの例については、 CircleCI デモワークフローリポジトリを参照してください。

ワークスペース

ワークスペースを使用すると、_ダウンストリームジョブ_に必要な、_その実行に固有_のデータを渡せます。つまり、ワークスペースを使用して、ビルドの最初の段階で実行するジョブのデータをフェッチし、そのデータをビルドの後段で実行するジョブで_利用する_ことができます。

任意のジョブのデータを永続化し、 attach_workspace キーを使用してダウンストリームジョブで利用できるようにするには、 persist_to_workspace キーを使用するようにジョブを設定します。 persist_to_workspace の paths: プロパティに記述されたファイルとディレクトリは、root キーで指定しているディレクトリの相対パスとなるワークフローの一時ワークスペースにアップロードされます。その後、それらのファイルとディレクトリは、後続のジョブ (およびワークフローの再実行) で使用するためにアップロードされ、利用可能になります。

詳細については、ワークスペースを参照してください。

並列実行

プロジェクトに大規模なテストスイートがある場合は、 parallelismと CircleCI のテスト分割機能またはサードパーティのアプリケーションまたはライブラリを使用するようにビルドを設定し、テストを複数のマシンに分割することができます。 CircleCI では、複数のマシンにファイルごとに自動的にテストを割り当てることや、テストの割り当て方法を手動でカスタマイズすることも可能です。

テストの分割の詳細については、並列実行を参照してください。

リソースクラス

resource_class を使用すると、CPU と RAM のリソース量をジョブごとに指定できます。クラウド版 CircleCI でご利用いただけるリソースクラスの全オプションリストは、設定ファイルのリファレンスでご確認ください。 CircleCI Server 用の同リストについては、システム管理者にお問合せください。

リソースクラスの詳細については、リソースクラスの概要のページをお読みください。