genvid-sdk¶
In This Section
- Positional Arguments
- Named Arguments
- Sub-commands:
- clean
- clean-config
- clean-images
- clean-images-sdk
- consul-template
- docker-package
- list-nodes
- load-config
- load-config-sdk
- log
- monitor
- open
- open-link
- package
- set-taskgroup-count
- setup
- setup-nomad
- setup-remote
- setup-vault
- show-config
- show-config-sdk
- show-jobs
- start
- stop
- update-images
- upload-images
- upload-images-sdk
- version
Tool for manipulating the SDK.
usage: genvid-sdk [-h] [--loglevel {DEBUG,INFO,WARNING,ERROR}] [--logformat LOGFORMAT] [-c CLUSTER_ID]
{clean,clean-config,clean-images,clean-images-sdk,consul-template,docker-package,list-nodes,load-config,load-config-sdk,log,monitor,open,open-link,package,set-taskgroup-count,setup,setup-nomad,setup-remote,setup-vault,show-config,show-config-sdk,show-jobs,start,stop,update-images,upload-images,upload-images-sdk,version}
...
Positional Arguments¶
command | 使用するコマンド: clean, clean-config, clean-images, clean-images-sdk, consul-template, docker-package, list-nodes, load-config, load-config-sdk, log, monitor, open, open-link, package, set-taskgroup-count, setup, setup-nomad, setup-remote, setup-vault, show-config, show-config-sdk, show-jobs, start, stop, update-images, upload-images, upload-images-sdk, version |
Named Arguments¶
--loglevel | 使用するコマンド: DEBUG, INFO, WARNING, ERROR スクリプトのログレベルを設定する |
--logformat | スクリプトのログ形式を設定する |
-c, --cluster_id | |
クラスタ ID。コマンドラインで設定されていない場合は、環境変数 GENVID_CLUSTER_ID があればそれを使用します。それ以外の場合、デフォルトは 『local』 です。 |
Sub-commands:¶
clean-config¶
全体の設定を消去する。
genvid-sdk clean-config [-h] [source]
Positional Arguments¶
source | 削除する設定ファイル。 |
clean-images¶
アップロードしたすべての画像を削除する。
genvid-sdk clean-images [-h] [-b BUCKET] [-p PATH] [-u]
Named Arguments¶
-b, --bucket | 使用するバケット名。デフォルトは、AWS アカウント、bastion、クラスタ ID の組み合わせ。 |
-p, --path | バケットのパス (デフォルトは 「/images/custom」)。 |
-u, --update-config | |
現在のクラスタに設定を読み込む。 |
clean-images-sdk¶
アップロードした SDK イメージを消去する。
バージョン 1.20.0 で追加.
genvid-sdk clean-images-sdk [-h] [-b BUCKET] [-p PATH] [-u]
Named Arguments¶
-b, --bucket | 使用するバケット名。デフォルトは、AWS アカウント、bastion、クラスタ ID の組み合わせ。 |
-p, --path | バケットのパス (デフォルトは 「/images/sdk-1.25.0.0」)。 |
-u, --update-config | |
現在のクラスタに設定を読み込む。 |
consul-template¶
Consul テンプレートを適用する。
genvid-sdk consul-template [-h] template
Positional Arguments¶
template | 読み込むテンプレート。 |
docker-package¶
ImageName_Version_Id.zip 形式の docker パッケージ
バージョン 1.22.0 で追加.
genvid-sdk docker-package [-h] [-v VERSION] [-d DESTINATION] docker_image
Positional Arguments¶
docker_image | パッケージする docker イメージ名 |
list-nodes¶
登録されたノードリストを表示。
バージョン 1.18.0 で追加.
genvid-sdk list-nodes [-h] [-t TEMPLATE] [-s SORTEDBY]
Named Arguments¶
-t, --template | ノード表示用テンプレート。デフォルト: 「{Name:15} ({NodeClass:^10}): {Status}」 |
-s, --sortedby | ノードのソート用プロパティ。 |
load-config¶
指定した設定を現在の設定に追加する。
genvid-sdk load-config [-h] [--with-consul-template] [--job-template-dir JOB_TEMPLATE_DIR] source
Positional Arguments¶
source | 読み込む Nomad テンプレート。 |
Named Arguments¶
--with-consul-template | |
テンプレートに使用する consul-template。 | |
--job-template-dir | |
読み込む nomad ジョブが格納されたディレクトリ |
log¶
ログを表示する。
genvid-sdk log [-h] [-t] [-n LINES] [-f] task
Positional Arguments¶
task | ログ名。 |
Named Arguments¶
-t, --tail | 最後のラインのみ表示する。 |
-n, --lines | 末尾までのライン数 (10) |
-f, --follow | ファイルの最後で、追加コンテンツを待機する。 |
package¶
<NAME>_<VERSION>_<CHECKSUM>.zip の形式のパッケージを作成
バージョン 1.22.0 で追加.
genvid-sdk package [-h] [-n NAME] [-v VERSION] [-d DESTINATION] directory_or_file
Positional Arguments¶
directory_or_file | |
パッケージするファイル、またはディレクトリへのパス |
set-taskgroup-count¶
タスクグループ数を設定します。
バージョン 1.23.0 で追加.
genvid-sdk set-taskgroup-count [-h] [-j JOB] [-s STEP] [-i INTERVAL] taskgroup count
Positional Arguments¶
taskgroup | 変更するタスクグループ名。 |
count | 設定するターゲット番号。 |
Named Arguments¶
-j, --job | タスクグループと異なる場合のジョブ名。 |
-s, --step | インターバル間のインクリメントまたはデクリメントの大きさを指定します。0 の場合は直接値を設定します。 |
-i, --interval | 各インクリメント間の秒単位の間隔 (デフォルト: 1.00 秒)。 |
setup¶
サービスを設定する。
バージョン 1.20.0 で変更: SDK イメージのデフォルトキーを修正。
genvid-sdk setup [-h] [-b BUCKET] [-p PATH]
Named Arguments¶
-b, --bucket | 使用するバケット名。デフォルトは、AWS アカウント、bastion、クラスタ ID の組み合わせ。 |
-p, --path | バケットのパス (デフォルトは 「/images/sdk-1.25.0.0」)。 |
setup-remote¶
BETA: リモートクラスタを登録
genvid-sdk setup-remote [-h] cluster server-ip ssh-private-key-pem-file ssh-user
Positional Arguments¶
cluster | クラスタ名 |
server-ip | Cluster Consul サーバー IP |
ssh-private-key-pem-file | |
クラスタマシンへの接続に使用する ssh キーが含まれるファイル | |
ssh-user | クラスタマシンへの接続に使用するユーザー名 |
update-images¶
指定バケットからイメージを更新。
バージョン 1.20.0 で追加.
genvid-sdk update-images [-h] [-b BUCKET] [-p PATH] [-s] [-n] [-j JSFILE] [-q]
Named Arguments¶
-b, --bucket | 使用するバケット名。デフォルトは、AWS アカウント、bastion、クラスタ ID の組み合わせ。 |
-p, --path | バケットのパス (デフォルトは 「/images/custom」)。 |
-s, --sdk | SDK のデフォルト設定を使用。 |
-n, --dryrun | 設定を出力します。更新は行いません。 |
-j, --jsfile | バケットから取得せずに、この設定を使用します。 |
-q, --quiet | 標準のアウトプットでは、設定を出力しない。 |
upload-images¶
指定したイメージのプレフィックスをアップロードする。
genvid-sdk upload-images [-h] [-b BUCKET] [-p PATH] [-u] [-d BASEDIR] [--cloud-provider {aws,azure}]
[prefixes [prefixes ...]]
Positional Arguments¶
prefixes | アップロードするイメージのプレフィックス。 |
upload-images-sdk¶
SDK イメージをアップロードする。
genvid-sdk upload-images-sdk [-h] [-b BUCKET] [-p PATH] [-u] [--cloud-provider {aws,azure}]
Named Arguments¶
-b, --bucket | 使用するバケット名。デフォルトは、AWS アカウント、bastion、クラスタ ID の組み合わせ。 |
-p, --path | バケットのパス (デフォルトは 「/images/sdk-1.25.0.0」)。 |
-u, --update-config | |
現在のクラスタに設定を読み込む。 | |
--cloud-provider | |
可能な選択肢: aws, azure 使用するクラウドプロバイダ。デフォルト: 「aws」 |