2.6. カスタムのコア Heat テンプレートの使用

オーバークラウドの作成時に、director は /usr/share/openstack-tripleo-heat-templates にある Heat テンプレートのコアセットを使用します。このコアテンプレートコレクションをカスタマイズするには、git ワークフローで変更をトラッキングして更新をマージしてください。以下の git プロセスを使用すると、カスタムテンプレートコレクションの管理に役立ちます。

カスタムテンプレートコレクションの初期化

以下の手順に従って、Heat テンプレートコレクションを格納する初期 git リポジトリーを作成します。

  1. テンプレートコレクションを stack ユーザーのディレクトリーにコピーします。以下の例では、コレクションを ~/templates ディレクトリーにコピーします。 

    $ cd ~/templates
$ cp -r /usr/share/openstack-tripleo-heat-templates .

  2. カスタムテンプレートのディレクトリーに移動して git リポジトリーを初期化します。 

    $ cd openstack-tripleo-heat-templates
$ git init .

  3. Git のユーザー名およびメールアドレスを設定します。 

    $ git config --global user.name "<USER_NAME>"
$ git config --global user.email "<EMAIL_ADDRESS>"

    <USER_NAME> を使用するユーザー名に置き換えます。<EMAIL_ADDRESS> をご自分のメールアドレスに置き換えます。

  4. 初期コミットに向けて全テンプレートをステージします。 

    $ git add *

  5. 初期コミットを作成します。 

    $ git commit -m "Initial creation of custom core heat templates"

最新のコアテンプレートコレクションを格納する初期 master ブランチを作成します。このブランチは、カスタムブランチのベースとして使用し、新規テンプレートバージョンをこのブランチにマージします。

カスタムブランチの作成と変更のコミット

カスタムブランチを使用して、コアテンプレートコレクションの変更を保管します。以下の手順に従って my-customizations ブランチを作成し、カスタマイズを追加します。

  1. my-customizations ブランチを作成して、そのブランチに切り替えます。 

    $ git checkout -b my-customizations
  2. カスタムブランチ内のファイルを編集します。

  3. 変更を git にステージします。 

    $ git add [edited files]

  4. カスタムブランチに変更をコミットします。 

    $ git commit -m "[Commit message for custom changes]"

このコマンドにより、変更がコミットとして my-customizations ブランチに追加されます。master ブランチを更新するには、master から my-customizations にリベースすると、git はこれらのコミットを更新されたテンプレートに追加します。これは、カスタマイズをトラッキングして、今後テンプレートが更新された際にそれらを再生するのに役立ちます。

カスタムテンプレートコレクションの更新

アンダークラウドの更新時には、openstack-tripleo-heat-templates パッケージも更新される可能性があります。このような場合には、以下の手順に従ってカスタムテンプレートコレクションを更新してください。

  1. openstack-tripleo-heat-templates パッケージのバージョンを環境変数として保存します。 

    $ export PACKAGE=$(rpm -qv openstack-tripleo-heat-templates)

  2. テンプレートコレクションのディレクトリーに移動して、更新されたテンプレート用に新規ブランチを作成します。 

    $ cd ~/templates/openstack-tripleo-heat-templates
$ git checkout -b $PACKAGE

  3. そのブランチの全ファイルを削除して、新しいバージョンに置き換えます。 

    $ git rm -rf *
$ cp -r /usr/share/openstack-tripleo-heat-templates/* .

  4. 初期コミット用にすべてのテンプレートを追加します。 

    $ git add *

  5. パッケージ更新のコミットを作成します。 

    $ git commit -m "Updates for $PACKAGE"

  6. このブランチを master にマージします。git 管理システム (例: GitLab) を使用している場合には、管理ワークフローを使用してください。git をローカルで使用している場合には、master ブランチに切り替えてから git merge コマンドを実行してマージします。 

    $ git checkout master
$ git merge $PACKAGE

master ブランチに最新のコアテンプレートコレクションが含まれるようになりました。これで、my-customization ブランチを更新されたコレクションからリベースできます。

カスタムブランチのリベース

以下の手順に従って my-customization ブランチを更新します。

  1. my-customizations ブランチに切り替えます。 

    $ git checkout my-customizations

  2. このブランチを master からリベースします。 

    $ git rebase master

これにより、my-customizations ブランチが更新され、このブランチに追加されたカスタムコミットが再生されます。

リベース中に git で競合が発生した場合には、以下の手順を実行します。

  1. どのファイルで競合が発生しているかを確認します。 

    $ git status
  2. 特定したテンプレートファイルで競合を解決します。

  3. 解決したファイルを追加します。 

    $ git add [resolved files]

  4. リベースを続行します。 

    $ git rebase --continue

カスタムテンプレートのデプロイメント

以下の手順に従って、カスタムテンプレートコレクションをデプロイします。

  1. 必ず my-customization ブランチに切り替えた状態にします。 

    git checkout my-customizations

  2. openstack overcloud deploy コマンドに --templates オプションを付けて、ローカルのテンプレートディレクトリーを指定して実行します。 

    $ openstack overcloud deploy --templates /home/stack/templates/openstack-tripleo-heat-templates [OTHER OPTIONS]
注記

ディレクトリーの指定をせずに --templates オプションを使用すると、director はデフォルトのテンプレートディレクトリー (/usr/share/openstack-tripleo-heat-templates) を使用します。

重要

Red Hat は、Heat テンプレートコレクションを変更する代わりに「4章設定フック」に記載の方法を使用することを推奨します。