3.3. glance-scrubber.conf

allow_additional_image_properties = True

ブール値

ユーザーがイメージに追加/カスタムの属性を追加できるようにします。

Glance は、すべてのイメージに表示される属性の標準セット ()スキーマ) を定義します。これらのプロパティーは、base properties とも呼ばれます。Glance では、これらの属性に加え、カスタムプロパティーをイメージに追加できます。これらは、additional properties と呼ばれています。

デフォルトでは、この設定オプションは True に設定され、ユーザーは追加のプロパティーを追加できます。イメージに追加できる追加プロパティーの数は、image_property_quota 設定オプションで制御できます。

以下の値を使用できます。

関連するオプション:

api_limit_max = 1000

整数値

要求によって返されることのできる最大結果数。

limit_param_default のヘルプテキストで説明されているように、リクエストによっては複数の結果が返される場合があります。返される結果の数は、要求の limit パラメーターまたは limit_param_default 設定オプションで管理されます。いずれの場合もこの値が、この設定オプションで定義される絶対最大値よりも大きくすることはできません。この値より大きいすべてのものは、ここで定義される最大値にトリミングされます。

以下の値を使用できます。

関連するオプション:

daemon = False

ブール値

スクラバーをデーモンとして実行します。

このブール値設定オプションは、スクラバーが、イメージをスクラブするのに一定間隔で起動する長時間実行プロセスとして実行されるかどうかを示します。起動の間隔は、設定オプション wakeup_time を使用して指定できます。

この設定オプションがデフォルト値の False に設定されている場合、スクラバーはイメージのスクラブのために1回動作して終了します。この場合、運用者がイメージの継続的なスクラビングを実装する場合、スクラバーは cron ジョブとしてスケジュールする必要があります。

以下の値を使用できます。

関連するオプション:

data_api = glance.db.sqlalchemy.api

文字列値

データアクセス API の Python モジュールパス。

データモデルへのアクセスに使用する API へのパスを指定します。このオプションは、イメージカタログデータへのアクセス方法を決定します。

以下の値を使用できます。

このオプションを glance.db.sqlalchemy.api に設定すると、イメージカタログデータが に保存され、SQLAlchemy Core および ORM API 経由でデータベースから読み取られます。

このオプションを glance.db.registry.api に設定すると、すべてのデータベースアクセス要求が Registry サービス経由で強制的にルーティングされます。これにより、セキュリティー、スケーラビリティー、管理性を向上させるために、Glance API ノードからのデータアクセスが回避されます。

最後に、この設定オプションが glance.db.simple.api に設定されている場合、イメージカタログデータが に保存され、インメモリーデータ構造から読み取られます。これは主にテストに使用されます。

関連するオプション:

debug = False

ブール値

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

default_log_levels = ['amqp=WARN'、'amqplib=WARN'、'boto=WARN'、'qpid=WARN'、'sqlalchemy=WARN'、'suds=INFO'、'oslo.messaging=INFO'、'oslo_messaging=INFO'、'iso8601=WARN'、'requests.packages.urllib3.connectionpool=WARN'、'urllib3.connectionpool=WARN'、'websocket=WARN'、'requests.packages.urllib3.util.retry=WARN'、'urllib3.util.retry=WARN'、'keystonemiddleware=WARN'、'routes.middleware=WARN'、'stevedore=WARN'、'taskflow=WARN'、'keystoneauth=WARN'、'oslo.cache=INFO'、'oslo_policy=INFO'、'dogpile.core.dogpile=INFO']

リスト値

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

delayed_delete = False

ブール値

削除をオン/オフにします。

通常、画像が削除されると、glance-api サービスは画像を delete 状態にし、同時にそのデータを削除します。遅延削除とは、Glance の機能のひとつで、画像データの実際の削除を (設定オプション scrub_time で決定される) 後の時点まで遅らせるものです。遅延削除が有効になると、glance-api サービスは削除時にイメージを pending_delete の状態に入れ、イメージが scrubber のストレージバックエンドに残され、後で削除されるようにします。イメージスクラバは、画像データの削除に成功すると、画像を deleted 状態に移行させます。

以下の値を使用できます。

関連するオプション:

digest_algorithm = sha256

文字列値

デジタル署名に使用するダイジェストアルゴリズム。

デジタル署名の生成に使用するダイジェストアルゴリズムを表す文字列値を指定します。デフォルトでは sha256 が使用されます。

プラットフォームの OpenSSL バージョンでサポートされる利用可能なアルゴリズムの一覧を取得するには、コマンド openssl list-message-digest-algorithms を実行します。たとえば、sha1、sha256、および sha512 です。

以下の値を使用できます。

関係オプション:

enable_v1_registry = True

ブール値

DEPRECATED FOR REMOVAL

enable_v2_api = True

ブール値

v2 OpenStack Images API をデプロイします。

このオプションが True に設定されている場合、Glance サービスは v2 OpenStack Images API に準拠する登録済みエンドポイントで要求に応答します。

注記:

以下の値を使用できます。

関連するオプション:

enable_v2_registry = True

ブール値

v2 API Registry サービスをデプロイします。

このオプションが True に設定されている場合、レジストリーサービスは v2 API 要求に対して Glance で有効化されます。

注記:

以下の値を使用できます。

関連するオプション:

enabled_import_methods = ['glance-direct', 'web-download']

リスト値

有効なイメージのインポート方法の一覧

glance-direct および web-download の両方はデフォルトで有効化されています。

関連するオプション:

fatal_deprecations = False

ブール値

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

hashing_algorithm = sha512

文字列値

os_hash_value プロパティーの計算に使用されるセキュアなハッシュアルゴリズム。

このオプションは、os_hash_algo と os_hash_value の 2 つのイメージ属性で構成される Glance の「multihash」を設定します。os_hash_algo はこの設定オプションの値によって入力され、os_hash_value は、アルゴリズムがアップロードまたはインポートされたイメージデータに適用されると計算された hexdigest によって入力されます。

この値は、python hashlib ライブラリーが認識する有効なセキュアなハッシュアルゴリズム名である必要があります。Glance インストールで使用されているライブラリーのバージョンの hashlib.algorithms_available データメンバーを調べることで、これらを確認することができます。ただし、相互運用性のために、hashlib.algorithms_guaranteed データメンバーが提供する安全なハッシュ名のセットを使用することが推奨されます。これは、すべてのプラットフォームの hashlib ライブラリーでサポートされることが保証されているためです。したがって、hashlib を使用するイメージコンシューマーは、イメージの os_hash_value を検証できるはずです。

sha512 のデフォルト値は、高性能なハッシュアルゴリズムです。

このオプションの設定が間違っていると、イメージデータの格納試行は失敗します。このため、デフォルト値を使用することが推奨されます。

以下の値を使用できます。

関連するオプション:

image_location_quota = 10

整数値

イメージで許可される場所の最大数。

負の値は無制限として解釈されます。

関連するオプション:

image_member_quota = 128

整数値

1 イメージあたりのイメージメンバーの最大数。

これにより、イメージが共有できるユーザーの最大数が制限されます。負の値は無制限として解釈されます。

関連するオプション:

image_property_quota = 128

整数値

イメージで許可されるプロパティーの最大数。

これにより、イメージに割り当てることができる追加のプロパティーの数の上限が適用されます。負の値は無制限として解釈されます。

関連するオプション:

image_size_cap = 1099511627776

整数値

ユーザーがアップロードできるイメージの最大サイズ (バイト単位)。

上記のサイズより大きいイメージをアップロードすると、イメージの作成に失敗します。このオプションはデフォルトで 1099511627776 バイト (1 TiB) に設定されます。

注記:

以下の値を使用できます。

image_tag_quota = 128

整数値

イメージで許可されるタグの最大数。

負の値は無制限として解釈されます。

関連するオプション:

instance_format = [instance: %(uuid)s]

文字列値

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

instance_uuid_format = [instance: %(uuid)s]

文字列値

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

limit_param_default = 25

整数値

リクエストに対して返すデフォルトの結果数。

リストイメージなどの特定の API リクエストへの応答により、複数のアイテムが返される場合があります。返される結果の数は、API 要求で limit パラメーターを指定して明示的に制御できます。ただし、limit パラメーターが指定されていない場合、この設定値は API 要求に対して返される結果のデフォルト数として使用されます。

注記:

以下の値を使用できます。

関連するオプション:

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_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 [%(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 %(tenant)s %(domain)s %(user_domain)s %(project_domain)s

文字列値

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

max_logfile_count = 30

整数値

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

max_logfile_size_mb = 200

整数値

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

metadata_encryption_key = None

文字列値

ストアの場所のメタデータを暗号化する際の AES 鍵。

Glance ストアメタデータの暗号化に使用する AES 暗号化を表す文字列値を指定します。

以下の値を使用できます。

関連するオプション:

node_staging_uri = file:///tmp/staging/

文字列値

URL は一時データが保存される場所を指定します。

このオプションは、Glance の内部使用専用です。Glance は、イメージのインポートプロセス中、ユーザーがアップロードしたイメージデータを ステージング エンドポイントに保存します。

このオプションは、ステージング API エンドポイントを一切変更しません。

以下の値を使用できます。

関連するオプション:

publish_errors = False

ブール値

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

pydev_worker_debug_host = None

ホストのアドレス値

pydev サーバーのホストアドレス。

デバッグに使用する pydev サーバーのホスト名または IP を表す文字列値を指定します。pydev サーバーはこのアドレスでデバッグ接続をリッスンし、Glance でのリモートデバッグを容易にします。

以下の値を使用できます。

関連するオプション:

pydev_worker_debug_port = 5678

ポート値

pydev サーバーがリッスンするポート番号。

pydev サーバーをバインドするポート番号を指定します。pydev プロセスはこのポートでデバッグ接続を受け入れ、Glance でのリモートデバッグを容易にします。

以下の値を使用できます。

関連するオプション:

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

整数値

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

restore = None

文字列値

イメージのステータスを pending_delete から active に復元します。

このオプションは、イメージが誤って削除され、Glance で削除の保留 機能が有効な場合に、管理者がイメージのステータスを pending_delete から active にリセットする際に使用されます。イメージデータの不整合を避けるために、イメージを復元する前に glance-scrubber デーモンが停止していることを確認してください。

以下の値を使用できます。

scrub_pool_size = 1

整数値

イメージのスクラビングに使用されるスレッドプールのサイズ。

スクラブするイメージが多数ある場合には、スクラブキューが制御された状態に維持され、バックエンドストレージがタイムリーに要求されるように、イメージを並行してスクラブすると便利です。この設定オプションは、並行してスクラブされるイメージの最大数を示します。デフォルト値は 1 で、シリアルスクラビングを意味します。1 を超える値はすべて、並列スクラビングを意味します。

以下の値を使用できます。

関連するオプション:

scrub_time = 0

整数値

イメージのスクラビングを遅延させる時間（秒単位）。

遅延削除がオンの場合、スクラバーがそのイメージデータを削除するまで、イメージは削除時に pending_delete 状態になります。通常、イメージが pending_delete 状態になると、すぐにスクラビングできます。ただし、この設定オプションを使用して、後の時点までスクラビングを遅らせることができます。このオプションは、スクラビングできるまで、イメージが pending_delete 状態である期間を示します。

これによりストレージに影響が出ることを認識することが重要です。scrub_time の値が大きいほど、削除されるイメージからバックエンドストレージを再要求する時間が長くなります。

以下の値を使用できます。

関連するオプション:

show_image_direct_url = False

ブール値

イメージを返す際に直接イメージの場所を示します。

この設定オプションは、イメージの詳細をユーザーに返すときに直接イメージの場所を表示するかどうかを指定します。直接イメージの場所は、バックエンドストレージ内でイメージデータが保存される場所です。このイメージの場所は、イメージ属性 direct_url セクションに表示されます。

イメージに対して複数のイメージの場所が存在する場合には、設定オプション location_strategy で示される場所ストラテジーに基づいて、最適な場所が表示されます。

注記:

以下の値を使用できます。

関連するオプション:

show_multiple_locations = False

ブール値

イメージを返す際にすべてのイメージの場所を示します。

この設定オプションは、イメージの詳細をユーザーに返すときにすべてのイメージの場所を表示するかどうかを指定します。イメージに対して複数のイメージの場所が存在する場合には、設定オプション location_strategy で示される場所ストラテジーに基づいて、場所が順番に表示されます。イメージの場所は、イメージ属性 locations セクションに表示されます。

注記:

以下の値を使用できます。

関連するオプション:

syslog-log-facility = LOG_USER

文字列値

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

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_stderr = False

ブール値

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

user_storage_quota = 0

文字列値

テナントごとのイメージストレージの最大容量。

これにより、全ストアにわたってテナントのすべてのイメージによって消費される累積ストレージに上限が適用されます。これはテナントごとの制限です。

この設定オプションのデフォルトの単位はバイトです。ただし、ストレージの単位は、大文字/小文字を区別する文字B、KB、MB、GB、および TBを使用して指定することができ、それぞれバイト、キロバイト、メガバイト、ギガバイト、およびテラバイトを表します。値と単位の間にはスペースを入れないでください。値 0 は、クォータが適用されないことを意味します。負の値は無効で、エラーが発生します。

以下の値を使用できます。

関連するオプション:

wakeup_time = 300

整数値

スクラバーがデーモンモードで実行される間隔（秒単位）。

スクラバーは、cron ジョブまたはデーモンのいずれかとして実行できます。デーモンとして実行する場合、この設定時間は 2 つの実行の間隔を指定します。スクラバーが起動すると、scrub_time を考慮した後に、スクラブできるすべての pending_delete イメージを取得してスクラブします。

起動間隔が大きな数値に設定されている場合には、実行ごとに多数のイメージがスクラブされる可能性があります。これにより、バックエンドストレージが再要求される速度にも影響が出ます。

以下の値を使用できます。

関連するオプション:

watch-log-file = False

ブール値

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