genvid.toolbox.ProjectTool

警告

このモジュールは廃止されました。古いモデルでは、まだコードが交差しますが、最新の Bastion API では動作しない可能性があります。新しい genvid-sdk ツールを使用してください。

class genvid.toolbox.ProjectTool(**kwargs)

ベースクラス: genvid.toolbox.consul_template.ConsulTemplateTool

プロジェクトファイルを管理するためのツール。

バージョン 1.30.0 で変更: LOGS は ClusterTool に移動され、現在は廃止と考えられます。

get_project_file(dir_or_file)

プロジェクトファイルを返す。

引数は、ディレクトリ、またはプロジェクトファイルです。ディレクトリの場合、ディレクトリ内で、以下のファイルを順に検索します。: genvid.hcl 、 genvid.json 。

load_config_folder(source: typing.Union[pathlib.Path, str], *, env: typing.Union[typing.Mapping[str, str], NoneType] = None, job_template_dir: typing.Union[pathlib.Path, str, NoneType] = None, with_consul_template: bool = False) → dict

ソースから設定ファイル (ディレクトリの中のすべてのファイル、または特定のひとつのファイル) を読み込み、そのファイルを返す。

パラメータ:
  • source – 設定ファイル/フォルダのパス。
  • with_consul_template – true に設定されている場合にのみ、設定ファイル (ソースがディレクトリの場合) に対して consul-template を実行し使用する。
  • job_template_dir – nomad テンプレートが読み込まれるフォルダへのパス。指定されていない場合、ジョブは読み込まれません。
  • env – consul-template で使用するオプションの環境。ない場合、デフォルトの環境が使用されます。
戻り値:

set_config() で直接使用するとができる辞書としての設定。
:raises FileNotFoundError : job_template_dir が None ではなく、 : If the job_template_dir is not None and
有効なディレクトリではない場合。

バージョン 1.30.0 で追加.

load_nomad_job_template(name, job_folder: typing.Union[pathlib.Path, str])

特定のディレクトリから nomad ジョブのテンプレートを読み込みます。拡張子が .nomad.tmpl のファイルのみ読み込みます。

パラメータ:
  • name – ファイル名 (拡張子なし)
  • job_folder – ジョブが格納されたディレクトリのパス。

バージョン 1.30.0 で追加: job_folder として pathlib.Path のサポートを追加。

load_project(dir_or_file: str, **kwargs)

プロジェクトファイルを読み込む。

プロジェクトファイルは、JSON または HCL ファイル (genvid.json または genvid.hcl) で、consul-template を使用して解決されるテンプレート記述を含んでいる場合と含んでいない場合があります。

このメソッドは、プロジェクトファイルを含むディレクトリに PROJECTDIR を設定します。

パラメータ:
  • dir_or_file – 指定されたパスは、genvid.json または genvid.hcl プロジェクトファイルを見つけるために再帰的に検索されます。
  • kwargs – すべての追加キーワードパラメータは、 consul-template に直接渡されます。

注釈

ファイルに処理に Consul が必要でない場合、Consul サーバーの実行は必要ありません。結果は、拡張子が .json の場合は JSON ファイル、それ以外の場合は、 HCL ファイルとして解析されます。

    バージョン 1.21.0 で変更:

  • ConsulTemplateTool の新しいバージョンを使用するように調整。

update_config(config: dict, isLocal: bool)

指定の設定を更新する。

パラメータ:
  • config – 更新する設定。
  • isLocal – ローカルクラスタまたはリモートクラスタの場合
戻り値:

更新された設定。

バージョン 1.31.0 で追加.

update_project(project, _islocal=None)

このメソッドは、プロジェクトを最新の Genvid バージョンにアップデートする。

テンプレートエンジンの実行後に、アップデートが実行するため、情報が失われる可能性があります。

class project.ProjectTool

genvid.toolbox.ProjectTool の実装