admin-docker-agent

(DOS/UNIX) 启动 Cluster Admin 界面来管理 User Manager、Issue Tracker 和 Polyspace Access

自 R2020b 起

语法

admin-docker-agent [OPTIONS]

说明

admin-docker-agent [OPTIONS] 启动 Cluster Admin 界面。如果您未指定其他 OPTIONS，则 Admin 代理将使用主机名 localhost 并使用 HTTP 协议在端口 9443 上启动。

示例

全部折叠

使用自签名证书配置 HTTPS 协议

默认情况下，Cluster Admin 采用 HTTP 协议。要加密 Cluster Admin 与客户端计算机之间的数据，请使用 HTTPS 协议配置 Cluster Admin。此配置还会为 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 界面了。

输入参数

全部折叠

`OPTIONS` — 用于管理 Cluster Admin 的选项
字符串

用于指定和管理 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^® 网络的名称。如果您不希望这些 App 使用默认的 `mathworks` 网络（例如，当该网络与现有网络冲突时），请使用此选项。要检查您的 Docker 网络是否与现有网络冲突，请运行以下命令： `docker network inspect networkName` 并检查 `IPAM.Config` 节点来查看该网络使用的 IP 范围。您可能需要联系您的网络管理员来确定 IP 范围是否被其他服务使用。要查找 `networkName`，请使用 `docker network ls` 命令。要创建新网络，请参阅创建 Docker 网络。
`--force-exposing-ports`	指定此选项后，当您在单个节点上安装所有服务时，会公开这些服务的端口。要指定公开的端口所绑定到的 Docker 主机端口，请打开 Cluster Admin，点击 Configure Nodes，然后转至 Services 选项卡。默认情况下，当在单个节点上安装服务时，不会公开这些服务的端口。如果您在单个节点上安装服务，但必须通过第三方工具与其中一项服务进行通信（例如，如果您使用 PostgreSQL 实用工具与 Polyspace Access 数据库进行通信），请使用此选项。
`--reset-password`	重置用于登录 Cluster Admin Web 界面的密码。
`--version`	显示 Admin 代理的版本号。
`--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 实例。这另一台计算机托管着 main 节点。

选项	描述
`--main-host` `hostName:port`	指定托管主节点的计算机的主机名和端口号。
`--node-id` `nodeName`	您创建的节点的名称。启动 Cluster Admin 后，您可以在 Nodes 设置的 Services 选项卡下的 Node 下拉列表中看到该节点。