附录
命令行参数说明
表 1 login 命令参数列表
命令 | 参数 | 说明 |
---|---|---|
login | -H, --host | 指定要连接的 iSulad socket 文件路径 |
-p, --password | 登录镜像仓库的密码 | |
--password-stdin | 从标准输入获取仓库的密码 | |
-u, --username | 登录镜像仓库的用户名 |
表 2 logout 命令参数列表
命令 | 参数 | 说明 |
---|---|---|
logout | -H, --host | 指定要连接的 iSulad socket 文件路径 |
表 3 pull 命令参数列表
命令 | 参数 | 说明 |
---|---|---|
pull | -H, --host | 指定要连接的 iSulad socket 文件路径 |
表 4 rmi 命令参数列表
命令 | 参数 | 说明 |
---|---|---|
rmi | -H, --host | 指定要连接的 iSulad socket 文件路径 |
-f, --force | 强制移除镜像 |
表 5 load命令参数列表
命令 | 参数 | 说明 |
---|---|---|
load | -H, --host (仅 isula 支持) |
指定要连接的 iSulad socket 文件路径 |
-i, --input | 指定从哪里导入镜像。 如果是 docker 类型,则为镜像压缩包路径; 如果是 embedded 类型,则为镜像 manifest 路径。 |
|
--tag | 不使用默认的镜像名称,而是使用 TAG 指定的名称, type 为 docker 类型时支持该参数 |
|
-t, --type | 镜像类型,取值为 embedded 或 docker(默认值) |
表 6 images 命令参数列表
命令 | 参数 | 说明 |
---|---|---|
images | -H, --host | 指定要连接的 iSulad socket 文件路径 |
-q, --quit | 只显示镜像名字 |
表 7 inspect 命令参数列表
命令 | 参数 | 说明 |
---|---|---|
inspect | -H, --host | 指定要连接的 iSulad socket 文件路径 |
-f, --format | 使用模板格式化输出 | |
-t, --time | 超时时间的秒数, 若在该时间内 inspect 查询容器信息未执行成功,则停止等待并立即报错, 默认为 120 秒, 当配置小于等于 0 的值,表示不启用 timeout 机制 inspect 查询容器信息 会一直等待,直到获取容器信息成功后返回。 |
CNI配置参数
表 8 CNI单网络配置参数
参数 | 类型 | 是否可选 | 说明 |
---|---|---|---|
cniVersion | string | 必选 | CNI 版本号,当前只支持 0.3.0,0.3.1。 |
name | string | 必选 | 网络名称,由用户自定义,需保证唯一。 |
type | string | 必选 | 网络类型。目前支持的网络类型:underlay_ipvlan overlay_l2 underlay_l2 vpc-router dpdk-direct phy-direct |
ipmasp | bool | 可选 | 设置 IP masquerade |
ipam | 结构体 | 可选 | 详细定义参考 IPAM 参数定义 |
ipam.type | string | 可选 | IPAM类型,目前支持的类型: (1)underlay_l2、overlay_l2、vpc-router 组网默认值 distributed_l2, 且只支持 distributed_l2。 (2)underlay_ipvlan 组网, 默认 distributed_l2。 CCN 场景只支持 null、fixed; CCE 和 FST 5G core 场景只支持null、 distributed_l2。 (3)phy-direct、dpdk-direct 组网, 默认l2,可选 null、distributed_l2。 FST 5G core场景只支持 null、distributed_l2。 说明: 超出选择范围(比如 host-local), Canal 会自动设置为默认,不会返回错误。 null:不使用 canal 管理 ip。 fixed:固定 ip,CCN 场景使用。 l2:目前没有场景使用。 distributed_l2:使用分布式小子网管理 ip。 |
ipam.subnet | string | 可选 | 子网信息。 Canal 支持的 subnet mask 范围为 [8,29], 并且要求 IP 地址不能为 Multicast 地址 (如224.0.0.0/4), 保留地址(240.0.0.0/4), 本地 link 地址(169.254.0.0/16)以及 本地 loop 地址(127.0.0.0/8)。 |
ipam.gateway | string | 可选 | 网关 IP |
ipam.range-start | string | 可选 | 可用的起始 IP 地址 |
ipam.range-end | string | 可选 | 可用的结束 IP 地址 |
ipam.routes | 结构体 | 可选 | subnet 列表, 每个元素都是一个 route 字典。 参考 route 定义。 |
ipam.routes.dst | string | 可选 | 表示目的网络 |
ipam.routes.gw | string | 可选 | 表示网关地址 |
dns | 结构体 | 可选 | 包含一些 DNS 的特殊值。 |
dns.nameservers | []string | 可选 | nameservers |
dns.domain | string | 可选 | domain |
dns.search | []string | 可选 | search |
dns.options | []string | 可选 | 选项 |
multi_entry | int | 可选 | 表示一个 vnic 需要的 ip 数量,范围 0~16。 对于物理直通,单个网卡最多可申请 128 个 IP。 |
backup_mode | bool | 可选 | 表示主备模式, 仅用于 phy-direct 和 dpdk-direct 组网。 |
vlanID | int | 可选 | 0~4095,允许 PaaS 直接指定。 |
vlan_inside | bool | 可选 | true 表示 vlan 功能由 Node 内部实现, false 表示 vlan 在外部实现。 |
vxlanID | int | 可选 | 0~16777215,允许 PaaS 直接指定。 |
vxlan_inside | bool | 可选 | true 表示 vlan 功能由 Node 内部实现, false 表示 vlan 在外部实现。 |
action | string | 可选 | 该参数只能和特殊 containerID “000000000000” 一起使用。 Create 表示创建网络。 Delete 表示删除网络。 |
args | map[string]interface{} | 可选 | 主要描述键值对类型。表9 CNI args参数表 |
runtimeConfig | 结构体 | 可选 | 无 |
capabilities | 结构体 | 可选 | 无 |
表 9 CNI args参数表
参数 | 类型 | 是否可选 | 说明 |
---|---|---|---|
K8S_POD_NAME | string | 可选 | 申请固定 IP (runtimeConfig.ican_caps.fixed_ip 为 true) 时需要设置 K8S_POD_NAME |
K8S_POD_NAMESPACE | string | 可选 | 申请固定 IP (runtimeConfig.ican_caps.fixed_ip为true) 时需要设置 K8S_POD_NAMESPACE |
SECURE_CONTAINER | string | 可选 | 安全容器标志 |
multi_port | int | 可选 | 默认值为 1,取值范围 1-8。 只支持 phy-direct 和 dpdk-direct 两种类型网络, 指定直通网卡数量 |
phy-direct | string | 可选 | 用于在创建硬直通容器网络时指定接入的网卡 |
dpdk-direct | string | 可选 | 用于在创建 dpdk 直通容器网络时指定接入的网卡 |
tenant_id | string | 可选 | 租户的 ID。只支持 vpc-router 类型网络。 |
vpc_id | string | 可选 | VPC 的 ID。只支持 vpc-router 类型网络。 |
secret_name | string | 可选 | 表示 k8s apiserver 中保存有 ak sk 的对象名。 只支持 vpc-router 类型网络 参考配置 VPC-Router 逻辑网络 |
IP | string | 可选 | 用户指定 ip 地址,格式 “192.168.0.10” |
K8S_POD_NETWORK_ARGS | string | 可选 | 指定 ip 地址,格式 “192.168.0.10”。 若 args 中 IP 和 K8S_POD_NETWORK_ARGS 都不为空, 以 K8S_POD_NETWORK_ARGS 为准。 |
INSTANCE_NAME | string | 可选 | INSTANCE ID。参考支持容器固定 IP |
dist_gateway_disable | bool | 可选 | true 表示不创建 gateway, false 表示创建 gateway。 |
phynet | string或[]string | 可选 | 所需加入的的物理平面信息, 为预先定义好的物理网络名称, 与 SNC 体系中的呼应, 输入两个平面名时,支持主备平面。 例如:”phy_net1” 或 [“phy_net2”,“phy_net3”] |
endpoint_policies | struct | 可选 | “endpoint_policies”: [ { “Type”: “”,“ExceptionList”: [ ”” ], “NeedEncap”: true, “DestinationPrefix”: “” } ] |
port_map | struct | 可选 | NAT类型网络中,支持容器端口发布至主机端口。 “port_map”: [ { “local_port”: number,“host_port”: number,“protocol”: [string…] }… ] |
表 10 CNI多网络配置参数
参数 | 类型 | 是否可选 | 说明 |
---|---|---|---|
cniVersion | string | 必选 | CNI 版本号,当前只支持 0.3.0,0.3.1。 |
name | string | 必选 | 网络名称,由用户自定义,需保证唯一。 |
plugins | struct | 必选 | 具体配置请参见表8 CNI单网络配置参数。 |