genvid-sdk

Tool for manipulating the SDK.

usage: genvid-sdk [-h] [--loglevel {DEBUG,INFO,WARNING,ERROR}] [--logformat LOGFORMAT] [-c CLUSTER_ID]
                  {version,env,clean,clean-config,clean-images,clean-images-sdk,cluster-version,consul-template,docker-package,generate-ssl,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}
                  ...

Positional Arguments

command 使用するコマンド: version, env, clean, clean-config, clean-images, clean-images-sdk, cluster-version, consul-template, docker-package, generate-ssl, 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

Named Arguments

--loglevel

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

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

--logformat スクリプトのログ形式を設定する
-c, --cluster_id
 クラスタ ID。コマンドラインで設定されていない場合は、環境変数 GENVID_CLUSTER_ID があればそれを使用します。それ以外の場合、デフォルトは 『local』 です。

Sub-commands:

version

現在のバージョンを出力する

バージョン 1.31.0 で変更: 現在は genvid-bastion version と同様に動作し、SDK バージョンではなく genvid-toolbox バージョンを返します。以前の処理は、 genvid-sdk cluster-version で利用可能です。

genvid-sdk version [-h]

env

使用された環境変数を出力する。

genvid-sdk env [-h]

clean

サービスをアンインストールする。

genvid-sdk clean [-h]

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 The path in the bucket (default: 「/images/sdk-1.33.0.0」).
-u, --update-config
 現在のクラスタに設定を読み込む。

cluster-version

クラスタを管理する Cluster API のバージョンを表示。

バージョン 1.31.0 で追加.

genvid-sdk cluster-version [-h]

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 イメージ名

Named Arguments

-v, --version パッケージに付与するバージョン
-d, --destination
 アーカイブの書き込み先ディレクトリ (デフォルト: 「ROOTDIR/images」)。

generate-ssl

ssl 証明書を生成

バージョン 1.29.0 で追加.

genvid-sdk generate-ssl [-h] [-d DOMAIN] [-o OUTPUTDIR] [-r ROLE]

Named Arguments

-d, --domain 証明書の発行対象となるドメイン名。指定しなかった場合、または空白を指定した場合、証明書は localhost のみに適用されます。
-o, --outputdir
 結果を保存するフォルダ。指定しなかった場合は、現在のフォルダが使用されます。
-r, --role 証明書に使用するロール名 (「sslrole」).

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

指定した設定を現在の設定に追加する。

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

genvid-sdk load-config [-h] [--with-consul-template] [--job-template-dir JOB_TEMPLATE_DIR] [-n] source

Positional Arguments

source 読み込む Nomad テンプレート

Named Arguments

--with-consul-template
 テンプレートに使用する consul-template
--job-template-dir
 読み込む nomad ジョブが格納されたディレクトリ
-n, --dryrun 設定を読み込まず、出力を JSON として表示します。

load-config-sdk

SDK 設定を読み込む。

genvid-sdk load-config-sdk [-h]

log

ログを表示する。

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

Positional Arguments

log ログ名。設定されていない場合は、すべてのログをリスト化します。

Named Arguments

-t, --tail 最後のラインのみ表示する。
-n, --lines 末尾までのライン数 (10)
-f, --follow ファイルの最後で、追加コンテンツを待機する。

monitor

このクラスタの cluster-ui を起動する。

genvid-sdk monitor [-h]

open

指定したサービスの GUI を起動する。

genvid-sdk open [-h] [link]

Positional Arguments

link リンク名。

package

<NAME>_<VERSION>_<CHECKSUM>.zip の形式のパッケージを作成

バージョン 1.22.0 で追加.

genvid-sdk package [-h] [-n NAME] [-v VERSION] [-d DESTINATION] [--flatten] directory_or_file

Positional Arguments

directory_or_file
 パッケージするファイル、またはディレクトリへのパス

Named Arguments

-n, --name パッケージ名
-v, --version パッケージに付与するバージョン。
-d, --destination
 アーカイブを探しにいくディレクトリ (デフォルト: 「ROOTDIR/images」)。
--flatten 設定されている場合、パッケージはフラット化されます。設定されていない場合は階層化となります。

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 The path in the bucket (default: 「/images/sdk-1.33.0.0」).

setup-nomad

nomad サーバーの nomad-server トークンをセットアップ。

バージョン 1.15.0 で追加.

genvid-sdk setup-nomad [-h]

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 クラスタマシンへの接続に使用するユーザー名

setup-vault

vault サービスをセットアップ。

バージョン 1.15.0 で追加.

genvid-sdk setup-vault [-h]

show-config

SDK 設定を表示する。

genvid-sdk show-config [-h]

show-config-sdk

SDK 設定を表示する。

genvid-sdk show-config-sdk [-h]

show-jobs

ジョブを表示する。

genvid-sdk show-jobs [-h]

start

ジョブを開始する。

genvid-sdk start [-h] [jobs [jobs ...]]

Positional Arguments

jobs 開始するジョブ。

stop

ジョブを停止する。

genvid-sdk stop [-h] [jobs [jobs ...]]

Positional Arguments

jobs 開始するジョブ。

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

指定したイメージのプレフィックスをアップロードする。

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

genvid-sdk upload-images [-h] [-b BUCKET] [-p PATH] [-u] [-d BASEDIR] [--cloud-provider {aws,azure}] [--region REGION]
                         [prefixes [prefixes ...]]

Positional Arguments

prefixes アップロードするイメージのプレフィックス。

Named Arguments

-b, --bucket 使用するバケット名。デフォルトは、AWS アカウント、bastion、クラスタ ID の組み合わせ。
-p, --path バケットのパス (デフォルトは 「/images/custom」)。
-u, --update-config
 現在のクラスタに設定を読み込む。
-d, --basedir アップロードするイメージを探す basedir (デフォルト: 「ROOTDIR/images」)。
--cloud-provider
 

可能な選択肢: aws, azure

使用するクラウドプロバイダ。デフォルト: 「aws」

--region 画像がアップロードされるリージョン。

upload-images-sdk

SDK イメージをアップロードする。

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

genvid-sdk upload-images-sdk [-h] [-b BUCKET] [-p PATH] [-u] [--cloud-provider {aws,azure}] [--region REGION]

Named Arguments

-b, --bucket 使用するバケット名。デフォルトは、AWS アカウント、bastion、クラスタ ID の組み合わせ。
-p, --path The path in the bucket (default: 「/images/sdk-1.33.0.0」).
-u, --update-config
 現在のクラスタに設定を読み込む。
--cloud-provider
 

可能な選択肢: aws, azure

使用するクラウドプロバイダ。デフォルト: 「aws」

--region 画像がアップロードされるリージョン。