More than 1 year has passed since last update.

Oracle Cloud InfrastructureAdvent Calendar 2021Day 5

OCI DevOps で Oracle Functions の CI/CD - パイプライン作成編

Last updated at 2022-01-19Posted at 2021-12-04

はじめに

こちらの記事は、Oracle Cloud Infrastructure Advent Calendar 2021 その 2 の Day 5 の記事として書かれています。
今回は、10 月後半に全機能が揃った OCI DevOps に関する記事です。OKE の方はきっと誰かが書いてくれることを願って私の方では Oracle Functions に特化した内容で書きたいと思います。内容が結構ボリューミーになりそうなので全 2 回に分けたいと思います。

2022/01/19 追記: Oracle Cloud Infrastructure(OCI) DevOpsことはじめ
OCI Tutorials に DevOps & OKE のハンズオンが追加されたので、OKE で同様の事を実施したい場合はこちらをご参照ください。

事前準備編
ビルド、デプロイメント・パイプライン作成編 ← 本記事はこれ

今回は、ビルド、デプロイメント・パイプライン作成編です。

今回作る環境

全 2 回を通してこのような環境を作ってみます。

ソースコード本体は、コミュニケーション機能（Issue, Wiki, etc.）が充実している GitHub, GitLab で管理し、バックアップを取るためにソースコードを Code Repository へミラーリングする実際の開発現場でよく取られそうな構成です。

実際に作ってみる

前提

OCI DevOps で Oracle Functions の CI/CD - 事前準備編が完了していること

ビルド・パイプライン

GitHub からのミラーリングの設定 ~ OCIR¹ に Oracle Functions の Docker Image を push する所までを作っていきます。図で表すと以下の赤線の箇所を作成していきます。

外部接続の定義

まずは、GitHub → Code Repository に対するミラーリングの設定を行うための接続定義を行います。OCI コンソール左上のハンバーガーメニューから開発者サービス > プロジェクトと選択します。

先ほど、作成した DevOps のプロジェクトの詳細画面から外部接続を選択します。

外部接続の作成を押し、以下のように入力して外部接続を新しく定義します。

名前: github-connection
タイプ: GitHub
ボールト・シークレット
- ボールト: 作成済みの Vault(GitHub の PAT が格納されている Vault を選択する)
- シークレット: GitHub の PAT

これで、ミラーリングのための外部接続設定は完了です。

リポジトリのミラーリング設定

ミラーリングの設定を行います。作成済みの DevOps プロジェクトの詳細画面からコード・リポジトリを選択します。

リポジトリのミラー化を選択します。

以下のように入力して、ミラー先のリポジトリを定義します。

接続: github-connection
リポジトリ: fn-examples
ミラーリング・スケジュール
- スケジュール・タイプ: カスタム
- ミラーリング間隔: 15 分(最短 1 分から設定可能なので、お好きな値に設定してください)
名前: github_fn-examples

これで、ミラー先のリポジトリの作成が完了です。

build_spec.yaml の作成

いよいよ、ビルドを行うための設定ファイルを書いていきます。build_spec.yaml の仕様に関しては OCI Document - ビルド指定をご参照ください。今回は、以下のような設定ファイルを fn-examples/fn-hello/に配置します。

build_spec.yaml

# https://docs.oracle.com/ja-jp/iaas/Content/devops/using/build_specs.htm
# build runner config
version: 0.1
component: build
timeoutInSeconds: 10000
shell: bash
env: # ... 1
  variables:
    function_name: fn-hello
    function_version: 0.0.2
  exportedVariables:
    - tag

# steps
steps:
  - type: Command
    name: "Docker image build"
    timeoutInSeconds: 4000
    command: |
      cd fn-hello
      fn build
      docker tag ${function_name}:${function_version} fn-hello-image
      tag=${function_version}
    onFailure:
      - type: Command
        command: |
          echo "Failure successfully handled"
        timeoutInSeconds: 60

outputArtifacts:
  - name: fn-hello-image
    type: DOCKER_IMAGE
    location: fn-hello-image

いくつか、ポイントがあるので簡単に補足します。

パイプライン中に使用する変数を定義しています。
- variables(パイプライン中に使用する変数)
  - function_name: 作成した関数名（fn-hello）
  - function_version: func.yaml に記載のある関数のバージョン
- exportedVariables(後続のステージに渡す変数を定義)
  - tag: 実際に OCIR に push されるときの Docker Image のバージョン
Docker Image のビルドを Fn CLI のビルドオプション（fn build）を用いて実施しています。また、作成される Docker Image は今回の場合だと fn-hello:0.0.2 という名前が付けられているので、それを docker tag ... で fn-hello-image に変更しています。次に、実際に push する際のバージョンを tag=${function_version}で設定し、アーティファクトの配信ステージで活用します。（単純に Commit Hash(${OCI_TRIGGER_COMMIT_HASH})を使うのでも良いと思います。）
次のステージ（アーティファクトの配信）で使うためのアーティファクトを指定します。

作成した build_spec.yaml は GitHub に push しておきます。

# ./fn-examples
git add fn-hello/build_spec.yaml

git commit -m "Added build_spec.yaml"

git push origin main

ビルド・パイプラインの作成

前工程で作成した build_spec.yaml を実際に適用するビルド・パイプラインを作成していきます。作成済みの DevOps プロジェクトの詳細画面からビルド・パイプラインを選択します。

ビルド・パイプラインの作成をクリックし、以下のように入力しビルド・パイプラインを新規に作成します。

名前: fn-hello-build-pipeline

作成したビルド・パイプラインの詳細画面でステージの追加を押し、新規にステージを作成します。

ステージ・タイプの選択でマネージド・ビルドを選択し、次を押します。

以下のように入力し、ビルド・ステージを追加します。

ステージ名: build_stage
ビルド指定ファイル・パス: fn-hello/build_spec.yaml
プライマリ・コード・リポジトリ
- ソース: 接続タイプ: github_fn-examples
- ブランチの選択: main
- ソース名の作成: fn-hello

次に、build_stage で生成し outputArtifact として出力した Oracle Functions の Docker Image を OCIR へプッシュするステージを作成します。build_stage 下の"+"アイコンをクリックし、ステージの追加を選択します。

ステージ・タイプとしてアーティファクトの配信を選択します。

以下のように入力します。

ステージ名: image_push
アーティファクトの作成を選択
- 名前: fn-hello-image
- タイプ: コンテナ・イメージ・リポジトリ
- コンテナ・レジストリへの完全修飾パス: <region-key>.ocir.io/<namespace>/devops/fn-hello:${tag}
  - <region-key>の詳細は、Oracle Cloud Infrastructure Registry へのログインをご参照ください
- このアーティファクトで使用するパラメータの置き換え: はい、プレースホルダーを置き換えます
ビルド構成/結果アーティファクト名: build_spec.yaml で outputArtifact として指定した名前（fn-hello-image）