環境変数

Genvid MILE SDK は、その設定に多くの環境変数を使用します。主要な変数を以下に定義します。

AZURE_RESOURCE_GROUP

Azure で使用するリソースグループの名前。

AZURE_STORAGE_ACCOUNT

使用する Azure ストレージアカウントの名前を含みます。設定しない場合は、ストレージアカウントが自動的に作成されます。デフォルト： bastion_id-First_8_characters_of_tenantID

BINDIR

ROOTDIR 以下のバイナリディレクトリ (bin) を指す変数。近い将来、廃止させる可能性があります。

CONSUL_HTTP_ADDR

Consul クライアントアドレス で、プロトコルを含みません。存在する場合、アプリケーションおよび SDK で優先的に使用されます。

CURDIR

スクリプトが現在使用しているディレクトリの場所と通信するために使う変数。これは近い将来、廃止される可能性があります。

DOCKER_MACHINE_NAME

Docker のホストマシン名。設定により docker-machine を使用して genvid.toolbox.DockerTool は Docker ホストに接続することができます。設定されていない場合は、デフォルトのクライアントが使用されます。

GENVID_AUDIO_DEVICE

使用するオーディオデバイスの名称。設定しない場合は、デフォルトのオーディオエンドポイントが使用されます。

GENVID_BASTION_BINDING_PORT

bastion-api サービスのバインディングに使用するポート。デフォルトは 8092。 GENVID_DEFAULT_IP と GENVID_BASTION_URL も参照してください。

バージョン 1.12.0 で追加.

GENVID_BASTION_CONFIG_FOLDER

インストール時に bastion に読み込まれた設定を含むフォルダ。

デフォルトは ROOTDIR/bastion-services/config です。

バージョン 1.31.0 で追加.

GENVID_BASTION_ID

Bastion API と Cluster API のすべてのレンダリングタスクに存在する、現在実行中の bastion の ID です。

参考

GENVID_CLUSTER_ID

重要

bastionで起動したタスクは、スプリアスの再起動を避けるため、bastion IDが変更されても自動的に再立ち上げされないようにしました。

バージョン 1.33.0 で追加.

GENVID_BASTION_INIT_FOLDER

bastion init 設定ファイルの格納フォルダです。詳細については setup_jobs() を参照してください。

バージョン 1.29.0 で追加.

GENVID_BASTION_JOB_TEMPLATE_FOLDER

インストール時に bastion に読み込まれたジョブテンプレート定義を含むフォルダ。

デフォルトは ROOTDIR/bastion-services/templates です。

バージョン 1.31.0 で追加.

GENVID_BASTION_STATIC_DIR

API スキーマを格納する Bastion-API の静的ディレクトリ。

バージョン 1.20.0 で追加.

GENVID_BASTION_URL

スクリプトが bastion-api と通信するために使用する変数。デフォルトでは、Consul discovery を使用します。

バージョン 1.11.0 で追加.

GENVID_CHECKIP_URL

この URL は、外部 IP アドレスを返すメソッドをポイントする必要があります。ローカル Bastion では、リモートサーバーにアクセスするため、多くの場合デフォルトで trusted_cidr を設定します。デフォルト値は、CHECKIP_URL に基づいて設定されます。

バージョン 1.19.0 で追加.

GENVID_CLUSTER_ID

ツールボックスアプリケーションがデフォルトで使用するクラスタの ID。また、 Cluster API をレンダリングするテンプレートにも存在します。

バージョン 1.21.0 で追加.

バージョン 1.33.0 で変更: また、Cluster API での使用も標準化されました。

GENVID_COMMAND_SECRET

レガシーモードで使用する :program: commandd API シークレット。

バージョン 1.23.0 で撤廃.

参考

GENVID_WEBGATEWAY_SECRET

GENVID_DEFAULT_IP

サービスをローカルにバインドするためのデフォルト IP を 127.0.0.1 にオーバーライドします。この変数の使用については、 ローカル IP の設定 セクションで説明しています。

GENVID_DISCO_SECURE

この環境変数が True の場合、leaf サービスで wss スキームを有効にします。

GENVID_DOCKER_API_TIMEOUT

DockerTool が使用する Docker API のタイムアウトを秒単位で設定します。デフォルトは120秒です。

バージョン 1.34.0 で追加.

GENVID_LEAF_KEY_FILE

WebSocket を使用するためのプライベートキーファイルのパスを含みます。

GENVID_LEAF_CERT_FILE

WebSocket を使用するための TLS 証明書ファイルのパスを含みます。

GENVID_LOGGER_PREFIX

Genvid.dll SDK ロガーによって使用されるプレフィックス。

GENVID_PROFILE

使用する名前付きプロフィール。この環境変数が定義されている場合、指定したプロフィールが GENVID_PROFILES_PATH で定義されたパスに存在している必要があります。

参考

genvid.toolbox.Profile

バージョン 1.20.0 で追加.

GENVID_PROFILE_PATH

プロフィールがロードされている場合、またはプロフィールが未使用の状態で、文字列が空白の場合。

参考

genvid.toolbox.Profile

バージョン 1.20.0 で追加.

GENVID_PROFILES_PATH

名前を付けたプロフィールを検索する順番および場所を定義する、os.pathsep で分類したパス一覧。パスは標準ファイルまたはディレクトリをポイントすることができます。

参考

genvid.toolbox.Profile

バージョン 1.20.0 で追加.

GENVID_SERVICES_DATADIR

この変数が、Bastion 監視サービスのデータディレクトリの場所を示します。

GENVID_SESSION_NAME

Genvid MILE SDK で使用されるRTMSPセッションの名前です。この名前は、プロジェクトで一意でなければなりません。この変数がない場合、一意の名前が作成される。

GENVID_STARTUP_TIMEOUT

監視サービスを開始するために genvid-bastion によって使用されるタイムアウト。

GENVID_STATIC_BINDING

この変数が、ローカルの Nomad テンプレート (bastion-services/templates 下) 内で使用され、各サービスに固定ポートを割り当てます。設定されていない場合、サービスは、 nomad によって動的に割り当てられたポートを使用します。

GENVID_STATSD_DISABLED

値が 「true」 の場合、このプロセスでは statsd メトリクスのコレクションは無効になります。

GENVID_STATSD_URL

StatsD サーバーが使用する URL。設定されていない場合、デフォルトアドレス (udp://127.0.0.1:8125) が使用されます。現在、使用できるスキームは udp だけです。このスキームは必須ではありません。

GENVID_TEMPLATE_SANDBOX_PATH

POST /template_renderer を呼び出す際に、テンプレートのソースがコピーされるサンドボックスのパスを指定します。

バージョン 1.33.0 で追加.

GENVID_TEMPLATE_TIMEOUT

Bastion API と Cluster API の内部変数で、consul-template のレンダリング時の動作を内部で設定することができます。 デフォルトは 2 秒。

GENVID_TOOLBOX_LOGFORMAT

スクリプトのデフォルトログ形式。 logging.Formatter の形式オプションに従います。

GENVID_TOOLBOX_LOGLEVEL

スクリプトのデフォルトログレベルです。

GENVID_TOOLBOX_VERSION

インストールされているツールボックスのバージョンです。

GENVID_VAULT_POLICIES_FOLDER

Vault がポリシーを検索できるフォルダです。 genvid.toolbox.VaultTool.vault_load_policies() を参照してください。

GENVID_VAULT_TOKEN_ROLES_FOLDER

Vault がロールを検索できるフォルダです。 genvid.toolbox.VaultTool.vault_load_roles() を参照してください。

GENVID_VERBOSE_EXCEPTIONS

1 に設定した場合、デフォルトのコンパクト出力ではなく、完全なスタックトレースを Python ツールボックスに表示します。

GENVID_WEBGATEWAY_SECRET

webgateway API シークレットを格納する環境変数。

バージョン 1.23.0 で追加.

GVENCODE_FONT_DIR

gvencode がフォントを検索できるディレクトリです。

HOME

ユーザーのホームディレクトリの変数です。Windows では、通常、 USERPROFILE を指します。

PROJECTDIR

この変数が、サンプルスクリプトによってカレントディレクトリの値に設定されます。主にローカル環境でバイナリの場所を指定する場合に使用します。

PYTHON_EXECUTABLE

ツールボックス内の現在の Python 実行ファイルを指す変数です。

ROOTDIR

この変数が SDK インストールディレクトリを指します。ツールボックスによって使用されます。これは近い将来、廃止される可能性があります。

STUDIO_WEB_DIR

Studio Web サイト studiod のフォルダの場所です。

UE4ENGINEDIR

Unreal Engine 4 のインストールのエンジンレポジトリです。デフォルトでは、 UE4ROOT/Engine で、 UE4ROOT はエンジンのインストールディレクトリです。詳細は、 UE4 サンプル用アプリケーション を参照してください。

UE4ROOT

Unreal Engine がインストールされているレポジトリ。 UE4ROOT を参照してください。

UTROOT

UnrealTournament のクローンレポジトリ。詳細は、 Unreal Tournament の統合 を参照してください。

VAULT_ADDR

Vault サービスのアドレス。

VAULT_KEYS

Vault の unseal に使用するキー。

VAULT_TOKEN

Vault の接続に使用するトークン。

VAULT_TOKEN_FILE

Vault トークンが保存されたファイルのパス。

VAULT_KEYS_FILE

Vault キーが保存されたファイルのパス。