第8章 ironic-inspector

api_max_limit = 1000

整数値

API list-call が返す要素の数を制限します。

api_paste_config = api-paste.ini

文字列値

api サービスの paste.deploy 設定のファイル名

auth_strategy = keystone

文字列値

ironic-inspector API で使用される認証方法。"noauth"、"keystone"、または "http_basic" が有効なオプションです。"noauth" はすべての認証を無効にします。

backdoor_port = None

文字列値

eventlet バックドアを有効にします。設定可能な値は 0、<port>、および <start>:<end> です。ここで、0 はランダムの tcp ポート番号でリッスンします。<port> は指定されたポート番号でリッスンします (そのポートが使用中の場合にはバックドアを有効にしません)。また、<start>:<end> は、指定されたポート番号の範囲で最も小さい未使用のポート番号でリッスンします。選択したポートは、サービスのログファイルに表示されます。

backdoor_socket = None

文字列値

指定されたパスを接続を受信できる unix ソケットとして使用して、eventlet バックドアを有効にします。このオプションは、backdoor_port と相互に排他的です。したがって、どちらか 1 つだけを指定する必要があります。両方を指定すると、このオプションの存在によってそのオプションの使用が上書きされます。パス {pid} の中は、現在のプロセスの PID で置き換えられます。

can_manage_boot = True

ブール値

ironic-inspector の現在のインストールがノードの PXE ブートを管理できるかどうか。False に設定すると、API は manage_boot のないまたは True に設定されたイントロスペクション要求を拒否します。

clean_up_period = 60

整数値

タイムアウトしたノードと古いノードのステータス情報を繰り返すまでの時間 (秒単位)。警告: 値を 0 に設定すると、定期的なタスクが無効になり、インスペクターは ironic と同期して内部クリーンアッププロセスを完了しません。デプロイで PXE フィルターが使用されている場合は推奨できません。その結果、ironic-inspector が定期的なクリーンアップアクティビティーを停止することになります。

client_socket_timeout = 900

整数値

クライアント接続のソケット操作のタイムアウト。受信接続がこの秒数の間アイドル状態であると、閉じられます。0 の値は、永久に待機することを意味します。

conn_pool_min_size = 2

整数値

接続有効期限ポリシーのプールサイズ制限

conn_pool_ttl = 1200

整数値

プールのアイドル状態の接続の存続期間 (秒単位)

control_exchange = openstack

文字列値

トピックがスコープ設定されるデフォルトの変換。transport_url オプションで指定した変換名で上書きできます。

debug = False

ブール値

true に設定すると、ログレベルはデフォルトの INFO レベルではなく DEBUG に設定されます。

default_log_levels = ['sqlalchemy=WARNING', 'iso8601=WARNING', 'requests=WARNING', 'urllib3.connectionpool=WARNING', 'keystonemiddleware=WARNING', 'keystoneauth=WARNING', 'ironicclient=WARNING', 'amqp=WARNING', 'amqplib=WARNING', 'oslo.messaging=WARNING', 'oslo_messaging=WARNING']

リスト値

logger=LEVEL ペアのパッケージロギングレベルのリスト。このオプションは、log_config_append が設定されている場合は無視されます。

enable_mdns = False

ブール値

マルチキャスト DNS 経由で ironic-inspector API エンドポイントの公開を有効にするかどうかを定義します。

executor_thread_pool_size = 64

整数値

エグゼキューターがスレッディングまたはイベントレットの場合のエグゼキュータースレッドプールのサイズ。

fatal_deprecations = False

ブール値

非推奨の致命的なステータスを有効または無効にします。

graceful_shutdown_timeout = 60

整数値

サーバーを正常にシャットダウンするまでのタイムアウトを指定します。値をゼロにすると、endless の待機を意味します。

host = <based on operating system>

文字列値

このノードの名前。これは不透明な ID にすることができます。必ずしもホスト名、FQDN、または IP アドレスではありません。ただし、ノード名は AMQP キー内で有効で、ZeroMQ を使用している場合は、有効なホスト名、FQDN、または IP アドレスを使用する必要があります。

http_basic_auth_user_file = /etc/ironic-inspector/htpasswd

文字列値

auth_strategy=http_basic の場合に使用される Apache 形式のユーザー認証ファイルへのパス

instance_format = [instance: %(uuid)s]

文字列値

ログメッセージで渡されるインスタンスの形式。

instance_uuid_format = [instance: %(uuid)s]

文字列値

ログメッセージで渡されるインスタンス UUID の形式。

introspection_delay = 5

整数値

2 つのイントロスペクション間の遅延 (秒単位)。これは、ブートが ironic-inspector (つまり manage_boot==True) で管理される場合にのみ適用されます。

ipmi_address_fields = ['redfish_address', 'ilo_address', 'drac_host', 'drac_address', 'ibmc_address']

リスト値

ipmi_address と同等な ironic driver_info フィールド。

leader_election_interval = 10

整数値

リーダー選択の間隔 (秒単位)。

listen_address = ::

文字列値

リッスンする IP。

listen_port = 5050

ポート値

リッスンするポート。

listen_unix_socket = None

文字列値

リッスンする Unix ソケット。listen_address と listen_port を無効にします。

listen_unix_socket_mode = None

整数値

リッスンする unix ソケットのファイルモード (8 進数)。listen_unix_socket が設定されていない場合は無視されます。

log-config-append = None

文字列値

ロギング設定ファイルの名前。このファイルは、既存のロギング設定ファイルに追加されます。ロギング設定ファイルの詳細は、Python のロギングモジュールのドキュメントを参照してください。ロギング設定ファイルを使用すると、すべてのロギング設定が設定ファイルで設定され、その他のロギング設定オプションは無視されます (例:log-date-format)。

log-date-format = %Y-%m-%d %H:%M:%S

文字列値

ログレコードの %%(asctime)s のフォーマット文字列を定義します。デフォルト:%(default)sこのオプションは、log_config_append が設定されている場合は無視されます。

log-dir = None

文字列値

(オプション)log_file の相対パスに使用されるベースディレクトリー。このオプションは、log_config_append が設定されている場合は無視されます。

log-file = None

文字列値

(オプション) ロギング出力を送信するログファイルの名前。デフォルトが設定されていない場合、ロギングは use_stderr で定義されているように stderr に送信されます。このオプションは、log_config_append が設定されている場合は無視されます。

log_options = True

ブール値

サービスの起動時 (DEBUG レベル) に、登録されているすべてのオプションの値をログに記録することを有効または無効にします。

log_rotate_interval = 1

整数値

ログファイルがローテーションされるまでの時間。このオプションは、log_rotation_type が "interval" に設定されていない限り無視されます。

log_rotate_interval_type = days

文字列値

ローテーション間隔の種別。次のローテーションをスケジューリングする際に、最後のファイル変更の時刻 (またはサービスの起動時刻) が使用されます。

log_rotation_type = none

文字列値

ログローテーションの種別。

logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(global_request_id)s %(request_id)s %(user_identity)s] %(instance)s%(message)s

文字列値

コンテキスト付きログメッセージに使用するフォーマット文字列。oslo_log.formatters.ContextFormatter により使用されます。

logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d

文字列値

メッセージのロギングレベルが DEBUG の場合にログメッセージに追加する追加のデータ。oslo_log.formatters.ContextFormatter により使用されます。

logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s

文字列値

コンテキストが定義されていない場合に、ログメッセージに使用するフォーマット文字列。oslo_log.formatters.ContextFormatter により使用されます。

logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s

文字列値

この形式で、例外出力の各行の前に接頭辞が付けられます。oslo_log.formatters.ContextFormatter により使用されます。

logging_user_identity_format = %(user)s %(project)s %(domain)s %(system_scope)s %(user_domain)s %(project_domain)s

文字列値

logging_context_format_string で使用される %(user_identity)s のフォーマット文字列を定義します。oslo_log.formatters.ContextFormatter により使用されます。

max_concurrency = 1000

整数値

グリーンスレッドプールのサイズ。

max_header_line = 16384

整数値

許可されるメッセージヘッダー行の最大サイズ。max_header_line は、大きなトークンを使用する際に増やす必要がある場合があります (特に、keystone が大きなサービスカタログの PKI トークンを使用するように設定された場合に生成されるトークン)。

max_logfile_count = 30

整数値

ローテーションされたログファイルの最大数。

max_logfile_size_mb = 200

整数値

ログファイルの最大サイズ (MB 単位)。"log_rotation_type" が "size" に設定されていない場合は、このオプションは無視されます。

publish_errors = False

ブール値

エラーイベントの公開を有効または無効にします。

rate_limit_burst = 0

整数値

rate_limit_interval ごとのログ記録されたメッセージの最大数。

rate_limit_except_level = CRITICAL

文字列値

レート制限で使用されるログレベル名:CRITICAL、ERROR、INFO、WARNING、DEBUG または空の文字列。rate_limit_except_level 以上のレベルのログはフィルターされません。空の文字列は、すべてのレベルがフィルターされることを意味します。

rate_limit_interval = 0

整数値

ログのレート制限の間隔 (秒数)。

rootwrap_config = /etc/ironic-inspector/rootwrap.conf

文字列値

root としてコマンドを実行するために使用する rootwrap 設定ファイルへのパス

rpc_conn_pool_size = 30

整数値

RPC 接続プールのサイズ。

rpc_ping_enabled = False

ブール値

ping 呼び出しに応答するエンドポイントを追加します。エンドポイントの名前は oslo_rpc_server_ping です。

rpc_response_timeout = 60

整数値

呼び出しからの応答を待つ秒数。

standalone = True

ブール値

ironic-inspector をスタンドアロンのサービスとして実行するかどうか。False に設定されているのは EXPERIMENTAL です。

syslog-log-facility = LOG_USER

文字列値

ログ行を受け取る syslog ファシリティー。このオプションは、log_config_append が設定されている場合は無視されます。

tcp_keepidle = 600

整数値

各サーバーソケットの TCP_KEEPIDLE の値を設定します (秒単位)。OS X では対応していません。

timeout = 3600

整数値

イントロスペクションが失敗したと見なされるタイムアウトで、無効にするには 0 に設定します。

transport_url = rabbit://

文字列値

メッセージングバックエンドに接続するためのネットワークアドレスおよびオプションのユーザー認証情報 (URL 形式)。想定される形式は次のとおりです。

driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query

例:rabbit://rabbitmq:password@127.0.0.1:5672//

URL のフィールドの詳細は、https://docs.openstack.org/oslo.messaging/latest/reference/transport.html で oslo_messaging.TransportURL のドキュメントを参照してください。

use-journal = False

ブール値

ロギング用の journald を有効にします。systemd 環境で実行している場合は、ジャーナルサポートを有効にしたい場合があります。その場合、ログメッセージに加えて構造化されたメタデータが含まれる journal ネイティブプロトコルが使用されます。このオプションは、log_config_append が設定されている場合は無視されます。

use-json = False

ブール値

ロギングに JSON 形式を使用します。このオプションは、log_config_append が設定されている場合は無視されます。

use-syslog = False

ブール値

ロギングに syslog を使用します。既存の syslog 形式は非推奨であり、後に RFC5424 に従うように変更されます。このオプションは、log_config_append が設定されている場合は無視されます。

use_eventlog = False

ブール値

出力を Windows イベントログに記録します。

use_ssl = False

ブール値

SSL の有効化/無効化

use_stderr = False

ブール値

出力を標準エラーに記録します。このオプションは、log_config_append が設定されている場合は無視されます。

watch-log-file = False

ブール値

ファイルシステムを監視するように設計されたログハンドラーを使用します。ログファイルが移動または削除されると、このハンドラーは、指定されたパスで新しいログファイルを即時に開きます。これは、log_file オプションを指定し、Linux プラットフォームが使用される場合にのみ有効です。このオプションは、log_config_append が設定されている場合は無視されます。

wsgi_default_pool_size = 100

整数値

wsgi で使用される greenthread のプールのサイズ

wsgi_keep_alive = True

ブール値

False の場合は、クライアントのソケット接続を明示的に閉じます。

wsgi_log_format = %(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f

文字列値

ログ行を生成するためにテンプレートとして使用される Python 形式の文字列。client_ip、date_time、request_line、status_code、body_length、wall_seconds をこの形式にフォーマットできます。

wsgi_server_debug = False

ブール値

サーバーが 500 エラーで例外トレースバックをクライアントに送信する必要がある場合は true。False の場合、サーバーは空の本文で応答します。

boot_mode = False

ブール値

ブートモード (BIOS または UEFI) を保存するかどうか。

cpu_flags = {'aes': 'cpu_aes', 'pdpe1gb': 'cpu_hugepages_1g', 'pse': 'cpu_hugepages', 'smx': 'cpu_txt', 'svm': 'cpu_vt', 'vmx': 'cpu_vt'}

dict 値

このフラグが存在する場合に設定する CPU フラグと機能間のマッピング。

backend_url = memcached://localhost:11211

文字列値

分散調整に使用するバックエンド URL。実験的

allow_credentials = True

ブール値

実際の要求にユーザーの認証情報を含めることができることを示します。

allow_headers = ['X-Auth-Token', 'X-OpenStack-Ironic-Inspector-API-Minimum-Version', 'X-OpenStack-Ironic-Inspector-API-Maximum-Version', 'X-OpenStack-Ironic-Inspector-API-Version']

リスト値

実際の要求時に使用されるヘッダーフィールド名を示します。

allow_methods = ['GET', 'POST', 'PUT', 'HEAD', 'PATCH', 'DELETE', 'OPTIONS']

リスト値

実際の要求時に使用できるメソッドを示します。

allowed_origin = None

リスト値

このリソースがリクエストの "origin" ヘッダーで受信したドメインと共有されるかどうかを示します。形式: "<protocol>://<host>[:<port>]" (行末のスラッシュなし)例: https://horizon.example.com

expose_headers = []

リスト値

API に安全に公開できるヘッダーを示します。デフォルトは HTTP Simple ヘッダーです。

max_age = 3600

整数値

CORS プリフライトリクエストの最大キャッシュ期間。

backend = sqlalchemy

文字列値

データベースに使用するバックエンド。

connection = None

文字列値

データベースへの接続に使用する SQLAlchemy 接続文字列。

connection_debug = 0

整数値

SQL デバッグ情報の冗長性: 0=なし、100=すべて。

`connection_parameters = `

文字列値

接続時に接続 URL に追加するオプションの URL パラメーター。param1=value1&param2=value2&…​ として指定します。

connection_recycle_time = 3600

整数値

この秒数より長く接続プールに存在していた接続は、次にプールからチェックアウトされたときに新しい接続に置き換えられます。

connection_trace = False

ブール値

Python スタックトレースをコメント文字列として SQL に追加します。

db_inc_retry_interval = True

ブール値

True の場合には、db_max_retry_interval までのデータベース操作の再試行回数を長くします。

db_max_retries = 20

整数値

エラーが発生する前に接続エラーまたはデッドロックが発生した場合の最大再試行。再試行回数を無限に指定するには -1 に設定します。

db_max_retry_interval = 10

整数値

db_inc_retry_interval が設定されている場合は、データベース操作を再試行するまでの最大秒数です。

db_retry_interval = 1

整数値

データベーストランザクションの再試行間の秒数。

max_overflow = 50

整数値

設定されている場合、この値を SQLAlchemy で max_overflow に使用します。

max_pool_size = 5

整数値

プールに開いたままにする SQL 接続の最大数。値を 0 に設定すると無制限を意味します。

max_retries = 10

整数値

起動時のデータベース接続の最大再試行数。再試行回数を無限に指定するには -1 に設定します。

mysql_enable_ndb = False

ブール値

True の場合には、MySQL Cluster (NDB) の処理のサポートを透過的に有効にします。12.1.0 以降 非推奨

*理由:*MySQL NDB Cluster ストレージエンジンのサポートは非推奨となり、今後のリリースで削除される予定です。

mysql_sql_mode = TRADITIONAL

文字列値

MySQL セッションに使用する SQL モード。このオプション (デフォルトを含む) は、サーバーセット SQL モードを上書きします。サーバー設定で設定された SQL モードを使用するには、これを no value に設定します。例: mysql_sql_mode=

mysql_wsrep_sync_wait = None

整数値

Galera の場合に限り、新しい接続で wsrep_sync_wait 因果関係チェックを設定します。デフォルトは None、つまり何も設定しません。

pool_timeout = None

整数値

設定されている場合は、この値を SQLAlchemy で pool_timeout に使用します。

retry_interval = 10

整数値

SQL 接続を開く再試行の間隔。

slave_connection = None

文字列値

スレーブデータベースへの接続に使用する SQLAlchemy 接続文字列。

sqlite_synchronous = True

ブール値

True の場合、SQLite は同期モードを使用します。

use_db_reconnect = False

ブール値

失われた接続でデータベースの実験的な使用を有効にします。

enabled_bmc_address_version = ['4', '6']

リスト値

新規ノードを Ironic に登録する際に使用される BMC アドレスの IP バージョン。デフォルトは "4,6" です。"4" (v4 アドレスのみ使用)、"4,6" (v4 アドレスがより優先され、両方のアドレスが見つかった場合 v6 バージョンは無視される)、"6,4" (v6 が望ましいが v4 アドレスを持つ BMC のために v4 アドレスにフォールバック、"4,6" の反対)、"6" (v6 アドレスのみ使用し v4 バージョンを無視) が可能です。

enroll_node_driver = fake-hardware

文字列値

Ironic に新規ノードを作成する際に enroll フックで使用される Ironic ドライバーの名前。

enroll_node_fields = {}

dict 値

新しく検出されたノードに設定する追加フィールド。

dhcp_hostsdir = /var/lib/ironic-inspector/dhcp-hostsdir

文字列値

dnsmasq に公開されている MAC アドレスキャッシュディレクトリー。このディレクトリーはドライバーを排他的に制御する必要があります。

`dnsmasq_start_command = `

文字列値

フィルターの初期化時に dnsmasq サービスを開始する (シェル) コマンドライン。デフォルト: don't start

`dnsmasq_stop_command = `

文字列値

インスペクター (エラー) 終了時に dnsmasq サービスを停止する (シェル) コマンドライン。デフォルト: don't stop

purge_dhcp_hostsdir = True

ブール値

ドライバーの初期化時に hostsdir をパージします。false に設定すると、インスペクターのデプロイメントが、同じホストおよび名前空間内で複数のプロセスが実行される可能性がある場合にのみ実行する必要があります。この場合、Operator はカスタムクリーニング機能を設定します。

strict = False

ブール値

True の場合、少なくとも 1 つのレコードが短すぎる場合、余分なデータの解析を拒否します。さらに、解析に失敗した場合でも、受信した "データ" を削除します。

backends = []

リスト値

ヘルスチェックを実施し、リクエストの一部としてその情報を報告できる追加のバックエンド。

detailed = False

ブール値

応答の一部として詳細情報を表示します。セキュリティーメモ: このオプションを有効にすると、監視対象のサービスに関する機密情報が漏洩する可能性があります。セキュリティーポリシーに違反しないことを確認してください。

disable_by_file_path = None

文字列値

ファイルが存在することを確認し、アプリケーションがポート上で実行されているかどうかを確認します。DisableByFileHealthcheck プラグインで使用されます。

disable_by_file_paths = []

リスト値

ポートに基づいてファイルが存在することを確認し、アプリケーションがポート上で実行されているかどうかを判断します。文字列の "port:path" リストを想定します。DisableByFilesPortsHealthcheck プラグインで使用されます。

enabled = False

ブール値

/healthcheck でヘルスチェックエンドポイントを有効にします。これは認証されていないことに注意してください。詳細は、https://docs.openstack.org/oslo.middleware/latest/reference/healthcheck_plugins.html を参照してください。

path = /healthcheck

文字列値

healtcheck 要求に応答するパス。

dnsmasq_interface = br-ctlplane

文字列値

dnsmasq がリッスンするインターフェイスです。デフォルトは仮想マシン用です。

ethoib_interfaces = []

リスト値

DHCP ネットワークへの物理アクセスに使用される Inspector ホスト上の Ethernet Over InfiniBand インターフェイスのリスト。複数のインターフェイスが dnsmasq_interface に指定されたボンディングまたはブリッジにアタッチされます。望ましい状態にない InfiniBand ノードの MAC は、これらのインターフェイス上の隣接する MAC のリストに基づきブラックリスト化されます。

firewall_chain = ironic-inspector

文字列値

使用する iptables チェーン名。

ip_version = 4

文字列値

iptables フィルターに使用される IP バージョン。デフォルトは 4 です。

auth-url = None

文字列値

認証 URL

auth_type = None

文字列値

読み込む認証タイプ

cafile = None

文字列値

HTTP 接続の検証時に使用する PEM でエンコードされた認証局。

certfile = None

文字列値

PEM でエンコードされたクライアント証明書の証明書ファイル

collect-timing = False

ブール値

API ごとの呼び出しタイミング情報を収集します。

connect-retries = None

整数値

接続エラーに対して試行される再試行の最大数。

connect-retry-delay = None

浮動小数点の値

接続エラーに対する 2 つの再試行の遅延 (秒単位)。設定されていない場合は、最大 60 秒まで 0.5 秒から開始する指数関数の再試行が使用されます。

default-domain-id = None

文字列値

v3 および v2 パラメーターで使用するオプションのドメイン ID。v3 のユーザーおよびプロジェクトドメインに使用され、v2 認証では無視されます。

default-domain-name = None

文字列値

v3 API および v2 パラメーターで使用するオプションのドメイン名です。v3 のユーザーおよびプロジェクトドメインに使用され、v2 認証では無視されます。

domain-id = None

文字列値

スコープするドメイン ID

domain-name = None

文字列値

スコープするドメイン名

endpoint-override = None

文字列値

このクライアントのリクエストには常にこのエンドポイント URL を使用します。注意: バージョンを指定しないエンドポイントはここで指定する必要があります。特定の API バージョンを要求するには、version、min-version オプション、または max-version オプション、もしくはそれを組み合わせてを使用します。

insecure = False

ブール値

HTTPS 接続を確認します。

keyfile = None

文字列値

PEM でエンコードされたクライアント証明書キーファイル

max-version = None

文字列値

特定の API の最大メジャーバージョンで、min_version を持つ範囲の上限として使用されることが意図されています。version と相互に排他的です。

max_retries = 30

整数値

競合エラー時の最大再試行回数 (HTTP 409)。

min-version = None

文字列値

指定の API の最小メジャーバージョンで、max_version を持つ範囲の下限として使用することが意図されています。version と相互に排他的です。max_version なしで min_version が指定されている場合は、max version が "latest" の場合になります。

password = None

文字列値

ユーザーのパスワード

project-domain-id = None

文字列値

プロジェクトを含むドメイン ID

project-domain-name = None

文字列値

プロジェクトを含むドメイン名

project-id = None

文字列値

スコープするプロジェクト ID

project-name = None

文字列値

スコープするプロジェクト名

region-name = None

文字列値

エンドポイント URL 検出のデフォルト region_name。

retry_interval = 2

整数値

競合エラーが発生した場合の再試行の間隔 (HTTP 409)。

service-name = None

文字列値

エンドポイント URL 検出のデフォルト service_name。

service-type = baremetal

文字列値

エンドポイント URL 検出のデフォルト service_type。

split-loggers = False

ブール値

複数のロガーへの要求をログに記録します。

status-code-retries = None

整数値

再試行可能な HTTP ステータスコードに対して試行される再試行の最大数。

status-code-retry-delay = None

浮動小数点の値

再試行可能なステータスコードに対する 2 つの再試行間の遅延 (秒単位)。設定されていない場合は、最大 60 秒まで 0.5 秒から開始する指数関数の再試行が使用されます。

system-scope = None

文字列値

システム操作のスコープ

tenant-id = None

文字列値

テナント ID

tenant-name = None

文字列値

テナント名

timeout = None

整数値

http 要求のタイムアウト値

trust-id = None

文字列値

trustee として使用する信頼の ID

user-domain-id = None

文字列値

ユーザーのドメイン ID

user-domain-name = None

文字列値

ユーザーのドメイン名

user-id = None

文字列値

ユーザー ID

username = None

文字列値

Username

valid-interfaces = ['internal', 'public']

リスト値

エンドポイント URL のインターフェイスのリスト (優先順)。

version = None

文字列値

エンドポイント URL 検出用に指定の Major API バージョン内の最小の Major API バージョン。min_version および max_version と相互排他的になる

auth_section = None

文字列値

プラグイン固有のオプションを読み込む config セクション

auth_type = None

文字列値

読み込む認証タイプ

auth_uri = None

文字列値

"パブリック" の Identity API エンドポイントを完了します。このエンドポイントは、すべてのエンドユーザーがアクセスできる必要があるため、"admin" エンドポイントにすることはできません。認証されていないクライアントは、認証のためにこのエンドポイントにリダイレクトされます。このエンドポイントにはバージョンを指定しないことが理想的ですが、ワイルドカードでのクライアントのサポートは異なります。バージョン指定された v2 エンドポイントを使用している場合、通常エンドユーザーがそのエンドポイントに到達できない可能性があるため、これはサービスユーザーがトークンを検証するために使用するエンドポイントにすることは できません。このオプションは www_authenticate_uri が優先されるため非推奨となり、S リリースで削除される予定です。非推奨: Queens 以降

*理由:* auth_uri オプションは www_authenticate_uri が優先されるため非推奨となり、S リリースで削除される予定です。

auth_version = None

文字列値

Identity API エンドポイントの API バージョン。

cache = None

文字列値

Swift キャッシュオブジェクトが保存される環境キーを要求します。auth_token ミドルウェアを Swift キャッシュと共にデプロイする場合は、このオプションを使用して、ミドルウェアが swift とキャッシングバックエンドを共有するようにします。それ以外の場合は、代わりに memcached_servers オプションを使用します。

cafile = None

文字列値

HTTPs 接続の検証時に使用する PEM でエンコードされた認証局。デフォルトはシステム CA です。

certfile = None

文字列値

ID サーバーでクライアント証明書が必要な場合に必要です。

delay_auth_decision = False

ブール値

ミドルウェア内の認可要求を処理せず、承認の決定をダウンストリームの WSGI コンポーネントに委譲します。

enforce_token_bind = permissive

文字列値

トークンバインディングの使用および種別を制御するために使用されます。トークンバインディングのチェックを無効するには、"disabled" に設定します。バインドタイプがサーバーの認識する形式の場合にはバインディング情報を検証し、そうでない場合には無視するには、"permissive" (デフォルト) に設定します。"strict" は "permissive" と類似していますが、バインドタイプが不明な場合にはトークンが拒否されます。"required" の場合は、いずれかの形式のトークンバインディングが必要です。最後に、トークンに指定する必要のあるバインディングメソッドの名前。

http_connect_timeout = None

整数値

Identity API サーバーと通信する際の要求タイムアウト値。

http_request_max_retries = 3

整数値

Identity API サーバーと通信する際に再接続を試行する回数。

include_service_catalog = True

ブール値

(オプション)X-Service-Catalog ヘッダーを設定するかどうかを示します。False の場合、ミドルウェアはトークンの検証時にサービスカタログを要求せず、X-Service-Catalog ヘッダーを設定しません。

insecure = False

ブール値

HTTPS 接続を確認します。

interface = internal

文字列値

Identity API エンドポイントに使用するインターフェイス。有効な値は、"public"、"internal" (デフォルト)、または "admin" です。

keyfile = None

文字列値

ID サーバーでクライアント証明書が必要な場合に必要です。

memcache_pool_conn_get_timeout = 10

整数値

(オプション) プールから memcached クライアント接続を取得するまで操作が待機する秒数。

memcache_pool_dead_retry = 300

整数値

(オプション)memcached サーバーが停止しているとみなされる秒数。この秒数が経過すると再試行されます。

memcache_pool_maxsize = 10

整数値

(オプション) すべての memcached サーバーへのオープン接続の最大合計数。

memcache_pool_socket_timeout = 3

整数値

(オプション)memcached サーバーと通信する際のソケットのタイムアウト (秒単位)。

memcache_pool_unused_timeout = 60

整数値

(オプション)memcached への接続がプール内で未使用の状態を維持する秒数。この秒数が経過すると終了されます。

memcache_secret_key = None

文字列値

(オプション、memcache_security_strategy が定義されている場合には必須) この文字列は鍵の導出に使用されます。

memcache_security_strategy = None

文字列値

(オプション) 定義されている場合は、トークンデータを認証、または認証して暗号化する必要があるかどうかを示します。MAC の場合、キャッシュでトークンデータが認証されます (HMAC を使用)。ENCRYPT の場合、キャッシュでトークンデータが暗号化され、認証されます。値がこれらのオプションのいずれでもない場合や空の場合には、auth_token は初期化時に例外を発生させます。

memcache_tls_allowed_ciphers = None

文字列値

(オプション) TLS コンテキストで作成されたソケットで利用可能な暗号を設定します。OpenSSL 暗号リスト形式の文字列である必要があります。指定されていない場合は、OpenSSL 対応の暗号がすべて利用可能になります。

memcache_tls_cafile = None

文字列値

(オプション) キャッシュサーバーの信頼性を確立するのに必要な PEM 形式の連結された CA 証明書のファイルへのパス。tls_enabled が False の場合、このオプションは無視されます。

memcache_tls_certfile = None

文字列値

(オプション) クライアントの証明書と証明書の信頼性を確立するために必要な任意の数の CA 証明書を含む PEM 形式の単一ファイルへのパス。このファイルは、クライアント側の認証が必要な場合にのみ必要です。tls_enabled が False の場合、このオプションは無視されます。

memcache_tls_enabled = False

ブール値

(オプション) キャッシングサーバーと連携する際に、TLS の使用をグローバルに切り替えます。

memcache_tls_keyfile = None

文字列値

(オプション) クライアントの秘密鍵を含む単一ファイルへのパス。それ以外の場合、秘密鍵は tls_certfile で指定されたファイルから取得されます。tls_enabled が False の場合、このオプションは無視されます。

memcache_use_advanced_pool = True

ブール値

(オプション) 高度な (eventlet に対して安全な) memcached クライアントプールを使用します。

memcached_servers = None

リスト値

オプションで、キャッシュに使用する memcached サーバーのリストを指定します。未定義のままの場合、トークンは代わりに処理中にキャッシュされます。

region_name = None

文字列値

アイデンティティーサーバーがあるリージョン。

service_token_roles = ['service']

リスト値

サービストークンに存在する必要があるロールの選択。サービストークンは、期限切れのトークンを使用できることを要求できるため、このチェックでは実際のサービスのみがこのトークンを送信するように厳密に制御する必要があります。ここでのロールは ANY チェックとして適用されるため、このリストのロールはすべて存在している必要があります。後方互換性の理由から、現在 allow_expired チェックにのみ影響します。

service_token_roles_required = False

ブール値

後方互換性の理由から、service_token_roles チェックを有効としてパスしない有効なサービストークンをパスさせる必要があります。これを true に設定することが今後のリリースでデフォルトとなり、可能な場合は有効にされる必要があります。

service_type = None

文字列値

サービスカタログに表示されるサービスの名前または種別。これは、制限されたアクセスルールがあるトークンを検証するために使用されます。

token_cache_time = 300

整数値

トークンの検証に過剰な時間を費やすのを防ぐために、ミドルウェアは、設定可能な期間 (秒単位) 中は以前に見たトークンをキャシュします。キャッシュを完全に無効にするには -1 に設定します。

www_authenticate_uri = None

文字列値

"パブリック" の Identity API エンドポイントを完了します。このエンドポイントは、すべてのエンドユーザーがアクセスできる必要があるため、"admin" エンドポイントにすることはできません。認証されていないクライアントは、認証のためにこのエンドポイントにリダイレクトされます。このエンドポイントにはバージョンを指定しないことが理想的ですが、ワイルドカードでのクライアントのサポートは異なります。バージョン指定された v2 エンドポイントを使用している場合、通常エンドユーザーがそのエンドポイントに到達できない可能性があるため、これはサービスユーザーがトークンを検証するために使用するエンドポイントにすることは できません。

interfaces = None

リスト値

mDNS に使用するインターフェイスの IP アドレスのリスト。デフォルトは、システムのすべてのインターフェイスに設定されます。

lookup_attempts = 3

整数値

サービスのルックアップを試行する回数。

params = {}

dict 値

登録したサービスに渡す追加のパラメーター。

registration_attempts = 5

整数値

サービス登録を試行する回数。現在、zeroconf ライブラリーの競合状態により、1 を超える必要があります。

addressing_mode = dynamic

文字列値

ドライバーが使用するアドレスモードを示します。許可される値:legacy - レガシーのルーティング不可能なアドレス指定を使用します。routable - ルーティング可能なアドレスを使用します。dynamic - メッセージバスがルーティングをサポートしていない場合はレガシーのアドレスを使用します。それ以外の場合は、ルーティング可能なアドレスを使用します。

anycast_address = anycast

文字列値

コンシューマーのグループに送信する際に、アドレス接頭辞に追加されます。コンシューマー間でラウンドロビン方式で配信される必要のあるメッセージを特定するために、メッセージバスで使用されます。

broadcast_prefix = broadcast

文字列値

すべてのサーバーにブロードキャストする場合に使用されるアドレス接頭辞

connection_retry_backoff = 2

整数値

フェイルオーバーの試みに失敗するたびに、connection_retry_interval をこの秒数だけ増やします。

connection_retry_interval = 1

整数値

再接続を試みる前に一時停止する秒数。

connection_retry_interval_max = 30

整数値

connection_retry_interval + connection_retry_backoff の上限

container_name = None

文字列値

AMQP コンテナーの名前。グローバルで一意でなければなりません。デフォルトは、生成された UUID です。

default_notification_exchange = None

文字列値

通知アドレスで使用される変換名。エクスチェンジ名の解決の優先順位:Target.exchange、他に設定されている場合は default_notification_exchange、他に設定されている場合は control_exchange、他に設定されている場合は notify

default_notify_timeout = 30

整数値

送信された通知メッセージ配信の期限。呼び出し元がタイムアウトを明示的に指定しない場合にのみ使用されます。

default_reply_retry = 0

整数値

リカバリー可能なエラーが原因で失敗した返信メッセージを再送信する最大試行回数。

default_reply_timeout = 30

整数値

rpc 返信メッセージ配信の期限。

default_rpc_exchange = None

文字列値

RPC アドレスで使用される変換名。エクスチェンジ名の解決の優先順位:Target.exchange、他に設定されている場合は default_rpc_exchange、他に設定されている場合は control_exchange、他に設定されている場合は rpc

default_send_timeout = 30

整数値

rpc キャストまたは呼び出しメッセージ配信の期限。呼び出し元がタイムアウトを明示的に指定しない場合にのみ使用されます。

default_sender_link_timeout = 600

整数値

アイドル状態の送信者リンクのパージをスケジュールする時間。期限切れ後にリンクの割り当てを解除します。

group_request_prefix = unicast

文字列値

グループの任意のサーバーに送信する際のアドレス接頭辞

idle_timeout = 0

整数値

非アクティブな接続のタイムアウト (秒単位)

link_retry_delay = 10

整数値

リカバリー可能なエラーが原因で失敗した AMQP 1.0 リンクの再接続間に一時停止する時間。

multicast_address = multicast

文字列値

ファンアウトメッセージを送信するときにアドレス接頭辞に追加されます。ファンアウトメッセージを識別するためにメッセージバスによって使用されます。

notify_address_prefix = openstack.org/om/notify

文字列値

すべての生成される通知アドレスのアドレス接頭辞

notify_server_credit = 100

整数値

受信通知メッセージのウィンドウサイズ

pre_settled = ['rpc-cast', 'rpc-reply']

多値

このタイプのメッセージを事前処置状態で送信します。事前処置されたメッセージは、ピアから確認応答を受信しません。注記: 事前処置されたメッセージは、配信に失敗した場合に警告なしに破棄される可能性があります。許可される値:rpc-call - RPC 呼び出しを事前処置状態で送信します。rpc-reply- RPC 返信を事前処置状態で送信します。rpc-cast - RPC キャストを事前処置状態で送信します。notify - 通知を事前処置状態で送信します。

pseudo_vhost = True

ブール値

仮想ホスト (qpidd など) をネイティブにサポートしていないメッセージバスの仮想ホストサポートを有効にします。true に設定すると、仮想ホスト名はすべてのメッセージバスアドレスに追加され、結果として仮想ホストごとにプライベート サブネット を作成します。メッセージバスが仮想ホストの名前として AMQP 1.0 オープン遂行動詞の hostname フィールドを使用して仮想ホストをサポートする場合は False に設定します。

reply_link_credit = 200

整数値

受信する RPC 返信メッセージのウィンドウサイズ。

rpc_address_prefix = openstack.org/om/rpc

文字列値

すべての生成される RPC アドレスのアドレス接頭辞

rpc_server_credit = 100

整数値

受信する RPC リクエストメッセージのウィンドウサイズ。

`sasl_config_dir = `

文字列値

SASL 設定が含まれるディレクトリーへのパス

`sasl_config_name = `

文字列値

設定ファイルの名前 (.conf 接尾辞なし)

`sasl_default_realm = `

文字列値

ユーザー名にレルムが存在しない場合に使用する SASL レルム

`sasl_mechanisms = `

文字列値

許可される SASL メカニズムのスペース区切りリスト

server_request_prefix = exclusive

文字列値

特定のサーバーに送信する時に使用するアドレス接頭辞

ssl = False

ブール値

SSL 経由で接続を試みます。その他の ssl 関連のパラメーターが指定されていない場合、システムの CA バンドルを使用してサーバーの証明書を検証します。

`ssl_ca_file = `

文字列値

サーバーの証明書の検証に使用する CA 証明書 PEM ファイル

`ssl_cert_file = `

文字列値

クライアント認証用の自己識別証明書 PEM ファイル

`ssl_key_file = `

文字列値

ssl_cert_file 証明書の署名に使用される秘密鍵 PEM ファイル (オプション)

ssl_key_password = None

文字列値

ssl_key_file を復号するためのパスワード (暗号化されている場合)

ssl_verify_vhost = False

ブール値

デフォルトでは、SSL は、サーバーの証明書の名前が transport_url のホスト名と一致することを確認します。設定によっては、代わりに仮想ホスト名を使用することが望ましい場合があります。たとえば、サーバーが Server Name Indication TLS 拡張 (rfc6066) を使用して、仮想ホストごとの証明書を提供する場合などです。サーバーの SSL 証明書が DNS 名ではなく仮想ホスト名を使用する場合は、ssl_verify_vhost を True に設定します。

trace = False

ブール値

デバッグ: AMQP フレームを標準出力 (stdout) にダンプします。

unicast_address = unicast

文字列値

特定の RPC/通知サーバーに送信する際に、アドレス接頭辞に追加されます。単一の送信先に送信されたメッセージを識別するためにメッセージバスによって使用されます。

compression_codec = none

文字列値

プロデューサーによって生成されたすべてのデータの圧縮コーデック。設定されていない場合、圧縮は使用されません。この設定に許可される値は、kafka バージョンに依存することに注意してください。

conn_pool_min_size = 2

整数値

接続有効期限ポリシーのプールサイズ制限

conn_pool_ttl = 1200

整数値

プールのアイドル状態の接続の存続期間 (秒単位)

consumer_group = oslo_messaging_consumer

文字列値

Kafka コンシューマーのグループ ID。あるグループのコンシューマーは、メッセージ消費を調整します。

enable_auto_commit = False

ブール値

非同期コンシューマーコミットを有効にします。

kafka_consumer_timeout = 1.0

浮動小数点の値

Kafka コンシューマーのデフォルトタイムアウト

kafka_max_fetch_bytes = 1048576

整数値

Kafka コンシューマーの最大フェッチバイト

max_poll_records = 500

整数値

ポーリング呼び出しで返されるレコードの最大数

pool_size = 10

整数値

Kafka コンシューマーのプールサイズ

producer_batch_size = 16384

整数値

プロデューサーの非同期送信のバッチサイズ

producer_batch_timeout = 0.0

浮動小数点の値

KafkaProducer バッチ処理の遅延の上限 (秒単位)

sasl_mechanism = PLAIN

文字列値

セキュリティープロトコルが SASL である際のメカニズム

security_protocol = PLAINTEXT

文字列値

ブローカーとの通信に使用されるプロトコル

`ssl_cafile = `

文字列値

サーバーの証明書の検証に使用する CA 証明書 PEM ファイル

`ssl_client_cert_file = `

文字列値

認証に使用されるクライアント証明書の PEM ファイル。

`ssl_client_key_file = `

文字列値

認証に使用されるクライアントキーの PEM ファイル。

`ssl_client_key_password = `

文字列値

認証に使用されるクライアントキーパスワードファイル。

driver = []

多値

通知の送信を処理するドライバー。使用できる値は messaging、messagingv2、routing、log、test、noop です。

retry = -1

整数値

リカバリー可能なエラーが原因で配信に失敗した通知メッセージを再送信する最大試行回数。0 - 再試行なし、-1 - 無限回

topics = ['notifications']

リスト値

OpenStack の通知に使用する AMQP トピック。

transport_url = None

文字列値

通知に使用するメッセージングドライバーを表す URL。設定されていない場合は、RPC に使用されるものと同じ設定にフォールバックします。

amqp_auto_delete = False

ブール値

AMQP の自動削除キュー。

amqp_durable_queues = False

ブール値

AMQP で永続キューを使用します。rabbit_quorum_queue が有効な場合、キューは永続的になり、この値は無視されます。

direct_mandatory_flag = True

ブール値

(非推奨) ダイレクト送信のための RabbitMQ 必須フラグを有効/無効にします。直接送信は応答として使用されるため、クライアントキューが存在しない場合には MessageUndeliverable 例外が発生します。MessageUndeliverable 例外はタイムアウトをループして、送信者が回復する可能性が高くなります。このフラグは非推奨になり、この機能を非アクティブ化することはできません。

enable_cancel_on_failover = False

ブール値

x-cancel-on-ha-failover フラグを有効にして、rabbitmq サーバーがキューが停止しているときにコンシューマーをキャンセルし、通知できるようにします。

heartbeat_in_pthread = False

ブール値

デフォルトでは、ネイティブ Python スレッドを介してヘルスチェックハートビートスレッドを実行します。このオプションが False の場合、ヘルスチェックハートビートは親プロセスから実行モデルを継承します。たとえば、親プロセスが eventlet/greenlet を使用して stdlib にモンキーパッチを適用した場合、ハートビートはグリーンスレッドを介して実行されます。This option should be set to True only for the wsgi services.

heartbeat_rate = 2

整数値

heartbeat_timeout_threshold 中、ハートビートを確認する回数。

heartbeat_timeout_threshold = 60

整数値

ハートビートの keep-alive が失敗した場合に Rabbit ブローカーがダウンとみなされるまでの秒数 (0 はハートビートを無効にします)。

kombu_compression = None

文字列値

実験的用途: 許容値は gzip、bz2 です。設定されていない場合、圧縮は使用されません。このオプションは、今後のバージョンで利用できない可能性があります。

kombu_failover_strategy = round-robin

文字列値

現在接続しているノードが利用できなくなった場合に、次の RabbitMQ ノードを選択する方法を指定します。設定で複数の RabbitMQ ノードが指定される場合に限り有効になります。

kombu_missing_consumer_retry_timeout = 60

整数値

応答のないクライアントが応答を送信するのを待つ時間。この時間が経過すると無視します。この値は rpc_response_timeout より長くすることはできません。

kombu_reconnect_delay = 1.0

浮動小数点の値

AMQP コンシューマーのキャンセル通知に応答して再接続するまでの待機時間 (秒単位)。

rabbit_ha_queues = False

ブール値

RabbitMQ (x-ha-policy: all) の HA キューの使用を試みます。このオプションを変更する場合は、RabbitMQ データベースを消去する必要があります。RabbitMQ 3.0 では、キューを宣言する際に x-ha-policy 引数によってキューのミラーリングが制御されなくなりました。すべてのキュー (自動生成された名前のキューを除く) がすべてのノードでミラーリングされるようにするには、"rabbitmqctl set_policy HA ^(?!amq\.).* {"ha-mode": "all"}" を実行します。

rabbit_interval_max = 30

整数値

RabbitMQ 接続を再試行する最大間隔。デフォルトは 30 秒です。

rabbit_login_method = AMQPLAIN

文字列値

RabbitMQ ログイン方法

rabbit_qos_prefetch_count = 0

整数値

事前フェッチするメッセージの数を指定します。ゼロに設定すると、無制限のメッセージのフェッチが許可されます。

rabbit_quorum_delivery_limit = 0

整数値

メッセージがコンシューマーに再配信されるたびに、カウンターが増加します。再配信回数が配信制限を超えると、メッセージはドロップされるか、配信不能になります (DLX エクスチェンジが設定されている場合)。rabbit_quorum_queue が有効な場合にのみ使用されます。デフォルトは 0 で、制限を設定しないことを意味します。

rabbit_quorum_max_memory_bytes = 0

整数値

デフォルトでは、すべてのメッセージはメモリー内に保持されますが、クォーラムキューの長さが長くなると、クラスターでメモリーの逼迫が発生する可能性があります。このオプションを使用すると、クォーラムキューで使用されるメモリーバイト数を制限できます。rabbit_quorum_queue が有効な場合にのみ使用されます。デフォルトは 0 で、制限を設定しないことを意味します。

rabbit_quorum_max_memory_length = 0

整数値

デフォルトでは、すべてのメッセージはメモリー内に保持されますが、クォーラムキューの長さが長くなると、クラスターでメモリーの逼迫が発生する可能性があります。このオプションを使用すると、クォーラムキュー内のメッセージの数を制限できます。rabbit_quorum_queue が有効な場合にのみ使用されます。デフォルトは 0 で、制限を設定しないことを意味します。

rabbit_quorum_queue = False

ブール値

RabbitMQ でクォーラムキューを使用します (x-queue-type: quorum)。クォーラムキューは、Raft コンセンサスアルゴリズムに基づきレプリケートされた永続的な FIFO キューを実装する RabbitMQ の最新キュータイプです。RabbitMQ 3.8.0 以降で利用可能です。このオプションを設定すると、HA キュー (rabbit_ha_queues)、つまりミラーリングされたキューと競合します。そのため、HA キューは無効にする必要があります。クォーラムキューはデフォルトで永続的であるため、このオプションを有効にすると amqp_durable_queues オプションは無視されます。

rabbit_retry_backoff = 2

整数値

RabbitMQ に接続する際に再試行間でバックオフする長さ

rabbit_retry_interval = 1

整数値

RabbitMQ との接続を再試行する頻度。

rabbit_transient_queues_ttl = 1800

整数値

キューの TTL (x-expires) の期間 (秒単位) を表す正の整数。TTL の期間使用されないキューは自動的に削除されます。このパラメーターは応答キューとファンアウトキューにのみ影響します。

ssl = False

ブール値

SSL 経由で接続します。

`ssl_ca_file = `

文字列値

SSL 認証局ファイル (SSL が有効な場合にのみ有効)。

`ssl_cert_file = `

文字列値

SSL 証明書ファイル (SSL が有効な場合にのみ有効)。

ssl_enforce_fips_mode = False

ブール値

OpenSSL FIPS モードを強制するためのグローバルトグル。この機能には、Python のサポートが必要です。これはすべての環境の Python 3.9 で利用可能であり、特定の環境では古いバージョンの Python にバックポートされている可能性があります。使用される Python 実行ファイルが OpenSSL FIPS モードをサポートしていない場合は、例外が発生します。

`ssl_key_file = `

文字列値

SSL キーファイル (SSL が有効な場合にのみ有効)。

`ssl_version = `

文字列値

使用する SSL バージョン (SSL が有効な場合にのみ有効)。有効な値は TLSv1 および SSLv23 です。SSLv2、SSLv3、TLSv1_1、および TLSv1_2 は、一部のディストリビューションで利用できます。

enforce_new_defaults = False

ブール値

このオプションは、ポリシーを評価するときに古い非推奨のデフォルトを使用するかどうかを制御します。True の場合、古い非推奨のデフォルトは評価されません。これは、既存のトークンが古いデフォルトで許可されているが、新しいデフォルトで許可されていない場合、許可されないことを意味します。新しいデフォルトと scope_type の利点を同時に得られるように、このフラグを enforce_scope フラグと併せて有効にすることが推奨されます。False の場合、非推奨のポリシーチェック文字列は新しいポリシーチェック文字列と論理的に OR 演算され、新しいポリシーを含むリリース間でのデフォルト動作であるグレースフルアップグレードが可能になります。

enforce_scope = False

ブール値

このオプションは、ポリシーを評価する際にスコープを適用するかどうかを制御します。True の場合、リクエストで使用されるトークンのスコープは、適用されるポリシーの scope_types と比較されます。スコープが一致しない場合、InvalidScope 例外が発生します。False の場合、ポリシーが一致しないスコープで呼び出されていることを運用者に通知するメッセージが記録されます。

policy_default_rule = default

文字列値

デフォルトルール。要求されたルールが見つからない場合に適用されます。

policy_dirs = ['policy.d']

多値

ポリシー設定ファイルが保存されるディレクトリー。これは、config_dir オプションで定義される検索パス内の任意のディレクトリーへの相対パスか、絶対パスにすることができます。このディレクトリーの検索には、policy_file で定義されたファイルが存在している必要があります。存在しないディレクトリーまたは空のディレクトリーは無視されます。

policy_file = policy.json

文字列値

ロールを指定のサービスのパーミッションにマッピングするファイルの相対パスまたは絶対パス。相対パスは、このオプションを設定する設定ファイルに対する相対パスとして指定する必要があります。

remote_content_type = application/x-www-form-urlencoded

文字列値

REST ベースのポリシーチェックのデータを送受信するコンテンツ種別

remote_ssl_ca_crt_file = None

文字列値

REST ベースのポリシーチェック用の認証局証明書ファイルの絶対パス

remote_ssl_client_crt_file = None

文字列値

REST ベースのポリシーチェック用のクライアント証明書の絶対パス

remote_ssl_client_key_file = None

文字列値

REST ベースのポリシーチェック用のクライアント鍵ファイルの絶対パス

remote_ssl_verify_server_crt = False

ブール値

REST ベースのポリシーチェックのサーバーアイデンティティー検証

alias = []

多値

vendor_id フィールドおよび product_id フィールドで識別される PCI デバイスのエイリアス。形式: {"vendor_id": "1234", "product_id": "5678", "name": "pci_dev1"}

cidr_map = []

リスト値

IP サブネット CIDR から物理ネットワークへのマッピング。physnet_cidr_map 処理フックが有効になっている場合、ベアメタルポートの physical_network プロパティーは、このマッピングに基づいて入力されます。

add_ports = pxe

文字列値

イントロスペクション中にポートとして追加する MAC アドレス。使用できる値: all (すべての MAC アドレス)、"active" (IP アドレスを使用する NIC の MAC アドレス)、pxe (PXE ブート元である NIC ノードの MAC アドレスのみ)、RAM ディスクで PXE MAC が指定されていない場合のアクティブにフォールバックします。

always_store_ramdisk_logs = False

ブール値

エラーメッセージが返されない場合でも ramdisk ログを保存するかどうか ("ramdisk_logs_dir" オプションが設定されているかどうか)。

default_processing_hooks = ramdisk_error,root_disk_selection,scheduler,validate_interfaces,capabilities,pci_devices

文字列値

パイプラインを処理するデフォルトフックのコンマ区切りリスト。フック スケジューラー により、Nova スケジューラーが必要とする最低限のプロパティーでノードが更新されます。フック validate_interfaces は、ramdisk が有効な NIC データを提供します。実際に何を行うのかがわかっていない限り、この 2 つを除外しないでください。

disk_partitioning_spacing = True

ブール値

パーティショニングのために 1 GiB のディスクサイズを残すかどうか。IPA で ramdisk として使用する場合に限り、以前の ramdisk local_gb が ramdisk 側で算出されます。

keep_ports = all

文字列値

イントロスペクションの後に保持するポート (ノード上に準備済み) します。使用できる値は、all (何も削除しない)、present (イントロスペクションデータに存在する MAC ポート)、added (イントロスペクション中に追加した MAC のみ) です。

node_not_found_hook = None

文字列値

インスペクターがノードから検査情報を受け取る際に実行されるフックの名前。このフックはデフォルトで無視されます。

overwrite_existing = True

ブール値

ノードデータベースの既存の値を上書きするかどうか。このオプションを無効にして、非破壊的な操作を行います。

permit_active_introspection = False

ブール値

稼働状態のノードを処理するかどうか。

power_off = True

ブール値

イントロスペクション後にノードの電源をオフにするかどうか。permit_active_introspection 設定オプションによって機能が有効になっている場合、イントロスペクションデータを送信するアクティブ状態またはレスキュー状態のノードはオンのままになります。

processing_hooks = $default_processing_hooks

文字列値

パイプラインを処理するための有効なフックのコンマ区切りリスト。このデフォルトは $default_processing_hooks で、"prehook,$default_processing_hooks,posthook" のように、デフォルトの前または後にフックを追加することができます。

ramdisk_logs_dir = None

文字列値

これを設定すると、ramdisk からのログはこのディレクトリーに保存されます。

ramdisk_logs_filename_format = {uuid}_{dt:%Y%m%d-%H%M%S.%f}.tar.gz

文字列値

ramdisk ログを保存するファイル名のテンプレート。{uuid} - node UUID または "unknown"、{bmc} - node BMC アドレスまたは "unknown"、{dt} - 現在の UTC 日時、{mac} - PXE ブートの MAC または "unknown" の置換を使用できます。

store_data = none

文字列値

イントロスペクションデータを保存するためのストレージバックエンド。使用できる値は none、database、swift です。none に設定すると、イントロスペクションデータは保存されません。

update_pxe_enabled = True

ブール値

イントロスペクションデータに従って pxe_enabled 値を更新するかどうか。[processing]overwrite_existing が False に設定されている場合、このオプションは効果がありません。

deny_unknown_macs = False

ブール値

デフォルトでは、イントロスペクションがアクティブな場合、インスペクターは任意のノードの DHCP サーバーを開きます。イントロスペクションがアクティブなときに未知の MAC アドレスに対して DHCP を開くと、ユーザーはポートのないノードを ironic に追加し、ノードのイントロスペクションの結果に基づいて ironic-inspector にポートを登録させることができます。注記: このオプションが True の場合、ノードにはイントロスペクションの前に少なくとも 1 つの登録済みポートが必要です。

driver = iptables

文字列値

使用する PXE ブートフィルタードライバー、使用可能なフィルターは "iptables"、"dnsmasq"、および "noop" です。"noop" を設定して、ファイアウォールのフィルタリングを無効にします。

sync_period = 15

整数値

フィルターの定期的な更新を繰り返すまでの時間 (秒単位)。

auth-url = None

文字列値

認証 URL

auth_type = None

文字列値

読み込む認証タイプ

cafile = None

文字列値

HTTP 接続の検証時に使用する PEM でエンコードされた認証局。

certfile = None

文字列値

PEM でエンコードされたクライアント証明書の証明書ファイル

collect-timing = False

ブール値

API ごとの呼び出しタイミング情報を収集します。

connect-retries = None

整数値

接続エラーに対して試行される再試行の最大数。

connect-retry-delay = None

浮動小数点の値

接続エラーに対する 2 つの再試行の遅延 (秒単位)。設定されていない場合は、最大 60 秒まで 0.5 秒から開始する指数関数の再試行が使用されます。

default-domain-id = None

文字列値

v3 および v2 パラメーターで使用するオプションのドメイン ID。v3 のユーザーおよびプロジェクトドメインに使用され、v2 認証では無視されます。

default-domain-name = None

文字列値

v3 API および v2 パラメーターで使用するオプションのドメイン名です。v3 のユーザーおよびプロジェクトドメインに使用され、v2 認証では無視されます。

domain-id = None

文字列値

スコープするドメイン ID

domain-name = None

文字列値

スコープするドメイン名

endpoint-override = None

文字列値

このクライアントのリクエストには常にこのエンドポイント URL を使用します。注意: バージョンを指定しないエンドポイントはここで指定する必要があります。特定の API バージョンを要求するには、version、min-version オプション、または max-version オプション、もしくはそれを組み合わせてを使用します。

insecure = False

ブール値

HTTPS 接続を確認します。

keyfile = None

文字列値

PEM でエンコードされたクライアント証明書キーファイル

max-version = None

文字列値

特定の API の最大メジャーバージョンで、min_version を持つ範囲の上限として使用されることが意図されています。version と相互に排他的です。

min-version = None

文字列値

指定の API の最小メジャーバージョンで、max_version を持つ範囲の下限として使用することが意図されています。version と相互に排他的です。max_version なしで min_version が指定されている場合は、max version が "latest" の場合になります。

password = None

文字列値

ユーザーのパスワード

project-domain-id = None

文字列値

プロジェクトを含むドメイン ID

project-domain-name = None

文字列値

プロジェクトを含むドメイン名

project-id = None

文字列値

スコープするプロジェクト ID

project-name = None

文字列値

スコープするプロジェクト名

region-name = None

文字列値

エンドポイント URL 検出のデフォルト region_name。

service-name = None

文字列値

エンドポイント URL 検出のデフォルト service_name。

service-type = baremetal-introspection

文字列値

エンドポイント URL 検出のデフォルト service_type。

split-loggers = False

ブール値

複数のロガーへの要求をログに記録します。

status-code-retries = None

整数値

再試行可能な HTTP ステータスコードに対して試行される再試行の最大数。

status-code-retry-delay = None

浮動小数点の値

再試行可能なステータスコードに対する 2 つの再試行間の遅延 (秒単位)。設定されていない場合は、最大 60 秒まで 0.5 秒から開始する指数関数の再試行が使用されます。

system-scope = None

文字列値

システム操作のスコープ

tenant-id = None

文字列値

テナント ID

tenant-name = None

文字列値

テナント名

timeout = None

整数値

http 要求のタイムアウト値

trust-id = None

文字列値

trustee として使用する信頼の ID

user-domain-id = None

文字列値

ユーザーのドメイン ID

user-domain-name = None

文字列値

ユーザーのドメイン名

user-id = None

文字列値

ユーザー ID

username = None

文字列値

Username

valid-interfaces = ['internal', 'public']

リスト値

エンドポイント URL のインターフェイスのリスト (優先順)。

version = None

文字列値

エンドポイント URL 検出用に指定の Major API バージョン内の最小の Major API バージョン。min_version および max_version と相互排他的になる

ca_file = None

文字列値

接続クライアントの検証に使用する CA 証明書ファイル。

cert_file = None

文字列値

サーバーをセキュアに起動する際に使用する証明書ファイル。

ciphers = None

文字列値

利用可能な暗号のリストを設定します。値は OpenSSL 暗号リスト形式の文字列である必要があります。

key_file = None

文字列値

サーバーをセキュアに起動する際に使用する秘密鍵ファイル。

version = None

文字列値

使用する SSL バージョン (SSL が有効な場合にのみ有効)。有効な値は TLSv1 および SSLv23 です。SSLv2、SSLv3、TLSv1_1、および TLSv1_2 は、一部のディストリビューションで利用できます。

auth-url = None

文字列値

認証 URL

auth_type = None

文字列値

読み込む認証タイプ

cafile = None

文字列値

HTTP 接続の検証時に使用する PEM でエンコードされた認証局。

certfile = None

文字列値

PEM でエンコードされたクライアント証明書の証明書ファイル

collect-timing = False

ブール値

API ごとの呼び出しタイミング情報を収集します。

connect-retries = None

整数値

接続エラーに対して試行される再試行の最大数。

connect-retry-delay = None

浮動小数点の値

接続エラーに対する 2 つの再試行の遅延 (秒単位)。設定されていない場合は、最大 60 秒まで 0.5 秒から開始する指数関数の再試行が使用されます。

container = ironic-inspector

文字列値

オブジェクトの作成時に使用するデフォルトの Swift コンテナー。

default-domain-id = None

文字列値

v3 および v2 パラメーターで使用するオプションのドメイン ID。v3 のユーザーおよびプロジェクトドメインに使用され、v2 認証では無視されます。

default-domain-name = None

文字列値

v3 API および v2 パラメーターで使用するオプションのドメイン名です。v3 のユーザーおよびプロジェクトドメインに使用され、v2 認証では無視されます。

delete_after = 0

整数値

Swift オブジェクトが削除されるまでの秒数 (オブジェクトを削除しない場合は 0 に設定します)。

domain-id = None

文字列値

スコープするドメイン ID

domain-name = None

文字列値

スコープするドメイン名

endpoint-override = None

文字列値

このクライアントのリクエストには常にこのエンドポイント URL を使用します。注意: バージョンを指定しないエンドポイントはここで指定する必要があります。特定の API バージョンを要求するには、version、min-version オプション、または max-version オプション、もしくはそれを組み合わせてを使用します。

insecure = False

ブール値

HTTPS 接続を確認します。

keyfile = None

文字列値

PEM でエンコードされたクライアント証明書キーファイル

max-version = None

文字列値

特定の API の最大メジャーバージョンで、min_version を持つ範囲の上限として使用されることが意図されています。version と相互に排他的です。

min-version = None

文字列値

指定の API の最小メジャーバージョンで、max_version を持つ範囲の下限として使用することが意図されています。version と相互に排他的です。max_version なしで min_version が指定されている場合は、max version が "latest" の場合になります。

password = None

文字列値

ユーザーのパスワード

project-domain-id = None

文字列値

プロジェクトを含むドメイン ID

project-domain-name = None

文字列値

プロジェクトを含むドメイン名

project-id = None

文字列値

スコープするプロジェクト ID

project-name = None

文字列値

スコープするプロジェクト名

region-name = None

文字列値

エンドポイント URL 検出のデフォルト region_name。

service-name = None

文字列値

エンドポイント URL 検出のデフォルト service_name。

service-type = object-store

文字列値

エンドポイント URL 検出のデフォルト service_type。

split-loggers = False

ブール値

複数のロガーへの要求をログに記録します。

status-code-retries = None

整数値

再試行可能な HTTP ステータスコードに対して試行される再試行の最大数。

status-code-retry-delay = None

浮動小数点の値

再試行可能なステータスコードに対する 2 つの再試行間の遅延 (秒単位)。設定されていない場合は、最大 60 秒まで 0.5 秒から開始する指数関数の再試行が使用されます。

system-scope = None

文字列値

システム操作のスコープ

tenant-id = None

文字列値

テナント ID

tenant-name = None

文字列値

テナント名

timeout = None

整数値

http 要求のタイムアウト値

trust-id = None

文字列値

trustee として使用する信頼の ID

user-domain-id = None

文字列値

ユーザーのドメイン ID

user-domain-name = None

文字列値

ユーザーのドメイン名

user-id = None

文字列値

ユーザー ID

username = None

文字列値

Username

valid-interfaces = ['internal', 'public']

リスト値

エンドポイント URL のインターフェイスのリスト (優先順)。

version = None

文字列値

エンドポイント URL 検出用に指定の Major API バージョン内の最小の Major API バージョン。min_version および max_version と相互排他的になる