このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

admin-docker-agent

(システム コマンド) User Manager、Issue Tracker、およびその他の Polyspace Access アプリを管理するために Cluster Admin インターフェイスを起動

ページ内をすべて折りたたむ

構文

admin-docker-agent [OPTIONS]

説明

admin-docker-agent システム コマンドは、User Manager、Issue Tracker、およびその他の Polyspace® Access™ アプリを管理するための Cluster Admin インターフェイスを起動します。

admin-docker-agent [OPTIONS] により、"Cluster Admin" インターフェイスが起動します。追加で OPTIONS を指定しない場合、Admin エージェントはホスト名 localhost を使用して、ポート 9443 で HTTP プロトコルを使って起動します。

例

例

すべて折りたたむ

既定では、"Cluster Admin" は HTTP プロトコルを使用します。"Cluster Admin" とクライアント マシン間でデータを暗号化するには、"Cluster Admin" に HTTPS プロトコルを構成します。この構成により、API Gateway サービスでも HTTPS が有効になり、その他すべてのサービスとクライアント マシン間の通信を処理するようになります。

Polyspace Access を複数のノードにインストールする場合、または --force-exposing-ports を使用して "Admin" エージェントを起動する場合は、User Manager、Issue Tracker、および Polyspace Access サービスのそれぞれで HTTPS を構成する必要があります。これらのサービスで HTTPS を構成するには、[Cluster Dashboard] で [Configure Nodes] をクリックします。

openssl ツールキットを使用して、自己署名 SSL 証明書と秘密鍵ファイルを作成します。 

openssl req -newkey rsa:2048 -new -nodes -x509 -days 365 -keyout self_key.pem -out self_cert.pem
コマンドを入力したら、画面上のプロンプトに従って操作します。ほとんどのフィールドは空白のままで構いませんが、Common Name (CN) は指定する必要があります。CN は、admin-docker-agent を実行しているマシンの完全修飾ドメイン名 (FQDN) と一致している必要があります。このコマンドにより、証明書ファイル self_cert.pem と秘密鍵ファイル self_key.pem が出力されます。

マシンの FQDN を取得するには、Linux® ではコマンド hostname --fqdn、Windows® ではコマンド net config workstation | findstr /C:"Full Computer name" を使用します。

生成した証明書ファイルと秘密鍵ファイルを使用して admin-docker-agent を起動し、hostName (マシンの FQDN) を指定します。hostName は、SSL 証明書の CN に対して入力した FQDN と一致している必要があります。以下のコマンドでは、これらのファイルの絶対パスを指定します。

Windows PowerShell 
admin-docker-agent --hostname hostName`
--ssl-cert-file absolutePathTo\self_cert.pem `
--ssl-key-file absolutePathTo\self_key.pem.pem `
--ssl-ca-file absolutePathTo\self_cert.pem
Linux 
./admin-docker-agent --hostname hostName \
--ssl-cert-file absolutePathTo/self_cert.pem \
--ssl-key-file absolutePathTo/self_key.pem.pem \
--ssl-ca-file absolutePathTo/self_cert.pem

これで、https://hostName:9443/admin を使用して、ブラウザーから "Cluster Admin" Web インターフェイスにアクセスできるようになりました。

入力引数

すべて折りたたむ

"Cluster Admin" の接続設定を指定し、管理するためのオプション。

一般的なオプション

オプション説明

--hostname hostName

"Cluster Admin" を実行するマシンの完全修飾ドメイン名を指定します。HTTPS 構成オプションを使用する場合は、このオプションが必須です。hostName は、SSL 証明書を取得するために指定する Common Name (CN) と一致している必要があります。

既定のホスト名は localhost です。

--port portNumber

"Cluster Admin" Web インターフェイスにアクセスするために使用する、サーバーのポート番号を指定します。

既定のポート値は 9443 です。

--data-dir dirPath

settings.json ファイルが含まれているフォルダーの絶対パスを指定します。

このファイルが存在しない場合は、"Cluster Admin" によって指定したフォルダーにファイルが作成されます。

ファイルが既に存在する場合、"Cluster Admin" はその内容を再利用して設定を構成します。

既定のフォルダーは現在のフォルダーです。

--network-name networkName

Polyspace Access、User Manager、および Issue Tracker アプリが使用する、Docker® ネットワークの名前を指定します。

アプリで既定の mathworks ネットワークの使用を避ける必要がある場合 (たとえば、既定のネットワークが既存のネットワークと競合する場合) に、このオプションを使用します。

Docker ネットワークが既存のネットワークと競合するかどうかを確認するには、次のコマンドを実行します。

docker network inspect networkName
IPAM.Config ノードを検査して、ネットワークで使用されている IP 範囲を確認します。場合によっては、ネットワーク管理者に連絡して、IP 範囲が他のサービスによって使用されているかどうかを判断する必要があります。networkName を確認するには、コマンド docker network ls を使用します。

新しいネットワークを作成するには、docker network create を参照してください。

--force-exposing-ports

単一のノードにすべてのサービスをインストールする場合に、それらのサービスのポートを公開するには、このオプションを指定します。公開されたポートのバインド先とする Docker ホストのポートを指定するには、[Cluster Admin] を開いて、[Configure Nodes] をクリックし、[Services] タブに移動します。

既定では、単一のノードにすべてのサービスをインストールする場合、それらのサービスのポートは公開されません。

単一のノードにすべてのサービスをインストールするものの、サード パーティのツールを使用してそれらのサービスのいずれかと通信する必要がある場合 (たとえば、PostgreSQL ユーティリティを使用して Polyspace Access データベースと通信する場合) に、このオプションを使用します。

--reset-password"Cluster Admin" Web インターフェイスにログインするために使用するパスワードをリセットします。
--versionAdmin エージェントのバージョン番号を表示します。
--helpヘルプ メニューを表示します。

HTTPS 構成オプション

Windows システムでは、すべてのパスがローカル ドライブを指している必要があります。

オプション説明

--ssl-cert-file absolutePath

SSL 証明書 PEM ファイルの絶対パスを指定します。

--ssl-key-file absolutePath

証明書を生成するために使用した SSL 秘密鍵 PEM ファイルの絶対パスを指定します。

--ssl-ca-file absolutePath

信頼できる認証機関の証明書の格納先とする、証明書ストアの絶対パスを指定します。たとえば、Linux Debian® ディストリビューションでは /etc/ssl/certs/ca-certificates.crt のようになります。

自己署名証明書を使用している場合は、--ssl-cert-file で指定するのと同じファイルを使用します。

--restart-gateway

admin-docker-agent を再起動して HTTPS 構成オプションに変更を加えるか、または別のポートを指定する場合は、このオプションを使用して "Gateway" サービスを再起動します。

HTTPS 構成オプションに変更を加えるか、または別のポートを指定する場合は、このオプションを使用して "Gateway" サービスを再起動します。

新しいノードの構成オプション

複数のマシンに Polyspace Access をインストールする場合は、以下のオプションを使用して、それぞれのマシン上にノードを作成します。[Cluster Dashboard] で [Configure Nodes] をクリックし、[Services] タブを選択して、サービスを実行するノードを選択します。

ノードを作成する前に、admin-docker-agent のインスタンスが既に実行されている別のマシンが少なくとも 1 台必要です。この別のマシンが、main ノードをホストします。

オプション説明

--main-host hostName:port

"main" ノードをホストするマシンのホスト名とポート番号を指定します。

--node-id nodeName

作成するノードの名前。"Cluster Admin" を起動した後、[Nodes] 設定の [Services] タブにある [Node] ドロップダウン リストに、このノードが表示されます。

バージョン履歴

R2020b で導入

すべて展開する

参考

トピック