sync.ymlファイルを使用したSynchronizerのインストール
次のセクションでは、/opt/sync/conf/sync.ymlファイルを使用してSynchronizerパラメーターの値を定義する方法について説明します。これは、自動 (単純な環境の場合) または手動 (複雑な環境の場合) で実行できます。
完了したら、インストールスクリプトを実行します。
単純な環境で値を自動的に入力します
単純な環境 (たとえば、Synchronizerのテスト) では、ALM Octaneサーバーでスクリプトを実行して、/opt/sync/conf/sync.ymlファイル内のパラメーターを、標準設定のALM Octane設定値を使用して自動的に入力できます。スクリプトは、ALM Octaneインストールファイルから値を取得し、それらを使用してSynchronizerパラメーターに標準設定値を入力します。
-
ALM Octaneサーバーで次のコマンドを実行します。
/opt/octane/install/enablesync.sh http://<Synchronizer host>:<Synchronizer port>/
-
スクリプトはsync.ymlファイルを生成します。このファイルを/opt/sync/conf/にコピーして、既存のsync.ymlを置き換えます。
-
必要に応じて、Synchronizerパラメーターリファレンスの説明に従って、環境に一致するようにsync.ymlの値を編集します。
たとえば、スクリプトはSynchronizerが/opt/sync /にインストールされていることを前提としており、ポート8080を使用します。別のポートを使用する場合は、sync.ymlで対応する値を編集します。
複雑な本稼動環境で値を手動で定義する
クラスタノードを含む複雑な本稼動環境で作業している場合は、/opt/sync/conf/sync.ymlパラメーター値を手動で定義する必要があります。
Synchronizerパラメーターリファレンスの説明に従ってパラメーターを入力します。
注: SSOモードで作業している場合は、SSOでのSynchronizerの使用も参照してください。
Synchronizerのインストールと起動
これで、Synchronizerをインストールして、Synchronizerサービスを開始できます。
-
sync.ymlファイルのバックアップコピーを保存します。次のステップでinstall.shを実行すると、パスワードなどの機密データが暗号化された値に置き換えられ、暗号化シードがsync.ymlファイルから削除されます。インストールが失敗した場合に、バックアップファイルを復元して、問題のトラブルシューティングを行うことができます。
-
/opt/sync/installで、適切なユーザーを使ってinstall.shスクリプトを実行します (必要に応じて、install.shを実行可能に設定します)。
- 注:
-
install.shスクリプトを実行する前に、ALM Octaneが実行されていることを確認します。
-
セキュリティで保護されたチャネルを介してサーバーに接続する必要がある場合は、install.shスクリプトを実行する前に信頼を設定します。詳細については、信頼の設定を参照してください。
sudoコマンドを使用してスクリプトをrootとして実行する場合は、rootユーザーに必要な環境変数 (主にJAVA_HOME) を設定するか、次のようにsudoコマンドで-Eオプションを使用します:
sudo -E ./install.sh
これにより、データベースの設定を行うセットアップツールが実行され、ディストリビューション内の各種設定ファイルに設定が入力されます。また、rootで実行した場合は、サービスがOSサービスとして登録されます。
-
-
Synchronizerサービスを開始します。
<install_dir>/wrapper/octane-sync start
または、次のコマンドを実行します。
service octane-sync start
成功を確認するには、Synchronizerサービスログを確認します。/opt/sync/logs/wrapper.log
また、コマンド
tail -f /opt/sync/logs/wrapper.log
を実行し、server readyというメッセージが表示されるのを待機することもできます。
SSOでのSynchronizerの使用
次の手順により、SSOでSynchronizerを使用できます。これには、APIキーとサイト管理者のロールを持つシークレットが必要です。
以前のバージョンのALM Octaneからアップグレードし、以前に事前のAPIキーとシークレットを生成した場合、アクションは実行されません。
SynchronizerをSSOで使用するには:
-
SSOを使用してサイト管理者としてALM Octaneにログインし、APIアクセスキーを生成します。
- [管理者設定] セクションで、スペースを選択します。
- [サイト] 領域で、[APIアクセス] タブを開きます。
- + APIアクセスをクリックします。
- [APIアクセスの追加] ダイアログボックスで、名前と説明を入力します。
- 追加をクリックします。ポップアップウィンドウは、アクセスが登録されたことを示します。クライアントIDとシークレットをクリップボードにコピーします。
-
sync.ymlファイルで、分散キャッシュセクションの後に新しいセクションを追加し、この新しいセクションの前後に空白行を追加します。次のテキストをコピーして、対応する値を入力します。
sp: authenticationType: sso ssoSpBaseUrl: <AUTHENTICATION_SERVICE_URL> ssoOauthClientId: <THE_CLIENT_ID> ssoOauthClientSecret: <THE_CLIENT_SECRET>
ssoSpBaseUrl、ssoOauthClientId、およびssoOauthClientSecretの値は、sso.confファイルの値と一致する必要があることに注意してください。
-
IntegrationセクションのフィールドserviceApiKeyとserviceApiSecretに、サイト管理者のロールを持つAPIキーとシークレットが含まれていることを確認します。
-
ssoセクションのプロパティ:redirectToAuthPageUrl、master、domain、loginUrl、およびlogoutUrlは削除できます。InitStringを削除しないでください。
次のステップ