Python Toolbox API

例外

genvid.toolbox.BucketRegionNotMatching	既存のバケットリージョンが指定されたものと一致しない場合に発生します。
genvid.toolbox.ConsulTemplateError	consul-template エラーの基本的なエラータイプです。
genvid.toolbox.ConsulTemplateExecutableNotFound	consul-template の実行ファイルが見つからないときに発生します。
genvid.toolbox.ConsulTemplateExecutionFailed	consul-template を実行して 0 以外の終了コードが得られた場合に発生します。
genvid.toolbox.ConsulTemplateInvalidUseOfFlag	フラグパラメータがトリビア以外の値で使用されたことを示します。
genvid.toolbox.ConsulTemplateUseOfDisabledOption	ConsulTemplate で無効化されたオプションが使用されたことを示します。
genvid.toolbox.ConsulTemplateUseOfUnknownOption	ConsulTemplate で未知のオプションが使用されたことを示します。
genvid.toolbox.ExecutableNotInPathError	パスにファイルが見つからない場合に発生します。
genvid.toolbox.HttpError	Cluster API のエラーです。
genvid.toolbox.HttpErrorNotFound	not found HTTP エラー
genvid.toolbox.HttpErrorBadGateway	bad gateway HTTP エラー
genvid.toolbox.NoSuchBucketError	バケットが存在しない場合の例外処理をカスタマイズ。
genvid.toolbox.ServiceIsNotRunningError	サービスが実行されていない時に発生します。
genvid.toolbox.TerraformCommandError	Terraform コマンドのエラー

基本ツール

genvid.toolbox.AWSTool	AWS リソースにアクセスして操作するためのユーティリティ。
genvid.toolbox.BaseHttpApiTool	HTTP API のベース class。
genvid.toolbox.BaseTool	すべてのツールのベース class。
genvid.toolbox.BastionAPI	Bastion API のクライアント。
genvid.toolbox.BastionTool	ローカル Bastion の設定、管理用ツール。
genvid.toolbox.ClusterAPI	クラスタとの通信を処理します。
genvid.toolbox.Clusters	クラスタ管理用のベース class。
genvid.toolbox.ConsulTemplateTool	ツールボックスと統合するための ConsulTemplate のラッパー。
genvid.toolbox.ConsulTool	この class で、さまざまな Consul サービスにアクセスできます。
genvid.toolbox.DockerTool	Docker イメージアーカイブの操作を処理します。
genvid.toolbox.JobsAPI	ジョブ API。
genvid.toolbox.LinksAPI	リンク API。
genvid.toolbox.LogsAPI	ログ API。
genvid.toolbox.NetworkTool	ネットワークユーティリティのプラットフォーム抽象化。
genvid.toolbox.NomadTool	Nomad のジョブを処理するための class。
genvid.toolbox.SDK	SDK を設定するための一般的なコマンドです。
genvid.toolbox.VaultTool	Vault の処理を行うための class。

サービス: 基本ツール

genvid.toolbox.ConsulService	Consul サービスを設定するためのベース class。
genvid.toolbox.NomadService	Nomad サービスの基本設定。
genvid.toolbox.ServiceInstaller	すべてのサービスをインストールするためのベース class。
genvid.toolbox.ServiceTool	すべてのサービスのベース class。
genvid.toolbox.VaultService	Vault サービスの基本設定。

サービス: ローカルツール

genvid.toolbox.LocalService	この class は、バックグラウンドプロセスとしてローカルで実行するサービスをラップします。
genvid.toolbox.LocalServiceInstaller	ローカルサービスのインストーラ。

サービス: Linux ツール

genvid.toolbox.LinuxDockerService(**kwargs)	Linux サーバーの docker を設定するための ServiceTool 。
genvid.toolbox.LinuxConsulService(**kwargs)	Linux サーバーのサービスとして Consul を設定する。
genvid.toolbox.LinuxNomadService(**kwargs)	Linux サーバーのサービスとして Nomad を設定する。
genvid.toolbox.LinuxServiceInstaller(**kwargs)	Linux サーバーに監視サービスをインストールする。
genvid.toolbox.LinuxVaultService(**kwargs)	Linux サーバーのサービスとして Vault を設定する。
genvid.toolbox.SystemdTool(**kwargs)	systemd の Linux サーバー用基本 ServiceTool 。
genvid.toolbox.SystemdInstaller(**kwargs)	systemd の LinuxServiceInstaller 用基本 ServiceInstaller 。

サービス: インストールツール

genvid.toolbox.DefaultInstallationFolder()	インストールフォルダーを管理するための抽象クラスです。
genvid.toolbox.SDKInstallationFolder()	Genvid MILE SDK のインストールフォルダーを管理するクラスです。
genvid.toolbox.ToolboxInstallationFolder()	Genvid MILE SDK のインストールフォルダーを管理するクラスです。

その他のクラス

genvid.toolbox.AzureTool(bastionAPI)	Azure リソースにアクセスして操作するためのユーティリティ。
genvid.toolbox.AzureImageAPI(clusters)	Azure でゲームのソースイメージを操作するためのビジネスロジックを格納したクラスです。
genvid.toolbox.AzureStorageAccount(bastionAPI)	Azure ストレージアカウントを作成して操作するためのユーティリティ。
genvid.toolbox.Backup()	バックアップアーカイブを作成し、そこからデータを復元するための API 。
genvid.toolbox.CertificateGenerator(vault_tool)	Vault pki エンジンを使った ssl 証明書を管理するためのビジネスロジックを格納したクラスです。
genvid.toolbox.ConfigurationLoader(tool[, ...])	本クラスは、テンプレートで記述されたコンフィギュレーションをロードまたはアップデートするためのメソッドを提供します。
genvid.toolbox.ConsulBackup()	Consul の状態をバックアップ、復元するためのロジック。
genvid.toolbox.ConsulTemplate([executable])	consul-template の薄いラッパー API。
genvid.toolbox.ConsulTemplateOutput([logs, ...])	consul-template の実行に成功したときに返されるオブジェクト。
genvid.toolbox.FileStats(path, size, ctime, ...)	ファイルに関する基本的な情報を含む構造体。
genvid.toolbox.FileSyncFolder(source, **kwargs)
genvid.toolbox.Manifest([stats])
genvid.toolbox.PackageArchiver()	この class は Nomad の生成物として適したパッケージを作成するための機能をグルーピングします。
genvid.toolbox.Profile()	プロフィール操作用 API。
genvid.toolbox.S3SyncFolder(bucket, key, ...)
genvid.toolbox.SyncFolder(*[, cache, ...])
genvid.toolbox.TerraformBackup()	Terraform の状態をバックアップ、復元するためのロジック。
genvid.toolbox.TerraformProvider(name[, ...])	Terraform のプロバイダ設定を表すクラス。
genvid.toolbox.VaultBackup()	Vault の状態をバックアップ、復元するためのロジック。
genvid.toolbox.VersionBackup()	SDK バージョンをバックアップするためのロジック。

廃止ツール

警告

以下のモジュールは廃止されました。まだ古い Bastion API では動作しますが、今後、新しい Bastion API で動作しなくなる予定です。

genvid.toolbox.AllInOneTool	オールインワンのローカル開発環境を管理するためのメインツール。
genvid.toolbox.ClusterTool	この class で、クラスタの設定を行うことができます。
genvid.toolbox.ConfigTool	Genvid 設定を管理します。
genvid.toolbox.ConsulTemplateLegacyTool	Consul、Vault、またはシステムで設定された変数からファイルを生成する consul-template のラッパー。
genvid.toolbox.DockerPackage	バージョン 1.30.0 で非推奨.
genvid.toolbox.EventsTool	イベント設定を管理するためのツール。
genvid.toolbox.Package	バージョン 1.28.0 で非推奨.
genvid.toolbox.PackageFactory	バージョン 1.30.0 で非推奨.
genvid.toolbox.ProjectTool	プロジェクトファイルを管理するためのツール。
genvid.toolbox.RuntimeTool	さまざまな環境を管理するための共通ツール。
genvid.toolbox.TerraformTool	Terraform を使用してクラウド環境を管理するためのメインツール。

以下の classes は名称が変更されました。(エイリアスは、まだ提供されています):

• GenvidHTTPError は HttpError に変更。

• GenvidClusterTool は ClusterTool に変更。