サーバー設定¶
Incus サーバーは key/value 設定オプションで設定できます。
key/value 設定は名前空間が分けられています。 以下のオプションが利用可能です:
設定オプションをどのように設定するかについての手順はIncusサーバーを設定するにはを参照してください。
注釈
このページの表でglobalスコープと表記されたオプションは即時に全てのクラスタメンバーに適用されます。
localスコープと表記されたオプションはメンバーごとに設定する必要があります。
コア設定¶
以下のサーバーオプションはコアデーモンの設定を制御します:
| Key: | core.bgp_address |
| Type: | string |
| Scope: | local |
| Key: | core.bgp_asn |
| Type: | string |
| Scope: | global |
| Key: | core.bgp_routerid |
| Type: | string |
| Scope: | local |
識別子はIPv4アドレスの形式である必要があります。
| Key: | core.dns_address |
| Type: | string |
| Scope: | local |
| Key: | core.https_address |
| Type: | string |
| Scope: | local |
| Key: | core.https_allowed_credentials |
| Type: | bool |
| Default: |
|
| Scope: | global |
有効にすると、Access-Control-Allow-Credentials HTTPヘッダーの値がtrueに設定されます。
| Key: | core.https_allowed_headers |
| Type: | string |
| Scope: | global |
| Key: | core.https_allowed_methods |
| Type: | string |
| Scope: | global |
| Key: | core.https_allowed_origin |
| Type: | string |
| Scope: | global |
| Key: | core.https_trusted_proxy |
| Type: | string |
| Scope: | global |
プロキシの接続ヘッダーを通してクライアントのアドレスを提供するトラストサーバーのIPアドレスのカンマ区切りリストを指定します。
| Key: | core.metrics_address |
| Type: | string |
| Scope: | local |
メトリクスを監視するには参照。
| Key: | core.metrics_authentication |
| Type: | bool |
| Default: |
|
| Scope: | global |
| Key: | core.proxy_http |
| Type: | string |
| Scope: | global |
このオプションが設定されない場合、デーモンは（設定されていれば）HTTP_PROXY環境変数にフォールバックします。
| Key: | core.proxy_https |
| Type: | string |
| Scope: | global |
このオプションが設定されない場合、デーモンは（設定されていれば）HTTPS_PROXY環境変数にフォールバックします。
| Key: | core.proxy_ignore_hosts |
| Type: | string |
| Scope: | global |
NO_PROXYと同様な形式（例えば、 1.2.3.4,1.2.3.5）でこのオプションを指定します。
このオプションが指定されない場合、デーモンは（設定されていれば）NO_PROXY環境変数にフォールバックします。
| Key: | core.remote_token_expiry |
| Type: | string |
| Default: | no expiry |
| Scope: | global |
| Key: | core.shutdown_action |
| Type: | string |
| Default: |
|
| Scope: | global |
デーモンがシャットダウンされる際に実行するアクションを指定します。
指定できる値はshutdown（すべてのインスタンスを停止）、evacuate（クラスター化されたサーバーを退避させる）。
| Key: | core.shutdown_timeout |
| Type: | integer |
| Default: |
|
| Scope: | global |
デーモンが停止するまで実行中の操作を何分待つかの分の数。
| Key: | core.storage_buckets_address |
| Type: | string |
| Scope: | local |
| Key: | core.syslog_socket |
| Type: | bool |
| Default: |
|
| Scope: | local |
このオプションをtrueに設定すると、外部プロセスからのログメッセージを受信するsyslogのunixgramのソケットが有効化されます。
ACME設定¶
以下のサーバーオプションはACME設定を制御します:
| Key: | acme.ca_url |
| Type: | string |
| Default: |
|
| Scope: | global |
| Key: | acme.challenge |
| Type: | string |
| Default: |
|
| Scope: | global |
設定可能な値はDNS-01とHTTP-01。
| Key: | acme.http.port |
| Type: | string |
| Default: |
|
| Scope: | global |
HTTPベースのチャレンジでリッスンするポートとインターフェースを設定します。
| Key: | acme.provider |
| Type: | string |
| Default: | `` |
| Scope: | global |
| Key: | acme.provider.environment |
| Type: | string |
| Default: | `` |
| Scope: | global |
OpenID Connect 設定¶
以下のサーバーオプションはOpenID Connect認証による外部ユーザー認証を設定します:
| Key: | oidc.audience |
| Type: | string |
| Scope: | global |
この値はいくつかのプロバイダーで必要です。
| Key: | oidc.claim |
| Type: | string |
| Scope: | global |
アクセストークン内にクレームが含まれる必要があることに注意してください。
OpenFGA 設定¶
以下のサーバーオプションは Open Fine-Grained Authorization (OpenFGA) を使った外部ユーザー認可を設定します:
クラスタ設定¶
以下のサーバーオプションはクラスタリングを制御します:
| Key: | cluster.healing_threshold |
| Type: | integer |
| Default: |
|
| Scope: | global |
オフラインのクラスタメンバーが退避されるまでの秒数を指定します。
オフラインメンバーの退避を無効化するには、このオプションを0に設定します。
| Key: | cluster.https_address |
| Type: | string |
| Scope: | local |
| Key: | cluster.images_minimal_replica |
| Type: | integer |
| Default: |
|
| Scope: | global |
特定のイメージのコピーを保持するクラスタメンバーの最小数を指定します。
このオプションを1にすると複製なし、-1にするとすべてのメンバーでイメージを複製します。
| Key: | cluster.join_token_expiry |
| Type: | string |
| Default: |
|
| Scope: | global |
| Key: | cluster.max_standby |
| Type: | integer |
| Default: |
|
| Scope: | global |
データベースのスタンバイロールが割り当てられるクラスタメンバーの最大数を指定します。
これは0と5の間の整数である必要があります。
| Key: | cluster.max_voters |
| Type: | integer |
| Default: |
|
| Scope: | global |
データベースのvoterロールが割り当てられるクラスタメンバーの最大数を指定します。
これは3以上の奇数である必要があります。
| Key: | cluster.offline_threshold |
| Type: | integer |
| Default: |
|
| Scope: | global |
反応しないメンバーがオフラインと判定されるまでの秒数を指定します。
| Key: | cluster.rebalance.batch |
| Type: | integer |
| Default: |
|
| Scope: | global |
| Key: | cluster.rebalance.cooldown |
| Type: | string |
| Default: |
|
| Scope: | global |
| Key: | cluster.rebalance.interval |
| Type: | integer |
| Default: |
|
| Scope: | global |
イメージ設定¶
以下のサーバーオプションはImagesをどう取り扱うかを設定します:
| Key: | images.auto_update_cached |
| Type: | bool |
| Default: |
|
| Scope: | global |
| Key: | images.auto_update_interval |
| Type: | integer |
| Default: |
|
| Scope: | global |
間隔を時間単位で指定します。
キャッシュされたイメージの更新の確認を無効化するには、このオプションを0に設定します。
| Key: | images.compression_algorithm |
| Type: | string |
| Default: |
|
| Scope: | global |
設定できる値はbzip2、gzip、lz4、lzma、xz、zstd、noneです。
| Key: | images.default_architecture |
| Type: | string |
ログ設定¶
ログシステムは複数のターゲットが設定できるようになりました。ターゲットはユニークな名前（例：loki1、syslog01）により識別されます。
各ターゲットは独立して設定でき、固有のログ種別が割り当てられます。
サポートされるターゲット¶
loki- Grafana Lokiサーバーにログを送信syslog- リモートのsyslogエンドポイントにログを送信
設定例¶
logging.loki01.target.type: loki
logging.loki01.target.address: https://loki01.int.example.net
logging.loki01.target.username: foo
logging.loki01.target.password: bar
logging.loki01.types: lifecycle,network-acl
logging.loki01.lifecycle.types: instance
logging.syslog01.target.type: syslog
logging.syslog01.target.address: syslog01.int.example.net
logging.syslog01.target.facility: security
logging.syslog01.types: logging
logging.syslog01.logging.level: warning
| Key: | logging.NAME.lifecycle.projects |
| Type: | string |
| Scope: | global |
| Key: | logging.NAME.lifecycle.types |
| Type: | string |
| Scope: | global |
| Key: | logging.NAME.logging.level |
| Type: | string |
| Default: |
|
| Scope: | global |
| Key: | logging.NAME.target.address |
| Type: | string |
| Scope: | global |
プロトコル、名前かIP、ポートを指定。例えばtcp://syslog01.int.example.net:514。
| Key: | logging.NAME.target.facility |
| Type: | string |
| Scope: | global |
| Key: | logging.NAME.target.instance |
| Type: | string |
| Default: | ローカルサーバーのホスト名かクラスターのメンバー名 |
| Scope: | global |
これによりデフォルトのインスタンスの値（サーバーホスト名）をクラスターIDのようなより関連する値に置き換えられます。
| Key: | logging.NAME.target.labels |
| Type: | string |
| Scope: | global |
Lokiログエントリーのラベルとして使われる値のカンマ区切りリストを指定します。
| Key: | logging.NAME.target.retry |
| Type: | integer |
| Scope: | global |
| Key: | logging.NAME.target.type |
| Type: | string |
| Scope: | global |
その他設定¶
以下のサーバーオプションはInstancesのサーバー固有設定、MAAS 統合、OVN統合、バックアップ、ストレージを設定します:
| Key: | authorization.scriptlet |
| Type: | string |
| Scope: | global |
スクリプトレットベースの認可を使用する際に、このオプションにスクリプトレットを保管します。
| Key: | backups.compression_algorithm |
| Type: | string |
| Default: |
|
| Scope: | global |
設定できる値はbzip2、gzip、lz4、lzma、xz、zstd、noneです。
| Key: | instances.lxcfs.per_instance |
| Type: | bool |
| Default: |
|
| Scope: | global |
一般的な/procと/sys配下のファイルへのオーバーレイを提供するのにLXCFSが使用され、コンテナに適用されるリソース制限を反映します。
LXCFSは通常はホスト上の単一のファイルシステムを経由して操作し、それがすべてのコンテナで共有されます。 これは非常に効率が良いですが、LXCFSがクラッシュするとすべてのコンテナが壊れてしまうという欠点があります。
このオプションにより、代わりにコンテナごとにLXCFSのインスタンスを動かすことができます。 この結果、より多くのシステムリソースを使いますが、クラッシュの影響範囲を狭められます。
| Key: | instances.nic.host_name |
| Type: | string |
| Default: |
|
| Scope: | global |
設定できる値はrandomとmacです。
randomと設定すると、ランダムなホストのインタフェース名をホスト名として使用します。
macと設定すると、inc<mac_address> （先頭の2桁を除いたMAC without leading two digits）の形式でホスト名を生成します。
| Key: | instances.placement.scriptlet |
| Type: | string |
| Scope: | global |
カスタムのインスタンス配置ロジックを使用する際、このオプションでスクリプトレットを保管します。 詳細はインスタンス配置スクリプトレットを参照してください。
| Key: | instances.tpm.platform_cert |
| Type: | string |
| Scope: | global |
新しく作られるTPMデバイスのEndorsement Keyとプラットフォーム証明書を署名するのに使うPEM形式のプラットフォームCA証明書。
instances.tpm.platform_keyとともに設定する必要があります。
| Key: | instances.tpm.platform_key |
| Type: | string |
| Scope: | global |
instances.tpm.platform_certに対応するPEM形式の秘密鍵。
新しく作られるTPMデバイスのEndorsement Keyとプラットフォーム証明書を署名するのに使います。
| Key: | network.ovn.ca_cert |
| Type: | string |
| Default: | 存在する場合 |
| Scope: | global |
| Key: | network.ovn.client_cert |
| Type: | string |
| Default: | 存在する場合 |
| Scope: | global |
| Key: | network.ovn.client_key |
| Type: | string |
| Default: | 存在する場合 |
| Scope: | global |
| Key: | network.ovn.integration_bridge |
| Type: | string |
| Default: |
|
| Scope: | global |
| Key: | network.ovn.northbound_connection |
| Type: | string |
| Default: |
|
| Scope: | global |
| Key: | network.ovs.connection |
| Type: | string |
| Default: |
|
| Scope: | global |
| Key: | storage.backups_volume |
| Type: | string |
| Scope: | local |
POOL/VOLUMEの形式でボリュームを指定します。
| Key: | storage.images_volume |
| Type: | string |
| Scope: | local |
POOL/VOLUMEの形式でボリュームを指定します。
| Key: | storage.linstor.client_cert |
| Type: | string |
| Scope: | global |
| Key: | storage.linstor.client_key |
| Type: | string |
| Scope: | global |
| Key: | storage.linstor.controller_connection |
| Type: | string |
| Scope: | global |
| Key: | storage.linstor.satellite.name |
| Type: | string |
| Scope: | global |
このオプションをローカルのLINSTORサテライトノードの名前に設定します。Incusのサーバー名とは異なる必要があります。
ユーザーオプション¶
追加のユーザー定義キーはuser.ネームスペース内で利用可能です。
ユーザー定義のキーは常にstring型でglobalスコープになります。
user.ui.で始まるキーはウェブUI設定オプションで使用され、認証していないユーザーにも見えることに注意してください。