CLI設定ファイル¶
Incusクライアントは環境データを保管し振る舞いを調整するために設定ファイルを使います。このドキュメントではファイルの構造とオプションを説明します。
注釈
設定ファイル手で編集するとCLIが不整合な状態になってしまうかもしれないので、incus remoteとincus aliasコマンド経由でのみ編集するのが良いです。
設定ファイル¶
デフォルトでは、Incus CLIは$HOME/.config/incus/config.ymlを使いますが、INCUS_CONF環境変数で指定される任意のファイルを使うこともできます。
ファイルやパスが存在しない場合は、以下のデフォルトを使います：
default-remote: local
remotes:
images:
protocol: simplestreams
public: true
addr: https://images.linuxcontainers.org
local:
protocol: incus
public: false
addr: unix://
aliases: {}
defaults:
list_format: ""
console_type: ""
console_spice_command: ""
no_color: false
remotes¶
Incusのリモートの情報はincus remoteコマンドで管理され、remotesセクションに保管されます。remotesは以下の設定キーを持つことができます。
addr¶
リモートサーバーのアドレス。IP、FQDN、URLを受け付けます。addr1,addr2,...のようにカンマで区切って複数のアドレスを設定できます。
last_working_address¶
リモートが複数のアドレスを持つ場合に、リモートの最後に動いていたアドレスを登録するためにCLIで使われます。
auth_type¶
サーバーAPIに認証するのにクライアントが使う方法。tlsとoidcを受け付けます。
keepalive¶
keepalive機能が接続を開いたままにしておくタイムアウトの秒数。
project¶
リモートを使うときにCLIで使うデフォルトプロジェクト。incus project switchコマンドで定義されます。--projectフラグとINCUS_PROJECT環境変数で上書きされます。
protocol¶
リモートと通信するのにCLIが使うプロトコル。リモートをIncusあるいはイメージサーバーのどちらとして使うかを決めます。以下の選択肢を受け付けます：
incus: ネットワーク超しにアクセスできるプライベートIncusサーバーoci: アプリケーションコンテナイメージを提供するOpen Container Initiative (OCI)サーバーpublic: イメージのみを提供するネットワーク超しにアクセスするIncusサーバーsimplestream: イメージを提供するSimple Streamサーバー
credentials_helper¶
OCIサービス認証を処理するヘルパーコマンドを定義します。
public¶
リモートがイメージ専用のサーバー（public）かどうかを定義します。
default_remotes¶
コマンドを実行するのにCLIで使うデフォルトのIncusのリモートを定義します。incus remote switchコマンドで定義されます。この設定はINCUS_REMOTE環境変数あるいは<remote>:接頭辞で上書きされます。
aliases¶
incus aliasコマンドで管理されるエイリアスを保管します。各エイリアスはエイリアス名とエイリアスのコマンド（引用符で囲んだ）で構成するキー／値のペアです。
defaults¶
特定のCLIコマンドでdefaultのCLIの振る舞いを決定します。
list_format¶
一覧がどのように出力されるかを決定します。--format（-f）フラグと等価です。csv、json、table、yaml、compact、markdownを受け付けます。
console_type¶
incus consoleコマンドで使うデフォルトのコンソールタイプを決定します。指定できるオプションは以下のとおりです：
console: text based consolevga: graphic UI console
console_spice_command¶
incus consoleで使うVGAコンソールを提供するための代替のSPICEコマンドを決定します。
no_color¶
CLIのカラー表示を無効化します。