Crowd 2.1 アップグレード ノート

2010-12-03 (Fri)  •  By 伊藤  •  ドキュメント  •  Crowd アップグレード ノート 翻訳

今回の記事は、Crowd 管理ドキュメント「Crowd 2.1 Upgrade Notes 」の弊社翻訳版です。原文と差異がある場合は、原文の内容が優先されます。

このドキュメントでは既存の Crowd インストールを Crowd 2.1 にアップグレードする際の注意点について説明します。このリリースの機能は「Crowd 2.1 リリース ノート」で確認できます。

このページの内容 :

  • アップグレード ノート
    • アップグレード時に既定で LDAP キャッシュが無効に – 必要に応じて有効にしてください
    • 複数のディレクトリがアプリケーションにマッピングされる際の承認動作の変更
    • ディレクトリでのアクティブ/非アクティブ設定が有効に
    • Apache と Subversion コネクタのアップグレード
    • カスタム アプリケーション コネクタのアップグレード
    • イベント リスナー プラグインに対する API の変更
    • 以前のプロトタイプ REST API が利用停止に
    • Crowd のロールが非推奨に
    • Crowd が背景で実行されるように
  • アップグレード手順

アップグレード ノート

以下のセクションをお読みになり、注意点がお使いの Crowd インストールに当てはまる場合は Crowd の新しいリリースにアップグレードする前に措置を講じてください。

アップグレード時に既定で LDAP キャッシュが無効に – 必要に応じて有効にしてください

リリース ノート に説明されているように、Crowd 2.1 では全 LDAP ディレクトリに対してデータベースによるキャッシングが導入されました。新しいディレクトリ コネクタについては、キャッシングが既定で有効になっています。Crowd 2.1 にアップグレードする場合、既存のディレクトリでは既定でキャッシングが無効になっています。

注意 : 10,000 ほどのユーザーを含むディレクトリのデータベース キャッシングを最適化しました。ディレクトリが非常に大きい場合、新しいキャッシングは有用でないことがあります。ユーザー ベースが非常に大きい場合、キャッシングを無効にすることをお勧めします。

既存の LDAP ディレクトリの新しいキャッシングを利用するには、以下を行ってください。

  • ディレクトリ コネクタの [詳細 (Details)] タブで各ディレクトリのキャッシュを有効にします。
  • [コネクタ (Connector)] タブでポーリング間隔を設定します。「LDAP ディレクトリのキャッシングの設定 」を参照してください。

複数のディレクトリがアプリケーションにマッピングされる際の承認動作の変更

アプリケーションに複数のディレクトリがマッピングされている場合に Crowd がグループ メンバーシップを確認する方法を変更しました。

注意 : この変更はディレクトリ間で重複するユーザー名を持ち、複数のディレクトリが 1 つのアプリケーションにマッピングされている構成にのみ影響を与えます。

Crowd の以前のバージョンでは、認証はユーザー名を含む最初のディレクトリで行われ、グループ メンバーシップはディレクトリをまたいで集計されました。つまり、

  • ユーザー認証について、Crowd はアプリケーションごとに指定した順序でディレクトリを検索し、そのユーザーが最初に現れた際の資格情報を使用しました。
  • グループ メンバーシップに基づいてアプリケーションへのアクセスをユーザーに付与する際、Crowd はユーザー名が現れた全ディレクトリ内のグループ メンバーシップを合わせます。
  • 以下のドキュメントで Crowd 2.0 の操作の詳細を参照してください : 「Crowd による複数ディレクトリの管理方法について

Crowd 2.1 およびそれ以降では、ユーザー名を含む最初のディレクトリに対して認証が行われ、そのユーザーのグループ メンバーシップは同じディレクトリから取得されます。つまり、

  • ユーザー認証については動作は変更ありません (上記参照)。
  • グループ メンバーシップに基づいてアプリケーションへのアクセスをユーザーに付与する際、Crowd はアプリケーションにマッピングされているディレクトリの順序に基づいて、ユーザー名が現れる最初のディレクトリでのみグループ メンバーシップを探します。
  • 以下のドキュメントで Crowd 2.1 の操作の詳細を参照してください : 「Crowd による複数ディレクトリの管理方法について

やるべきこと : ディレクトリが各アプリケーションにマッピングされる順序を確認してください。「アプリケーションのディレクトリ順序の指定 」を参照してください。

ディレクトリでのアクティブ/非アクティブ設定が有効に

Crowd の以前のバージョンでは、ディレクトリ コネクタの [詳細 (Details)] タブの ‘アクティブ’ 設定は効果がありませんでした。Crowd 2.1 では、この設定は全ディレクトリの種類に対して効力を持ちます。例については、内部ディレクトリの設定 に関するドキュメントを参照してください。ディレクトリが ‘アクティブ’ としてマーキングされていない場合は非アクティブです。

非アクティブ ディレクトリには以下の特徴があります。

  • ユーザー、グループ、またはメンバーシップを検索する際には含まれません。
  • Crowd 管理コンソール画面には引き続き表示されます。

Apache と Subversion コネクタのアップグレード

Crowd 2.1 には Apache/SVN コネクタの改善されたバージョンがあります。改善点の詳細については リリース ノート を参照してください。コネクタの新しいバージョンを使用するには、設定を更新する必要があります。こちらの指示 に従って、作業を続行する前にコネクタの以前のバージョンを無効にしてください。詳細については、「Crowd と Apache の統合 」を参照してください。

なお、既存の Apache/SVN コネクタは Crowd 2.1 でも動作します。つまり、準備が整うまではコネクタをアップグレードする必要はありません。アップグレードしない場合、新しいコネクタによって提供される改善点を活用できません。

カスタム アプリケーション コネクタのアップグレード

カスタム アプリケーション コネクタを使用している場合は、以下の点に注意してください。

  • Crowd 2.0.7 クライアントを Crowd 2.1 サーバーに接続できます。SOAP API に完全な下位互換性があるためです。
  • 新しい REST API を使用できるように、クライアントをバージョン 2.1 にアップグレードすることをお勧めします。一部のクラスがクライアント JAR 内の別のパッケージに移動したため、アプリケーションの再コンパイルが必要です。

Crowd 2.1 Java クライアント移行ガイド 」を参照してください。

イベント リスナー プラグインに対する API の変更

Crowd 2.1 およびそれ以降では、Crowd イベントは注釈ベースです。つまり、 com.atlassian.event.api.EventListener 注釈をメソッドに使用して注釈ベースのイベント リスナーを記述する必要があります。com.atlassian.event.EventListener インターフェイスの実装はサポート対象が委任ありました。イベント リスナー プラグイン に関するドキュメントを参照してください。

以前のプロトタイプ REST API が利用停止に

Crowd 2.0 には ‘admin’ という実験的な REST API が導入され、Crowd 管理コンソールとの相互作用が可能でした。この API は使用できなくなりました。代わりに Crowd 2.1 で新しい一連の ‘usermanagement’ REST API が採用され、Crowd に接続するアプリケーションで使用されるようになりました。

新しい REST API で利用できる機能のまとめについては、リリース ノート を参照してください。

以下が Crowd 2.0 REST API で利用でき、新しい REST API で利用できなくなった機能です。

  • ディレクトリの一覧の取得
  • 基本的なディレクトリ情報の取得
  • ディレクトリごとの操作の実行。目的のディレクトリのみにマッピングするアプリケーションを作成することで似たような操作を行えます。

旧 REST API および 新しい REST API のドキュメントを参照してください。

Crowd のロールが非推奨に

以前 お知らせ したように、今回のバージョンの Crowd ではロールの使用をお勧めしません。Crowd 2.1 でのロールの機能に変更はありませんが、計画されているロール機能の再設計の悪影響を受けないように、Crowd インストールではロールの使用を避けることをお勧めします。LDAP ディレクトリを新規作成するときにはロールは既定で無効に設定されています。

現時点では、Crowd でのロールの実装はグループの実装と同様です。この設計ではあまり有用な機能を提供できないため、Crowd がロールをサポートする方法を再設計する予定です。ロール ベースのアクセス制御の再設計に関してお手伝いいただける場合は、改善リクエスト CWD-931 にコメントを追加してご要望をお寄せください。

Crowd が背景で実行されるように

Crowd が背景で実行できるように Crowd の起動スクリプト (start_crowd.bat および start_crowd.sh) を変更しました。また、stop_crowd.batstop_crowd.sh という Crowd を停止するための新しいスクリプトも追加しました。

なお、OS X と Linux では、Ctrl-C を使用して Crowd サーバーを停止することはできなくなりました。代わりに stop_crowd.sh スクリプトを使用してください。Windows では Crowd を起動すると 2 つ目のコマンド ウィンドウが表示され、そのウィンドウで Ctrl-C を使用して Crowd を停止できます。

アップグレード手順

Crowd 2.0.x またはそれ以前から Crowd 2.1.x にアップグレードするには、こちらのアップグレード手順に従ってください。


Related Articles

お気軽にお問い合わせください

お問い合わせ