サイト設定の構成

ALM Octane設定ファイルを使用してサイト設定を構成します。

  • octane.confの設定は、すべての環境で必須です。

  • さらに、複雑なALM Octane環境で必要な他の設定があります。これらには、以下で説明するように、安全なElasticsearch、プロキシ設定、およびLDAPまたはSSO認証が含まれます。

これらの設定項目はインストール時に設定します。また、必要なときにはいつでも変更できます。

ワークフロー

  1. octane.confファイルを編集して、基本設定を構成します。さらに、環境に応じて、次のセクションで説明するオプションのファイルを設定します。

    設定ファイルはALM Octaneをインストールするユーザー (通常、octaneユーザー) が読み取りおよび編集可能である必要があります。必要なインストールの権限を持たないrootユーザーやsudoerユーザーを使用して設定ファイルをコピーまたは編集した場合、インストールは失敗します。

    ヒント: 所有者を変更するには: chown <owner>:<group> <file>

    例:  chown octane:octane octane.conf

  2. ALM Octaneをインストールする場合は、編集後にコンフィギュレーションファイルは、ALM Octaneサーバーの起動を進めます。

  3. 後で構成ファイルを変更する必要がある場合は、octane.conf.newではなく、<リポジトリフォルダ>\conf\octane.confファイルを編集してください。これは内部使用のみを目的とした一時ファイルです。

    これらの設定を変更した後、各ノードでALM Octaneサーバーを再起動して、リポジトリから構成の変更をプルします。詳細については、ALM Octaneヘルプセンターのサーバーの再起動を参照してください。

    たとえば、最初にALM Octaneをインストールして標準のユーザー管理を使用し、後からユーザー管理にLDAP認証を導入することができます。

ヒント: 変更を行う前に、octane.confファイルのローカルコピーを作成することをお勧めします。また、セキュリティ上の理由から、octane.confは安全なオフサイトの場所に保管する必要があります。

トップに戻る

データベースサーバーの設定

設定 説明
db-type

ORACLEまたはMSSQLと入力します。
connection-string

Java Database Connectivity (JDBC) データベース接続文字列。これには、詳細情報として、データベースタイプ、データベースサーバー名、データベースサーバーのポート番号、サービス名が含まれます。

Oracle connection-string

以下の説明では、セキュリティ保護されていないデータベースアクセスで文字列をセットアップする手順を示します。データベースへの安全なアクセスを設定するには、OracleでのSSL/SSOの使用 (オプション)を参照してください。

サービス名を使用した構文:

jdbc:oracle:thin:@//DB_SERVER_NAME:DB_SERVER_PORT/DB_SERVICE_NAME

例:

  • jdbc:oracle:thin:@//dbserver1.net:1521/orcl
  • jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=dbserver1.net)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=orcl)))

注:

TNSを使用する構文については、OracleでのTNSエイリアス名の使用を参照してください。

Oracle RACに接続するには、データベースサーバー名の代わりにSingle Client Access Name (SCAN) を使用します。
 

SQL connection-string

  • ポートを使用した構文:

    jdbc:sqlserver://DB_SERVER_NAME:DB_SERVER_PORT

    例:

    jdbc:sqlserver://dbserver1:1433

  • インスタンスを使用した構文:

    jdbc:sqlserver://DB_SERVER_NAME;instanceName=INSTANCE_NAME

    例:

    jdbc:sqlserver://dbserver1;instanceName=my_instance
admin-user > name

ALM Octaneは、admin-userを使用して、インストール中にオブジェクトを作成し、データベースサーバーにアクセスできることを確認します。

  • Oracleの場合は、データベース管理者ユーザーの名前を入力します。
  • SQL Serverの場合は、saユーザー、または適切なアクセス許可を持つSQLServerパワーユーザーを入力します。

admin-user権限の詳細については、前提条件を参照してください。
admin-user >password

データベース管理者ユーザーのパスワード。

#記号やアクセント記号付き文字 (ä、ç、ñなど) は使用しないでください。

schemas > 
site

インストール時にadmin-userによって作成されるサイトスキーマ、または組織のDBAによって指定されるサイトスキーマの名前。指定された名前を入力します。

schemas > 

initial-shared-space

このパラメーターは、FILL_EXISTINGサイトアクションにのみ関連します。

FILL_EXISTINGを使用している場合は、initial-shared-spaceをスペースに指定されているスキーマの名前に設定します。

OracleでのSSL/SSOの使用 (オプション)

SSLまたはSSOを使用して、ALM Octaneサーバーからデータベースサーバーへの安全な接続を設定できます。

  1. OracleネイティブJDBCを標準設定のJavaドライバーとして定義します。

    1. ファイル<Java Home>\jre\lib\security\java.securityを開きます。

    2. jdk.tls.disabledAlgorithmsを検索し、その行をコメントアウトします。

    3. security.providerを検索し、行com.sun.net.ssl.internal.ssl.Providerを見つけます。

    4. 前の行の上に行oracle.security.pki.OraclePKIProviderを追加し、プロバイダーの番号を変更します。

      例:

      # jdk.tls.disabledAlgorithms=SSLv3, RC4, DES, MD5withRSA, DH keySize < 1024, \

      EC keySize < 224, 3DES_EDE_CBC, anon, NULL

       

      security.provider.1=sun.security.provider.Sun

      security.provider.2=sun.security.rsa.SunRsaSign

      security.provider.3=sun.security.ec.SunEC

      security.provider.4=oracle.security.pki.OraclePKIProvider

      security.provider.5=com.sun.net.ssl.internal.ssl.Provider

      security.provider.6=com.sun.crypto.provider.SunJCE

  2. Oracleクライアントウォレットファイルをサーバー上のすべての人がアクセスできるディレクトリ (/opt/octane/conf/ewallet.p12など) に配置します。ALM Octaneには、このファイルへの読み取り権限が必要です。

  3. connection-stringパラメーターの後に、以下をoctane.confにコピーします。

    connection-properties : [
      {
          "key" : "javax.net.ssl.trustStore",
          "value" : "/opt/octane/conf/ewallet.p12"
      }
  ,
      {
          "key" : "javax.net.ssl.trustStoreType",
          "value" : "PKCS12"
      }
  ,
      {
          "key" : "javax.net.ssl.trustStorePassword",
          "value" : "********"
      }
  ]

  4. 上記の値を次のように置き換えます。

    • trustStore: ewallet.p12またはcwallet.sso証明書の場所を入力します。

    • trustStoreType: PKCS12またはSSO。

    • trustStorePassword: (SSLの場合のみ) キーストアファイルを開くために使用するパスワードを入力します。

OracleでのTNSエイリアス名の使用

TNSを使用する場合は、次の手順を実行します。

  1. Oracle接続の説明を使用してtnsnames.oraファイルを作成します。ALM Octaneには、ファイルへの読み取り権限が必要です。

    例: 

    orcl =
  (DESCRIPTION =
    (ADDRESS = (PROTOCOL = TCP)(HOST = myhost.net)(PORT = 1521))
    (CONNECT_DATA =
      (SERVER = DEDICATED)
      (SERVICE_NAME = orcl)
    )
  )

  2. connection-stringパラメーターを次のように定義します。

    jdbc:oracle:thin:@<tns_server_name>

    例:

    jdbc:oracle:thin:@orcl

  3. connection-stringパラメーターの後に、以下をoctane.confにコピーします。

    connection-properties : [
      {
          "key" : "oracle.net.tns_admin",
          "value" : "/opt/octane/conf/tnsnames.ora"
      }
   ]

  4. connection-propertiesで、tnsnames.oraファイルの場所を使用して値を定義します。

トップに戻る

Oracleサーバーの設定

Oracleの設定 説明
スキーマパスワード

サイトスキーマのパスワード。

既存のサイトスキーマを使用 (FILL_EXISTINGサイトアクションを使用) してインストールを行う場合は、DBAがサイトスキーマとスペーススキーマに対して定義するパスワードが、このschema-passwordと一致している必要があります。
table-space

サイトスキーマセグメントが作成されるOracleデータベースの表領域。大文字と小文字が区別されます。
temp-table-space Oracleデータベースの一時表領域。大文字と小文字が区別されます。
user-default-sort

非ラテン言語サポートのために、標準のOracleバイナリソート (NLS_SORT="BINARY_CI") をオーバーライドするかどうかを定義します。

有効な値:yes、no、または空白

標準設定: 空白 (はい) 

トップに戻る

SQLサーバーの設定

SQLサーバーの設定 説明

app-user >name

ALM Octane用のMSSQLデータベースログイン認証ユーザー。これは、日常のALM Octaneで使用するユーザーです。

このログインは、ALM Octaneのサイトおよびスペースのデータベースに関連付けられています。

注: これは、admin-user >nameとは異なる必要があります。ただし、FILL_EXISTINGを使用している場合、これはadmin-user名と同じである必要があります。

app-user >password

app-userのパスワード。

FILL_EXISTINGを使用している場合、これはadmin-userパスワードと同じである必要があります。
authentication-method 使用する認証方法を入力します。WindowsまたはDB(SQL Server認証)。

トップに戻る

サイトアクション

site-action設定は、インストールでデータベースを処理する方法を決定します。

CREATE_NEW

このサイトアクションは、新規インストールに使用します。

  • 新規サイトスキーマの作成、新規スペーススキーマの作成、および現在のノードの設定を行います。
  • 新しいスキーマを作成できるのは、スキーマの作成権限を持つadmin-userのみです。

  • 作成するスキーマがすでに存在する場合、CREATE_NEWサイトアクションは失敗します。
FILL_EXISTING

データベース管理者がスキーマ (Oracleの場合) またはデータベース (SQL Serverの場合) を作成する権限を与えていない場合は、このサイトアクションを新規インストールに使用します。

この場合、組織のDBAはインストールする前に、新しいサイトとスペースのスキーマ/データベースとユーザーを作成する必要があります。 

詳細については、以下を参照してください。

スキーマ例外の処理

組織のDBAがテーブルやカラムの追加など、スキーマに変更を加えた場合は、例外ファイルを定義できます。例外ファイルは、ALM Octaneに、インストールおよびアップグレード中にデータベースユーザースキーマへの手動変更を無視するように指示します。詳細については、データベースの手動変更に例外ファイルを使用するを参照してください。

トップに戻る

スペースの設定

initial-space-mode

ALM Octaneサーバーの起動時に初期スペースが作成されるモード。有効な値は次のとおりです。 

  • isolated: 初期スペースに関連付けられたワークスペースで、エンティティまたはカスタマイズ設定を共有しません。

  • shared: 初期スペースに関連付けられたワークスペースで、エンティティまたはカスタマイズ設定を共有できます。

トップに戻る

Elasticsearchの設定

動作するElasticsearchサーバーは、ALM Octaneを操作するための要件です。Elasticsearchの前提条件の詳細については、Elasticsearchの設定を参照してください。

hosts

Elasticsearchを実行しているホストの名前。

Elasticsearchクラスターを実行している場合は、次のように、すべてのノードホスト名をコンマで区切る必要があります。

["host1","host2","host3"]
http-port 着信HTTPリクエスト用にElasticsearchで設定されたポート。Elasticsearchの標準設定は9200です。
cluster-name

Elasticsearchクラスターの名前。

Elasticsearchのセキュリティ (オプション)

TLSを使用して、ALM OctaneをElasticsearchに安全に接続できます。詳細については、ALMOctaneとElasticsearch用のTLSの設定を参照してください。

  1. octane.confファイルに次の行があることを確認してください。 

    include "elasticsearch-security.conf"

  2. elasticsearch-security.confファイルを次のように設定します。

user

  • name: Elasticsearchに対して認証するときに使用するユーザー名。

  • password: Elasticsearchユーザーのパスワード。
key-store

  • file: PKCS12キーストアファイルの名前。ファイルは構成フォルダーに配置する必要があります。

  • password(オプション、暗号化): ストアがパスワードで保護されている場合にキーストアファイルを開くために使用するパスワード。

  • keystore type: 証明書ファイルはPKCS12形式である必要があり、構成フォルダーに配置する必要があります。
トラストストア

  • file: PKCS12トラストストアファイルの名前。ファイルは構成フォルダーに配置する必要があります。

  • password(オプション、暗号化): ストアがパスワードで保護されている場合にトラストストアファイルを開くために使用するパスワード。

  • keystore type: 証明書ファイルはPKCS12形式である必要があり、構成フォルダーに配置する必要があります。
verification-mode

証明書を検証するときに使用するレベルを決定します。標準設定設定を使用することをお勧めします。

  • none: 証明書の検証チェックは行われません。これは、すべての証明書がアクセスされ、問題をデバッグするためにのみ訴えられるべきであることを意味します。

  • certificate: 証明書が信頼できるCAによって署名されていることのみを確認します。ホストが動的な場合に使用する必要があります。

  • full: 証明書に加えて、証明書によって報告されたホスト名が要求の送信元のホストと一致することも確認します。可能な限り使用する必要があり、標準設定です。

トップに戻る

サイト管理者の資格情報

site-administrator > name

インストールで作成されるサイト管理者ユーザーの電子メール。

ここで指定する電子メールアドレスは、後から作成することができます。

これは、インストール後に利用可能な唯一のユーザーです。他のユーザーは後から追加できます。

LDAPやSSOなどの外部ユーザー認証を使用する場合、この管理者は外部システムの既存のユーザー (それぞれ、LDAPまたはIdP) である必要があります。
site-administrator > password

サイト管理者のパスワード。パスワードは、長さが8文字以上で、少なくとも1個の英大文字、少なくとも1個の英小文字、および少なくとも1個の数字または記号を含める必要があります。

#記号やアクセント記号付き文字 (ä、ç、ñなど) は使用しないでください。

LDAPやSSOなどの外部ユーザー認証を使用する場合、このパスワードは「ダミー」パスワードとして定義する必要があります。ALM Octaneが外部認証用に設定された後は使用されません。

トップに戻る

クラスター設定

スタンドアロンのALM Octaneサーバーまたはクラスター構成をインストールする場合に確立するために使用する必要のあるいくつかの設定を次に示します。クラスタ構成の詳細については、クラスターのインストールの流れを参照してください。

single-server

サーバーがスタンドアロンであるかクラスター構成であるか。

必須。

  • スタンドアロンサーバーの場合、この値をtrueに設定し、nodes設定を使用してホスト名を入力しないでください。

  • クラスター構成の場合、この値をfalseに設定します。nodes設定にノードホスト名を入力する必要があります。
nodes

各クラスターノードのIPアドレスまたは完全修飾ドメイン名を設定します。

クラスター内のノードホスト名またはIPのコンマ区切りリストを入力します。次に例を示します。

["host1","host2","host3"]

single-serverがfalseに設定されていることを確認してください。

トップに戻る

ヒープサイズ

ヒープサイズ

ALM Octaneサーバーを最初に起動する前に、すべてのアクティブなクラスターノードでヒープメモリの値を変更します。

たとえば、ALM Octaneのアクティブなワークスペースの数が増加する場合や、同時ユーザーセッション数が増加する場合には、ヒープサイズを大きくする必要があります。

heapSizeは、負荷に関係なく、専用サーバー上の使用可能なメモリの半分に設定してください。

ヒープサイズは31GBを超えないようにします。

値はMB単位で指定します (たとえば、4GBの場合は4096)。

標準設定: 4096

トップに戻る

プロキシ設定 (オプション)

ALM Octaneがファイアウォールの内側にあり、外部のサーバーにアクセスする必要がある場合は、プロキシサーバーを使用するようALM Octaneを設定する必要があります。

  1. octane.confファイルに次の行があることを確認してください。 

    include "proxy.conf"

  2. proxy.confファイルを次のように設定します。

http

  • host: プロキシホスト (HTTPを使用している場合)。

  • port: プロキシポート (HTTPを使用している場合)。
https

  • host: プロキシホスト (HTTPSを使用している場合)。

  • port: プロキシポート (HTTPSを使用している場合)。
user

  • name: プロキシにアクセスするユーザー名。

  • password: プロキシユーザーのパスワード。
非プロキシホスト

 

トップに戻る

パブリックURLとサーバーポート

ヒント: 安全な接続を使用して、本番環境で常にOctaneを実行することをお勧めします。構成のヒントを参照してください。

server-bindingセクションに次のように入力します。

app-url

ALM Octaneサーバーの完全修飾ドメイン名とポート。これは、SSO構成、リバースプロキシ構成、SSLオフロード構成などに使用されます。

このURLは、ALM Octaneが送信する電子メールにリンクとして挿入されます。電子メール受信者はこのリンクをクリックして、ALM Octaneで関連するエンティティに直接アクセスできます。

Use this pattern: http://<Server URL>:[Port]

基本設定: 通常、ALM OctaneサーバーをインストールしたサーバーのURL。

クラスター設定: 仮想IPのURL。

注: https://www.iana.org/domains/root/dbにリストされていないトップレベルドメイン (TLD) のURLがある場合 (たとえば、http://a.b.corp、ここでcorpはリストされていません)、非標準のトップレベルドメインのトラブルシューティングを参照してください。

http-port

https-port

HTTP用のJettyポート、またはHTTPS用のJettyセキュアポートの値。

ALM Octaneのインストール後に、ALM Octaneサーバーのポート番号の変更が必要になる場合があります。

インストールではroot以外のユーザーが使用されるため、ALM Octaneで共通ポート (1024未満) を使用することはできません。

標準設定で、インストールではHTTPにはポート8080、HTTPS (SSL) にはポート8443が使用されます。

httpPort: 8080
httpsPort: 8443

これらのポートを空白のままにすると、指定されたhttpスキーマサーバーを使用したアクセスが無効になります。

標準設定のアプリケーションサーバーポートは、同じマシン上で実行されている別のアプリケーションによって使用される可能性があります。この場合は、そのポートを使用しているアプリケーションを見つけて使用を停止するか、ALM Octaneサーバーのポートを変更します。
allow-http-requests-if-ssl-enabled

標準設定では、app-urlをHTTPSプロトコルを使用するように定義すると、ユーザーはHTTP経由でALM Octaneにアクセスできなくなります。

HTTPアクセスを有効にする必要がある場合 (たとえば、ネットワーク内の内部ツールの場合)、このパラメーターをtrueに設定できます。これにより、プロトコルがHTTPSに設定されている場合でも、ALM OctaneへのHTTPアクセスが許可されます。
key-storeフィールドはHTTPSでは必須です。
file

キーストアファイルへの絶対パス、またはキーストアがALM Octaneの構成フォルダーにある場合はファイル名を入力します。
password

キーストアファイルを保護するために使用されるパスワード。ALM Octaneが起動すると、このパスワードが暗号化されます。
keystore type

JKSまたはPKCS12を入力します。

注: このフィールドに入力する必要があります (標準設定: JKS)。

非標準のトップレベルドメインのトラブルシューティング

ALM Octaneは、app-urlパラメーターに入力されたトップレベルドメイン (TLD) がhttps://www.iana.org/domains/root/dbにリストされていることを検証します。そこにリストされていないTLDを含むURLを入力すると (たとえば、http://a.b.corp、corpがリストされていない)、サーバーの起動は失敗します。この場合、次の手順を実行します。

  1. 標準設定のapp-urlを入力します:https://localhost:8080。

  2. Octaneを起動します。

  3. 構成パラメーターで、TLDの値を使用してパラメーターADDITIONAL_ALLOWED_TLDを定義します (たとえば、corp)。

  4. ALM Octaneを再起動します。

  5. 構成パラメーターで、サーバーURLの正しい値 (http://a.b.corpなど) を使用してパラメーターSERVER_BASE_URLを定義します。

トップに戻る

ライセンス設定

trial-edition

試用版は常にenterpriseです。詳細については、ALM OctaneヘルプセンターのALM Octaneのエディションに関する情報を参照してください。
license-mode

  • スタンドアロンのALM Octaneライセンスを使用している場合は、standaloneと入力します。この場合、[License] セクションの残りのフィールドは省略できます。初期値。

  • ALMからALM Octaneにライセンスを割り当てる場合は、ALM_SHARINGと入力します。この場合、以下のフィールドに入力する必要があります。

    詳細については、ALM Octaneヘルプセンターのライセンスの管理 (オンプレミス)を参照してください。
ALM_SHARINGモードでは、次のフィールドが必須です。
url

ALMへのアクセスに使用するフルパスを入力します。通常、このパスの末尾にはqcbinが付きます。
integration-user > name

ALMにアクセスするためのユーザー名を入力します。このユーザーは、統合用にALMで定義したものです。
integration-user > password

integration-userのパスワードを入力します。

このパスワードは、ALM Octaneサーバーを再起動すると自動的に暗号化されます。

トップに戻る

認証タイプ

ALM Octaneのインストールでユーザー管理ネイティブのユーザー管理 (標準設定) を使用するか、LDAPを使用するか、SSO認証を使用するかを指定します。

認証タイプ

値は次のとおりです。 

Internal:: 内部のネイティブALM Octaneユーザー管理を使用します。初期値。

ldap: LDAP認証を使用します。LDAP認証設定 (オプション)の説明に従ってLDAP設定を定義します。

sso: SSO認証を使用します。SSO認証設定 (オプション)の説明に従ってSSO設定を定義します。

LDAP認証設定 (オプション)

LDAPを使用してユーザーを認証する場合は、インストール後にldap.confファイルではなく、ALM Octane設定UIを使用してLDAP設定を構成することをお勧めします。設定UIでLDAPを設定すると、設定はldap.confファイルで自動的に検証および更新されます。詳細については、ALM OctaneヘルプセンターのLDAPの設定を参照してください。

設定UIではなく構成ファイルで直接作業する場合:

  1. octane.confファイルに次の行があることを確認してください。 

    include "ldap.conf"

  2. ldap.confファイルで、以下の説明に従ってLDAP設定を構成します。

  3. その後、ALM Octaneのインストール後、ユーザーをLDAPからALM Octaneにインポートします。

ヒント: LDAP設定は、ALM Octaneを起動したときに検証されます。LDAPの設定にエラーがある (ALM Octaneサーバーが起動しない) 場合は、サイト管理者にラッパーログ、サイトログ、およびアプリケーションログを確認してもらいます。

一般的なLDAP設定

connection-timeout

接続タイムアウト (秒)。オプション。

標準設定: 30秒
admin-dn

LDAP認証を最初にセットアップしたときにALM Octaneにログオンするユーザー。これは、LDAPユーザー認証の設定を始める際に使用できるユーザーを1人確保するためのものです。

ALM Octaneサーバーは起動時に、LDAP設定をチェックし、このユーザーが存在することを確認し、このユーザーをLDAPデータに対して検証します。この属性が正しく定義されていない場合、サーバーは起動しません。このユーザーの詳細を修正してサーバーを再起動してください。

このユーザーは、octane.confファイルで指定したユーザーと同じユーザーでも、別のユーザーでもかまいません。このユーザーの値を入力してALM Octaneサーバーを再起動すると、octane.confファイルで指定した管理者ユーザーは上書きされます。これは、ALM Octaneに初めてログインするために使用できるALM Octaneサイト管理ユーザーになります。

注: admin-dnを変更してサーバーを再起動した場合、元のadmin-dnと新しいadmin-dnの両方がサイト管理者として存在することになります。admin-dnを変更しても元の情報は削除されません。

LDAPサーバー設定

LDAPサーバーごとに以下の設定を入力します。

注意: 以下で設定するパスワードはすべてバックアップしてください。パスワードはALM Octaneサーバーの初期化後に暗号化されます。

servers 下の情報が各LDAPサーバーに関するものであることを示すヘッダー行。値は入力しません。
host

LDAPサーバーのホスト名またはIPアドレス。必須。
port LDAPサーバーの接続ポート。必須。
ssl

LDAPサーバーでのSSLの使用の有無。必須。

YまたはNを指定します。

Yの場合は、LDAPサーバーの証明書を発行した証明機関に対して信頼を確立します。詳細については、ALM Octaneインストールガイドの「サーバーでの信頼の設定」を参照してください。
base-directories

ALM Octaneのスペースに新しいLDAPユーザーを追加する場合に、ユーザーの検索に使用するLDAPパスのルート。ここでは、共通名とドメインコンポーネント (cnとdn) のリストや、組織単位 (ou) のリストなどを設定します。

オプション。標準設定: 空白。

例: 

"base-directories" : [
      "dc=maxcrc,dc=com",
      "ou=Administrative,dc=maxcrc,dc=com"
      ],
base-filters

ALM Octaneのスペースに新しいLDAPユーザーを追加する場合に、ユーザーの検索を絞り込むのに使用するフィルター。これは通常、LDAPのobjectClassesのセミコロン区切りのリストです。

オプション。標準設定: (objectClass=*)
description

LDAPサーバーの説明。オプション。
authentication:

下の情報が認証に関するものであることを示すヘッダー行。値は入力しません。
method

LDAPサーバーでサポートしているLDAP認証方法。LDAPサーバーで使用している認証方法。次の認証方法がサポートされています。 

  • anonymous: この場合、次の2つのパラメーターnameとpasswordをスキップします。

  • simple。nameとpasswordは必須です。
user name

authenticationパラメーターをsimpleに設定した場合にのみ必要。

LDAPサーバーにアクセスするためのユーザー名。このユーザーには、少なくともLDAPサーバーに対する読み取りの権限が必要です。
password

authenticationパラメーターをsimpleに設定した場合にのみ必要。

LDAPサーバーにアクセスするためのパスワード。

このパスワードは暗号化されます。

LDAPサーバーマッピング設定

LDAPサーバーごとに以下のマッピング設定を入力します。

マッピングセクションで使用する値は、大文字と小文字が区別されます。

ldap.confのALM Octane属性 使用できるLDAP属性の例 値および説明
mapping

下の情報がLDAP属性のマッピング用であることを示すヘッダー行。値は入力しません。
dn

distinguishedName

(Active Directoryの場合)

LDAPの識別名属性。一意。必須。

この属性は、通常、次のような共通名と組織の詳細を含む形式です。

cn=<common_name>,ou=<organizational_unit>,dc=<part_of_domain>

dnは一意の文字列です。この文字列には、通常、cn、ou、dcなどの他のLDAP属性が含まれます。

例

  1. LDAPの場合、entryDN属性値は次のとおりです: cn=<common_name>,ou=<organizational_unit>,dc=<part_of_domain>

  2. ldap.confで、dnの値がentryDNにマッピングされます。

  3. LDAPからユーザーをエクスポートする場合、各LDAPユーザーのdn文字列表現は、次のように、共通名、組織単位、ドメインの一部の順になります。cn=Joe_Smith@nga,ou=my_org,dc=com

entryDN

(他のLDAPシステムの場合)

 
uid

objectGUID

(Active Directoryの場合)

グローバルに一意な不変の識別子として使用するLDAP属性。必須。

このドキュメントでは、これをUUID (ユニバーサル一意識別子) とも呼びます。

  • Active Directoryの場合: Active Directoryと組み合わせてALM Octaneを使用する場合は、objectGUIDを使用します。

  • 他のLDAPシステムの場合: ALM Octaneを使用する場合は、OpenLDAPのentryUUIDを使用するのが一般的です。ただし、お使いのLDAPによっては、この属性が異なっている場合があります (GUIDやorclguidなど)。

これは、ALM OctaneとLDAPとの間で同期を行うために、ALM Octane内部で各ユーザーを識別するための属性です (ALM Octaneにユーザーをインポートする場合など)。

GUIDやorclguidなどの別の値を設定することも、その他の一意の値を設定することもできます。

entryUUID

(他のLDAPシステムの場合)
first-name givenName 名のLDAP属性 (givenNameなど)。必須。
last-name sn 姓のLDAP属性 (snなど)。必須。
full-name cn フルネームのLDAP属性 (cnなど)。オプション。
logon-name mail

これはすべてのALM Octaneユーザー間の一意の識別子です。この属性はALM Octaneにログオンするのに使用されます。

ALM OctaneとLDAPとの間で同期を行うために、ALM Octaneがこの属性を使用して各ユーザーを内部的に識別する場合があります (ALM Octaneにユーザーをインポートする場合など)。

一般にmailはユーザーごとに一意です。そのため、mailはlogon-nameにマッピングするのに適したLDAP属性です。必須。

  • logon-name属性のマッピングはいつでも変更できます。ただし、logon-nameはすべてのALM Octaneユーザー間で一意である必要があります。

    		•
    email mail

    電子メールアドレスのLDAP属性 (mailなど)。必須。
    phone1 telephoneNumber プライマリ電話番号のLDAP属性 (telephoneNumberなど)。オプション。

    トップに戻る

    SSO認証設定 (オプション) 

    これらの設定を使用して、外部IDPを使用してALM Octaneに接続するためのSSO認証を設定します。

    1. octane.confファイルに次の行があることを確認してください。 

      include "sso.conf"

    2. sso.confファイルを次のように設定します。

    設定 説明と使用法
    Key-pair設定:
    alias

    認証情報に署名および暗号化するためにALM Octaneサービスプロバイダーによって使用されるSSO公開/秘密鍵ペアの一意の識別子。

    必須。

    例:sso-osp-keypair
    password

    キーペアエイリアスで定義されたキーペアを保護および暗号化するためのパスワード。

    ALM Octaneが起動すると、このパスワードが暗号化されます。

    必須。

    例:my-secret
    Key-store設定:
    file

    キーペアエイリアスで識別されるキーストアファイルへの絶対パス。

    権限の問題を回避するために、パスはALM Octaneの構成フォルダーの下にある必要があります。

    必須。
    password

    キーストアファイルで定義されたキーストアファイルを保護するために使用されるパスワード。

    ALM Octaneが起動すると、このパスワードが暗号化されます。

    必須。

    例:my-password
    keystore-type

    これにより、キーストアタイプが定義されます。このファイルの標準設定の形式はPKCS12です。ここでこのタイプを指定することにより、フォーマットをJava KeyStore (JKS) に変更できます。
    OAuth settings:
    クライアントID

    内部OAuth2構成に使用され、ALM Octaneにアクセスする統合がそれ自体を識別するために使用されるクライアントID。

    正規表現はサポートされていません (つまり、アスタリスクのワイルドカードはありません)。

    すべてのALM Octaneクラスターノードで同じである必要があります。

    必須。

    例: my-client-ID
    client-secret

    oauth client-idで定義された統合のクライアントIDのOAuthクライアントシークレット。

    任意の値にすることができます。秘密は複雑で推測しにくいものにすることをお勧めします。

    すべてのALM Octaneクラスターノードで同じである必要があります。

    ALM Octaneが起動すると、このパスワードが暗号化されます。

    必須。

    例: secret
    authentication-timeout

    秒単位のSSO認証タイムアウト。

    オプション。

    標準設定: 10800秒 (3時間)。

    次の構成パラメーターを使用して、SSOを使用するときに他のタイムアウトを設定できます。これらのパラメーターは、sso.confファイルではなく、ALM Octaneの [設定] 領域で定義されています。SSO認証のタイムアウトには影響しません。

    • MINUTES_UNTIL_IDLE_SESSION_TIMEOUT: ライセンス消費を分単位で定義します。

    • MINUTES_UNTIL_GLOBAL_SESSION_TIMEOUT. APIキー認証タイムアウトを分単位で定義します。

    これらの構成パラメーターの設定の詳細については、ALM Octaneヘルプセンターの構成パラメーターを参照してください。
    SAML設定:
    IdP section
    metadata-url

    IdPメタデータを公開するためのIdPのURI。ペアリングプロセスの一部。これが設定されている場合、メタデータを設定する必要はありません。このオプションを使用するには、URLが使用可能であり、有効なXMLで応答する必要があります。そうしないと、ALM Octaneが起動しません。

    有効なURLはすべて受け入れられます。

    この設定またはsaml idp metadata設定のいずれかを使用してSAMLメタデータ記述子リソースを定義できます。

    saml idp metadataが定義されていない場合は必須です。

    例: http://my-server.company-infra.net:8080/auth/realms/Dev/protocol/saml/descriptor
    metadata

    IdPからのSAMLメタデータ記述子のBase 64エンコードXML。これは、IdPメタデータURLにALM Octaneサーバーからアクセスできない場合に使用する必要があります。この設定を使用してメタデータが提供される場合、saml idp metadata-urlで定義されたURLは無視されます。

    SAMLメタデータ記述子リソースは、この設定またはsaml idpmetadata-url設定のいずれかで定義できます。

    saml idpmetadata-urlが定義されていない場合は必須。
    Mappingセクション
    user-name

    ユーザー名にマップするSAML応答のパラメーター。

    有効な値は次のとおりです。 

    • '{$id}': マッピングは、SAML応答のサブジェクトのNameIDへのマッピングです。初期値。

    • userName: マッピングは、SAML属性ステートメントのuserNameへのマッピングです。

    SAML応答で標準設定をuserNameなどのプロパティ名に変更する場合、引用符は必要ありません。
    uuid

    ユーザーのUUIDにマップするSAML応答の属性ステートメントの属性。

    オプション。

    標準設定:uuid
    mail

    ユーザーの電子メールアドレスにマップするSAML応答の属性ステートメントの属性。

    オプション。

    標準設定:mail
    first-name

    ユーザーの名にマップするSAML応答の属性ステートメントの属性。

    オプション。

    標準設定:firstName
    last-name

    ユーザーの姓にマップするSAML応答の属性ステートメントの属性。

    オプション。

    標準設定:lastName
    full-name

    ユーザーのフルネームにマップするSAML応答の属性ステートメントの属性。

    オプション。

    標準設定:fullName
    ロギング設定
    directory

    SSOログファイルを作成するディレクトリ。

    オプション。値が空の場合、標準設定のログディレクトリが使用されます。

    標準設定: <ログフォルダ>/sso
    logging-level

    ロギングレベル。可能な値は次のとおりです。 

    • SEVERE

    • INFO

    • WARNING

    • ALL

    オプション。

    標準設定: WARNING

    トップに戻る

    構成のヒント

    • Jettyサーバーを単一ノード設定でインストールする場合は、完全なアドレスを使用してサーバーにアクセスする必要があります。つまり、Jettyサーバーがmyserver.mydomain.comという名前のマシンにインストールされている場合は、サーバーへのアクセスにはhttp[s]://myserver.mydomain.com:<port>を使用し、http[s]://myserver:<port>は使用しません (クライアント側でDNSショートカットを使用している場合)

    • Jettyサーバーをクラスター環境でインストールする場合は、ロードバランサーとすべてのJettyノードとが相互にアクセスできる必要があります。クライアント側からロードバランサーを介してサーバーにアクセスする際にも同じルールが適用されます。つまり、ロードバランサーの完全なアドレスを使用してサーバーにアクセスする必要があります。

    トップに戻る