本記事では、Linuxサーバー等にインストールされたLDAPディレクトリをOneLoginへ同期するためのLDAP Directory Connector(LDC)アプリケーションのバージョンアップデート手順をご案内します。
OneLogin の管理ポータルだけでLDCインスタンスのバージョンアップデートはできません。リモートアップデートは対応していないため、新規LDCインスタンスのセットアップと同様の手順で、主にLDCがインストールされたサーバー上での操作が必要です。必ず作業開始前に、手順全体をご確認ください。
目次
アップデートにあたっての注意点
アップデート作業の開始前に、お客様の現在のLDCインスタンスご利用状況別に注意点がございます。
1. LDCインスタンスが2台以上接続されている場合
LDAPのディレクトリ連携で上記画面のように2台以上のLDCインスタンスを接続しているお客様は、最初にスタンバイ状態のLDCインスタンスからアップグレードを開始し、アップグレードが完了したスタンバイのLDCインスタンスをアクティブに昇格させてから、次にもともとアクティブだったLDCインスタンスのアップデートを実施するなど、ローテーションさせながらアップデート処理を行われることをお勧めいたします。
上記画面例では、ldap-01.pentio-dev.local がアクティブなプライマリインスタンス、ldap-02.pentio-dev.local がスタンバイなセカンダリインスタンスです。基本的には一番上に表示されているインスタンスがプライマリ/アクティブとなります。
2. LDCインスタンスが1台しか接続されていない場合
LDCインスタンスが1台しかないお客様は、LDCインスタンスのアップデートに伴い一時的にOneLoginからLDCインスタンスへの認証要求が疎通しなくなるため、必ず作業前に Directory fallback password cache 機能が有効であることをご確認ください。この機能が有効である限り、疎通出来ない状態となってもOneLoginのログイン画面でログインしたことがあるユーザーは最後にログイン成功したパスワードハッシュがOneLoginにキャッシュされており、切断状態でもOneLoginへのログインを正常に継続利用いただくことが可能です。
LDCのアップデート
-
まずはターミナルソフトでOneLogin LDCコネクタのアプリケーションが保存されている onelogin-ldc-X.X.XX という命名規則のディレクトリへ移動します。この手順では例として v2.3.22 から v2.3.25 へのアップデートを取り扱います。
-
次に現在使用しているLDCコネクタのアプリケーションを停止し、OneLoginとの同期を強制的に停止します。各OSごとのコネクタ停止コマンドは下記のとおりです。
-
Windows:
.¥bin¥stop-ldc.bat
例)C:\Program Files\OneLogin\onelogin-ldc-X.X.XX> .\bin\stop-ldc.bat -
macOS, Linux, Unix:
./bin/stop-ldc.sh
例)admin@ldap-01:/opt/onelogin/onelogin-ldc-X.X.XX$ ./bin/stop-ldc.sh
-
-
ディレクトリ内の設定ファイル
conf/ldc.confを別の適当なディレクトリにコピーします
例)admin@ldap-01:/opt/onelogin/onelogin-ldc-X.X.XX$ cp conf/ldc.conf /var/tmp/ldc.conf -
現在まで利用していたバージョンのコネクタデータを一式削除します
例)admin@ldap-01:/opt/onelogin$ rm -rf onelogin-ldc-X.X.XX OneLoginへ管理者アカウントでログインし、 管理 > Users > Directories からアップデートを行うLDAPディレクトリを選択します
Connector Instances タブ を選択し、アップデートを行うLDCインスタンスを選択してLDCインスタンスの詳細画面を開きます
がバックアップした
conf/ldc.confの24行目に記載されているトークンと一致していることを確認します
OneLoginから最新版のLDCアプリケーションデータをダウンロードします
主なダウンロード方法としては下記2つがあります
1. 管理ポータルからダウンロードしてLDCインスタンスへ転送する
2. LDCインスタンス上で wget 等のコマンドを利用して直接ダウンロードする
(1) 管理ポータルからダウンロードする場合
[⤓ Download]をクリックし、自端末にダウンロードしたらZIPファイルをLDCインスタンスへ SCP や FTP など任意の方法を利用して転送します
(2) wget 等のコマンドを利用して直接ダウンロードする場合
例)admin@ldap-01:/opt/onelogin$ wget https://app.onelogin.com/onelogin-downloads/ldc/2_3_25_6/onelogin-ldc-X.X.XX.zip
ダウンロードしたZIPファイルをunzip等を利用して解凍します
例)admin@ldap-01:/opt/onelogin$ unzip onelogin-ldc-X.X.XX.zip
- 正常に展開されると onelogin-ldc-2.3.25 のように最新版のLDCアプリケーションが格納されたディレクトリが追加されます。ディレクトリに入っている設定ファイル
conf/ldc.confをさきほど/var/tmp/ldc.confへ保存した設定ファイルに置き換え、Installation Token やその他のカスタマイズされた設定を復元します
例)admin@ldap-01:/opt/onelogin$ cp -f /var/tmp/ldc.conf onelogin-ldc-X.X.XX/conf/ldc.conf
- 最後に LDCインスタンスを起動するコマンドを実行し、OneLogin 管理ポータル上でLDCインスタンスが Connceted 表示に戻っていること、Version がアップデートしたバージョンとなっているか、Sync status に Can reach LDAP と表示されているかをご確認ください
LDCのアップデートは以上です。