genvid-bastion

Manage the local bastion cluster.

The script installs the supervisor services under GENVID_SERVICES_DATADIR (defaults to ~/.genvid) and sets up a bastion-api service on top of them, using the installation directory.

usage: genvid-bastion [-h] [--loglevel {DEBUG,INFO,WARNING,ERROR}] [--logformat LOGFORMAT]
                      {backup,clean,delete-default-terraform-providers,env,get-default-terraform-providers,install,load-bastion-config,log,monitor,open,reinstall,render-template,restart,set-default-terraform-providers,setup,setup-vault-engines,start,status,stop,uninstall,update-global-tfvars}
                      ...

Positional Arguments

command 使用するコマンド: backup, clean, delete-default-terraform-providers, env, get-default-terraform-providers, install, load-bastion-config, log, monitor, open, reinstall, render-template, restart, set-default-terraform-providers, setup, setup-vault-engines, start, status, stop, uninstall, update-global-tfvars

Named Arguments

--loglevel

使用するコマンド: DEBUG, INFO, WARNING, ERROR

スクリプトのログレベルを設定する

--logformat スクリプトのログ形式を設定する

Sub-commands:

backup

サービスデータとファイルのスナップショットを作成。 Consul (デフォルト設定の Vault データベースを含む)、Vault のキー、Terraform workdir のみ保存されます。Nomad のデータは保存されません。処理中は、レポジトリの更新を含め、Terraform が実行されていないことを確認してください。

インストールの実行中に、データを回復できます。

バージョン 1.14.0 で追加.

genvid-bastion backup [-h] [--strategies {version,consul,vault,terraform} [{version,consul,vault,terraform} ...]]
                      zipfile

Positional Arguments

zipfile バックアップを保存するアーカイブ。

Named Arguments

--strategies, -s
 

使用するコマンド: version, consul, vault, terraform

バックアップに適用するストラテジー。

clean

廃止。 uninstall --clean のエイリアス。

genvid-bastion clean [-h]

delete-default-terraform-providers

プロバイダのグローバルなデフォルト構成を削除する。

genvid-bastion delete-default-terraform-providers [-h]

env

スクリプトで使用される環境変数を出力する。

genvid-bastion env [-h]

get-default-terraform-providers

プロバイダのグローバルなデフォルト構成を JSON で問い合わせる。

genvid-bastion get-default-terraform-providers [-h]

install

サービスをインストールして設定する。

バージョン 1.13.0 で変更: --update-global-tfvars は、toolbox 変数を更新しなくなりました。代わりに、存在する場合のみ toolbox_location 変数を更新します。

バージョン 1.14.0 で変更: 有効な bastion ID が設定されているかをコマンドがチェックし、--bastionid パラメータで設定できるようになりました。

バージョン 1.15.0 で変更: --reconfigure パラメータを追加。

バージョン 1.20.0 で変更: --node-id--node-name パラメータを追加。

バージョン 1.34.0 で変更: --resetconfig parameterを追加しました。

genvid-bastion install [-h] [-b BASTIONID] [-r] [-m] [-l] [-u] [--backup BACKUP] [--reconfigure] [--node-id NODE_ID]
                       [--node-name NODE_NAME] [-e SERVICES [SERVICES ...]] [--resetconfig]

Named Arguments

-b, --bastionid
 bastion の識別子。小文字、数字、ハイフンで、3 ~ 32 文字の長さである必要があります。
-r, --force-rename
 

ID の異なる bastion が存在している場合に、強制的に新しい bastion ID を取得します。

デフォルト: False

-m, --checkmodules
 

モジュールをインストールして更新する

デフォルト: False

-l, --loadconfig
 

bastion のデフォルト設定をロード

デフォルト: False

-u, --update-global-tfvars
 

グローバル terraform 変数の値を更新する。

デフォルト: False

--backup 修復用にファイルをバックアップします。このオプションを使用すると、すべてのサービスが停止し、consul データディレクトリを backup にリネーム後、変更が適用されます。
--reconfigure

サービスの構成をリセットする。サービスでインストールされた構成ファイルのみリセットされます。存在する他のファイルは変更されません。

デフォルト: False

--node-id Consul に node ID を強制的に使用します。デフォルトでは、ホスト名に基づいて Consul で設定されます。
--node-name Consul に node 名を強制的に使用します。デフォルトでは、マシンのホスト名として Consul で設定されます。
-e, --excluded-services
 サービスのインストールを除外する。
--resetconfig

新しい設定を読み込む前に、設定を消去する。–loadconfigが存在しない場合は効果がありません。

デフォルト: False

load-bastion-config

bastion のデフォルト設定をロードします。ジョブとログが含まれます。

バージョン 1.34.0 で変更: --reset パラメータを追加しました。

genvid-bastion load-bastion-config [-h] [--reset]

Named Arguments

--reset

新しい設定を読み込む前に、設定を消去してください。

デフォルト: False

log

タスクの指定ログを返す。

genvid-bastion log [-h] [-t] [-n LINES] [-f] [log]

Positional Arguments

log 取得するログ名。ローカルサービスのひとつ (consul、nomad、vault) 、または登録されたログのひとつの場合があります。

Named Arguments

-t, --tail

最後のラインのみ表示する。

デフォルト: False

-n, --lines

末尾までのライン数 (10)

デフォルト: 10

-f, --follow

ファイルの最後で、追加コンテンツを待機する。

デフォルト: False

monitor

Web ブラウザで監視アプリケーションを開く。

genvid-bastion monitor [-h]

open

Web ブラウザでリンクを開くか、利用可能なリンクを一覧表示する。

genvid-bastion open [-h] [link]

Positional Arguments

link リンク名。

reinstall

すべてのサービスを停止して、再インストールする。

バージョン 1.13.0 で変更: --update-global-tfvars は、toolbox 変数を更新しなくなりました。代わりに、存在する場合のみ toolbox_location 変数を更新します。

バージョン 1.14.0 で変更: bastion ID の設定、変更を行う --backup パラメータを追加。bastion の以前のバージョンから修復を行なう --bastionid パラメータを追加。

バージョン 1.15.0 で変更: --reconfigure パラメータを追加。

バージョン 1.20.0 で変更: --node-id--node-name パラメータを追加。

バージョン 1.34.0 で変更: --resetconfig parameterを追加しました。

genvid-bastion reinstall [-h] [-c] [-f] [-d] [-b BASTIONID] [-r] [-m] [-l] [-u] [--backup BACKUP] [--reconfigure]
                         [--node-id NODE_ID] [--node-name NODE_NAME] [-e SERVICES [SERVICES ...]] [--resetconfig]

Named Arguments

-c, --clean

インストールを消去する。

デフォルト: False

-f, --force

強制的にインストールを取り消す。

デフォルト: False

-d, --destroy

既存クラスタを破棄する。

デフォルト: False

-b, --bastionid
 bastion の識別子。小文字、数字、ハイフンで、3 ~ 32 文字の長さである必要があります。
-r, --force-rename
 

ID の異なる bastion が存在している場合に、強制的に新しい bastion ID を取得します。

デフォルト: False

-m, --checkmodules
 

モジュールをインストールして更新する

デフォルト: False

-l, --loadconfig
 

bastion のデフォルト設定をロード

デフォルト: False

-u, --update-global-tfvars
 

グローバル terraform 変数の値を更新する。

デフォルト: False

--backup 修復用にファイルをバックアップします。このオプションを使用すると、すべてのサービスが停止し、consul データディレクトリを backup にリネーム後、変更が適用されます。
--reconfigure

サービスの構成をリセットする。サービスでインストールされた構成ファイルのみリセットされます。存在する他のファイルは変更されません。

デフォルト: False

--node-id Consul に node ID を強制的に使用します。デフォルトでは、ホスト名に基づいて Consul で設定されます。
--node-name Consul に node 名を強制的に使用します。デフォルトでは、マシンのホスト名として Consul で設定されます。
-e, --excluded-services
 サービスのインストールを除外する。
--resetconfig

新しい設定を読み込む前に、設定を消去する。–loadconfigが存在しない場合は効果がありません。

デフォルト: False

render-template

テンプレートをbastion-api上のソースでレンダリングする。

バージョン 1.33.0 で追加.

genvid-bastion render-template [-h] [-t TEMPLATE_PATH | -c CONTENT] [-s SOURCES] [-e [ENVIRONMENT [ENVIRONMENT ...]]]
                               [-q]

Named Arguments

-t, --template-path
 

レンダリングするテンプレートのソース内の相対パス。

デフォルト: 「」

-c, --content

アップロードしてテンプレートとしてレンダリングするためのファイル。

デフォルト: 「」

-s, --sources

テンプレートのソースを含む、cluster-apiからアクセス可能なURL。

デフォルト: 「」

-e, --environment
 テンプレートのレンダリング環境に追加するNAME=VALUEの形の環境変数。
-q, --quiet

レンダリングしたテンプレートをプリントアウトしないでください。

デフォルト: False

restart

サービスを再開する。

バージョン 1.13.0 で変更: --jobs-only オプションは、ジョブのみを再開します。

genvid-bastion restart [-h] [-j] [jobs [jobs ...]]

Positional Arguments

jobs

Named Arguments

-j, --jobs-only
 

ジョブを停止するだけです。

デフォルト: False

set-default-terraform-providers

グローバルなデフォルトプロバイダ構成を JSON 形式のファイルの中身でカスタマイズする。

genvid-bastion set-default-terraform-providers [-h] providers_file

Positional Arguments

providers_file 新しいプロバイダ構成を含む、JSON 形式のファイル。

setup

廃止。 install --checkmodules のエイリアス。

genvid-bastion setup [-h]

setup-vault-engines

vault のシークレットエンジンを設定し、ロールを読み込みます。ロールは環境変数 GENVID_VAULT_TOKEN_ROLES_FOLDER で指定されたフォルダに定義されます。json ファイルは、ロールタイプに対応したサブフォルダ名で、サブフォルダ内 (『token』 、 『pki』) に配置されます。フォルダのルートにある json ファイルは、後方互換性のために 『token』 ロールタイプとして扱われます。Json ファイルにロール設定が含まれています。ロールの名前は、 json ファイルの 『name』 設定から取得します。設定が存在しない場合は、ファイル名が使用されます。

genvid-bastion setup-vault-engines [-h] [-f VAULT_ROLES_FOLDER]

Named Arguments

-f, --vault-roles-folder
 ロール定義が含まれるフォルダ。デフォルトでは、環境変数 GENVID_VAULT_TOKEN_ROLES_FOLDER の値を使用します。

start

サービスを開始する。

バージョン 1.13.0 で変更: --jobs-only オプションは、ジョブのみを開始します。

genvid-bastion start [-h] [-j] [jobs [jobs ...]]

Positional Arguments

jobs

Named Arguments

-j, --jobs-only
 

ジョブを停止するだけです。

デフォルト: False

status

ステータスを取得する。

genvid-bastion status [-h]

stop

サービスを停止する。

バージョン 1.13.0 で変更: --jobs-only オプションは、ジョブのみを停止します。

genvid-bastion stop [-h] [-j] [jobs [jobs ...]]

Positional Arguments

jobs

Named Arguments

-j, --jobs-only
 

ジョブを停止するだけです。

デフォルト: False

uninstall

サービスを停止してアンインストールする。

genvid-bastion uninstall [-h] [-c] [-f] [-d]

Named Arguments

-c, --clean

インストールを消去する。

デフォルト: False

-f, --force

強制的にインストールを取り消す。

デフォルト: False

-d, --destroy

既存クラスタを破棄する。

デフォルト: False

update-global-tfvars

グローバル変数を現在の設定で更新する。

グローバル TFVars を現在の外部 IP と現在のツールボックスで更新する。

バージョン 1.13.0 で変更: toolbox 変数は、更新されなくなりました。存在する場合にのみ更新される toolbox_location 変数に置き換えられます。

genvid-bastion update-global-tfvars [-h]