genvid.toolbox.ConsulTemplateTool¶
-
class
genvid.toolbox.
ConsulTemplateTool
(**kwargs)¶ ベースクラス:
genvid.toolbox.vault.VaultTool
ツールボックスと統合するための
ConsulTemplate
のラッパー。このクラスで定義された API は、基礎となる
consul-template
の呼び出しをカスタマイズするために完全な柔軟性を持たせるとともに、Consul
とVault
とをスムーズに統合するためのパラメータを提供します。-
バージョン 1.22.0 で変更:
API を書き換えて、幅広く使用できるように安定性を強化。
ConsulTemplate
を使用しています。
-
consul_template
¶ ConsulTemplate
インスタンスにアクセス。ConsulTemplate
インスタンスは、最初に実行された際に遅れてインスタンス化されます。例外: ExecutableNotInPathError – consul-template
の実行ファイルを見つからなかった場合。注釈
このメソッドは、最初の呼び出し時のみ例外が発生することがあります。それ以降の呼び出しでは、例外は発生しません。
-
consul_template_once
(*, use_consul: bool = False, use_vault: bool = False, env: typing.Union[typing.Mapping[str, str], NoneType] = None, **kwargs) → genvid.toolbox.consul_template.ConsulTemplateOutput¶ 非デーモンモードで
consul-template
を動作させます。パラメータ: - use_consul – Consul を呼び出せるように
consul-template
をカスタマイズします。 .. 重要:: 自動的にconsul_addr
を設定することで可能になります。 - use_vault – Vault を呼び出せるように
consul-template
をカスタマイズします。 .. 重要:: 自動的にvault-token
とvault-renew-token
を設定することで可能になります。 - env – 指定された環境でサブプロセスを実行します。テンプレートが環境変数に大きく依存している場合に特に便利です。
- kwargs –
consul-template
に直接渡されるオプション。 .. 重要:: ユーザーが指定したオプションは、consul
とvault
が正しく動作するように、このツールによって設定された値よりも常に優先されます。 .. seealso:: サポートされるオプションについてはConsulTemplate
を参照してください。
Raises: ConsulTemplate.once()
で定義される例外。Vault 関連の例外の中には、use_vault
がTrue
に設定されていてもスローされるものがあります。戻り値: - use_consul – Consul を呼び出せるように
-
load_config_template
(template: typing.Union[pathlib.Path, str], env: typing.Union[typing.Mapping[str, str], NoneType] = None) → typing.Any¶ 設定テンプレートファイルをロードする。
consul-template
を使用して設定テンプレートファイルを処理し、辞書として返します。バージョン 1.29.0 で追加.
-
class
consul_template.
ConsulTemplateTool
¶