18.20. Network [operator.openshift.io/v1]
- 描述
- network 描述了集群所需的网络配置。它由 cluster-network-operator 使用。兼容性级别 1:在主发行版本中至少提供 12 个月或 3 个次版本(以更长的时间为准)。
- 类型
-
对象
18.20.1. 规格 复制链接链接已复制到粘贴板!
属性 | 类型 | 描述 |
---|---|---|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| NetworkSpec 是顶层网络配置对象。 |
|
| NetworkStatus 是详细的 operator 状态,它干扰 Network clusteroperator 对象。 |
18.20.1.1. .spec 复制链接链接已复制到粘贴板!
- 描述
- NetworkSpec 是顶层网络配置对象。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| additionalNetworks 是启用多个网络时可供 pod 使用的额外网络列表。 |
|
| AdditionalNetworkDefinition 配置一个可用的额外网络,但没有默认创建。相反,pod 必须按名称请求它们。必须指定 type,以及与类型匹配的一个 "Config"。 |
|
| clusterNetwork 是用于 pod IP 的 IP 地址池。有些网络供应商(如 OpenShift SDN)支持多个 ClusterNetworks。其他产品只支持一个。这等同于 cluster-cidr。 |
|
| ClusterNetworkEntry 是一个从中分配 PodIP 的子网。当节点加入集群时,将分配大小为 HostPrefix (以 CIDR 表示法)的网络。如果插件没有使用 HostPrefix 字段,则可以保留不设置。不是所有网络供应商支持多个 ClusterNetworks |
|
| defaultNetwork 是所有 pod 接收的"默认"网络 |
|
| deployKubeProxy 指定 Operator 是否应该部署独立 kube-proxy。有些网络供应商包括 kube-proxy 或类似的功能。如果未设置,则插件会尝试选择正确的值,在 OpenShift SDN 和 ovn-kubernetes 被使用时为 false,否则为 true。 |
|
| disableMultiNetwork 指定是否应禁用多个 pod 网络支持。如果未设置,此属性默认为 'false',并且启用了多个网络支持。 |
|
| disableNetworkDiagnostics 指定 PodNetworkConnectivityCheck CR 从测试 pod 到每个节点,应禁用 apiserver 和 LB。如果未设置,此属性默认为 'false' 并启用网络诊断。把它设置为 'true' 可减少执行检查的 pod 的额外负载。 |
|
| exportNetworkFlows 启用并配置 pod 网络中的网络流元数据导出,使用协议 NetFlow、SFlow 或 IPFIX。目前仅在 OVN-Kubernetes 插件中被支持。如果未设置,则不会将流导出到任何收集器。 |
|
| kubeProxyConfig 允许配置所需的代理配置。如果没有指定,则 OpenShift 将直接选择 sensable 默认值。没有被所有网络供应商使用 - 目前只有 openshift-sdn。 |
|
| logLevel 是针对整个组件的意图日志。它并不提供精细的控制,但管理操作器必须为其操作对象解释的粒度日志记录选择的简单方法。有效值为:"Normal", "Debug", " Trace", " TraceAll"。默认为 "Normal"。 |
|
| managementState 指明 Operator 是否应该如何管理组件 |
|
| 迁移启用并配置集群网络迁移。把它设置为目标网络类型以允许更改默认网络。如果未设置,则更改集群默认网络插件的操作将被拒绝。 |
| `` | observedConfig 包含控制器从集群状态观察到的稀疏配置。它存在于 spec 中,因为它是 Operator 级别的输入 |
|
| operatorLogLevel 是 Operator 本身的基于日志的意图。它并不提供精细的控制,但是管理操作器必须自行解释的粒度日志记录选择的简单方法。有效值为:"Normal", "Debug", " Trace", " TraceAll"。默认为 "Normal"。 |
|
| serviceNetwork 是用于服务 IP 当前使用的 ip 地址池,所有现有的网络供应商在此只支持单个值,但这是允许增长的数组。 |
| `` | unsupportedConfigOverrides 包含一个稀疏配置,它将覆盖任何之前设置的选项。它只需要是覆盖它的字段,它将以以下顺序结束:1。硬编码的默认值 2. observedConfig 3. unsupportedConfigOverrides |
|
| useMultiNetworkPolicy 启用了一个控制器,允许在由 Multus CNI 创建的额外网络中使用 MultiNetworkPolicy 对象。MultiNetworkPolicy 与 NetworkPolicy 对象类似,但 NetworkPolicy 对象仅适用于主接口。使用 MultiNetworkPolicy,您可以控制 pod 可以通过二级接口接收的流量。如果未设置,此属性默认为 'false' 和 MultiNetworkPolicy 对象将被忽略。如果 'disableMultiNetwork' 为 'true',则忽略此字段的值。 |
18.20.1.2. .spec.additionalNetworks 复制链接链接已复制到粘贴板!
- 描述
- additionalNetworks 是启用多个网络时可供 pod 使用的额外网络列表。
- 类型
-
array
18.20.1.3. .spec.additionalNetworks[] 复制链接链接已复制到粘贴板!
- 描述
- AdditionalNetworkDefinition 配置一个可用的额外网络,但没有默认创建。相反,pod 必须按名称请求它们。必须指定 type,以及与类型匹配的一个 "Config"。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| name 是网络的名称。这将填充生成的 CRD,这必须是唯一的。 |
|
| namespace 是网络的命名空间。如果没有在 default 命名空间中创建网络,这会填充生成的 CRD。 |
|
| rawCNIConfig 是要在 NetworkAttachmentDefinition CRD 中创建的原始 CNI 配置 json |
|
| simpleMacvlanConfig 在 type:NetworkTypeSimpleMacvlan 时配置 macvlan 接口 |
|
| type 是网络类型,支持的值是 NetworkTypeRaw, NetworkTypeSimpleMacvlan |
- 描述
- simpleMacvlanConfig 在 type:NetworkTypeSimpleMacvlan 时配置 macvlan 接口
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| ipamConfig 配置 IPAM 模块将用于 IP 地址管理(IPAM)。 |
|
| Master 是要从中创建 macvlan 接口的主机接口。如果没有指定,它将是默认路由接口 |
|
| 模式是 macvlan 模式:bridge、private、vepa、passthru。默认值为 bridge |
|
| MTU 是用于 macvlan 接口的 mtu。如果未设置,主机的内核将选择该值。 |
- 描述
- ipamConfig 配置 IPAM 模块将用于 IP 地址管理(IPAM)。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| staticIPAMConfig 在 type:IPAMTypeStatic 时配置静态 IP 地址 |
|
| type 是 IPAM 模块的类型将用于 IP 地址管理(IPAM)。支持的值有 IPAMTypeDHCP, IPAMTypeStatic |
- 描述
- staticIPAMConfig 在 type:IPAMTypeStatic 时配置静态 IP 地址
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| Address 为接口配置 IP 地址 |
|
| StaticIPAMAddresses 为静态 IPAM 地址提供 IP 地址和网关 |
|
| DNS 为接口配置 DNS |
|
| 路由为接口配置 IP 路由 |
|
| StaticIPAMRoutes 为静态 IPAM 路由提供目的地/Gateway 对 |
- 描述
- Address 为接口配置 IP 地址
- 类型
-
array
- 描述
- StaticIPAMAddresses 为静态 IPAM 地址提供 IP 地址和网关
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| address 是 CIDR 格式的 IP 地址 |
|
| 网关是子网内要指定为网关的 IP |
- 描述
- DNS 为接口配置 DNS
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| domain 配置用于短主机名查找的本地域的域名 |
|
| 名称服务器指向 DNS 服务器进行 IP 查找 |
|
| 搜索配置优先级排序搜索域以获取短主机名查找 |
- 描述
- 路由为接口配置 IP 路由
- 类型
-
array
- 描述
- StaticIPAMRoutes 为静态 IPAM 路由提供目的地/Gateway 对
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 目的地指向 IP 路由目的地 |
|
| gateway 是路由的下一步 IP 地址(如果未设置),则会假定默认网关(由 CNI 插件决定)。 |
18.20.1.12. .spec.clusterNetwork 复制链接链接已复制到粘贴板!
- 描述
- clusterNetwork 是用于 pod IP 的 IP 地址池。有些网络供应商(如 OpenShift SDN)支持多个 ClusterNetworks。其他产品只支持一个。这等同于 cluster-cidr。
- 类型
-
array
18.20.1.13. .spec.clusterNetwork[] 复制链接链接已复制到粘贴板!
- 描述
- ClusterNetworkEntry 是一个从中分配 PodIP 的子网。当节点加入集群时,将分配大小为 HostPrefix (以 CIDR 表示法)的网络。如果插件没有使用 HostPrefix 字段,则可以保留不设置。不是所有网络供应商支持多个 ClusterNetworks
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| |
|
|
18.20.1.14. .spec.defaultNetwork 复制链接链接已复制到粘贴板!
- 描述
- defaultNetwork 是所有 pod 接收的"默认"网络
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| kuryrConfig 配置 kuryr 插件 |
|
| openshiftSDNConfig 配置 openshift-sdn 插件 |
|
| ovnKubernetesConfig 配置 ovn-kubernetes 插件。目前没有实现。 |
|
| 除了 NetworkTypeRaw 外,支持网络 All NetworkTypes 的类型 |
18.20.1.15. .spec.defaultNetwork.kuryrConfig 复制链接链接已复制到粘贴板!
- 描述
- kuryrConfig 配置 kuryr 插件
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 端口 kuryr-controller 将侦听就绪度和存活度请求。 |
|
| 端口 kuryr-daemon 将侦听就绪度和存活度请求。 |
|
| 当 true 使 Kuryr 预先填充每个新创建的端口池时,enablePortPoolsPrepopulation。Kuryr 使用 Neutron 端口池来达到创建大量时间的事实。Kuryr 保留多个端口准备好附加到 pod 时,而不是在部署时创建它。默认情况下禁用端口预填充。 |
|
| MTU 是 Kuryr 在 Neutron 中创建 pod 网络时使用的 MTU。该值必须小于或等于节点网络的 MTU,而 Neutron 必须允许使用此类 MTU 创建租户网络。如果未设置 Pod 网络会使用与节点网络相同的 MTU 创建。 |
|
|
openStackServiceNetwork 包含从中为 OpenStack Octavia 的 Amphora 虚拟机分配 IP 的网络 CIDR。请注意,对于 Amphora 驱动程序 Octavia,每个负载均衡器都使用来自该网络的两个 IP - 一个由 OpenShift 指定,第二个用于 VRRP 连接。由于第一人由 OpenShift 的 OpenShift 管理,第二个由 Neutron 的 IPAM 管理,它们需要来自不同的池。因此,openStackServiceNetwork 需要至少是 |
|
| poolBatchPorts 设置应在单个批处理请求中创建的多个端口来扩展端口池。默认值为 3。有关端口池的更多信息,请参阅 enablePortPoolsPrepopulation 设置。 |
|
| poolMaxPorts 设置保存在端口池中的最大可用端口数。如果端口数量超过此设置,则空闲端口将被删除。设置 0 将禁用此上限,有效防止池缩小,这是默认值。有关端口池的更多信息,请参阅 enablePortPoolsPrepopulation 设置。 |
|
| poolMinPorts 设置应保留在端口池中的最少可用端口数。如果端口数量低于此设置,则会创建新端口并添加到池中。默认值为 1。有关端口池的更多信息,请参阅 enablePortPoolsPrepopulation 设置。 |
18.20.1.16. .spec.defaultNetwork.openshiftSDNConfig 复制链接链接已复制到粘贴板!
- 描述
- openshiftSDNConfig 配置 openshift-sdn 插件
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 启用统一控制服务代理是否支持闲置和取消闲置服务。默认情况下启用取消闲置。 |
|
| mode 是"Multitenant"、"Subnet" 或 "NetworkPolicy" 之一 |
|
| MTU 是用于隧道接口的 mtu。如果未设置,则默认为 1450。这必须比机器的 uplink 小 50 字节。 |
|
| 使用ExternalOpenvswitch 来控制 Operator 是否部署 OVS DaemonSet 本身,或者希望其他人启动 OVS。从 4.6 开始,OVS 始终作为系统服务运行,这个标志将被忽略。DEPRECATED: 从 4.6 开始无法正常工作 |
|
| vxlanPort 是所有 vxlan 数据包使用的端口。默认值为 4789。 |
18.20.1.17. .spec.defaultNetwork.ovnKubernetesConfig 复制链接链接已复制到粘贴板!
- 描述
- ovnKubernetesConfig 配置 ovn-kubernetes 插件。目前没有实现。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| Geneve 端口是 geneve encapulation 使用的 UDP 端口。默认为 6081 |
|
| hybridOverlayConfig 为不使用 OVN 的对等点配置额外的覆盖网络。 |
|
| ipsecConfig 为集群中的 pod 网络上的 pod 启用并配置 IPsec。 |
|
| MTU 是用于隧道接口的 MTU。这必须比 uplink mtu 小 100 字节。默认为 1400 |
|
| policyAuditConfig 是网络策略审计事件的配置。如果未设置,则使用报告的默认值。 |
- 描述
- hybridOverlayConfig 为不使用 OVN 的对等点配置额外的覆盖网络。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| hybridClusterNetwork 定义分配给额外覆盖网络上的节点的网络空间。 |
|
| ClusterNetworkEntry 是一个从中分配 PodIP 的子网。当节点加入集群时,将分配大小为 HostPrefix (以 CIDR 表示法)的网络。如果插件没有使用 HostPrefix 字段,则可以保留不设置。不是所有网络供应商支持多个 ClusterNetworks |
|
| hybridOverlayVXLANPort 定义额外覆盖网络使用的 VXLAN 端口号。默认为 4789 |
- 描述
- hybridClusterNetwork 定义分配给额外覆盖网络上的节点的网络空间。
- 类型
-
array
- 描述
- ClusterNetworkEntry 是一个从中分配 PodIP 的子网。当节点加入集群时,将分配大小为 HostPrefix (以 CIDR 表示法)的网络。如果插件没有使用 HostPrefix 字段,则可以保留不设置。不是所有网络供应商支持多个 ClusterNetworks
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| |
|
|
- 描述
- ipsecConfig 为集群中的 pod 网络上的 pod 启用并配置 IPsec。
- 类型
-
对象
- 描述
- policyAuditConfig 是网络策略审计事件的配置。如果未设置,则使用报告的默认值。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
destination 是策略日志消息的位置。无论这个配置是什么,持久性日志总是转储到 /var/log/ovn/ 的主机,但也可以配置其他 syslog 输出,如下所示。有效值为: - "libc" |
|
| maxFilesSize 是 ACL_audit 日志文件的最大值,在轮转发生单元以 MB 为单位,默认为 50MB |
|
| ratelimit 是每个节点每秒生成的大约最大消息数。如果未设置默认值 20 msg/sec。 |
|
| 用于生成的消息的 RFC5424 工具的 syslogFacility,如 "kern"。默认为 "local0" |
18.20.1.23. .spec.exportNetworkFlows 复制链接链接已复制到粘贴板!
- 描述
- exportNetworkFlows 启用并配置 pod 网络中的网络流元数据导出,使用协议 NetFlow、SFlow 或 IPFIX。目前仅在 OVN-Kubernetes 插件中被支持。如果未设置,则不会将流导出到任何收集器。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| IPFIX 定义 IPFIX 配置。 |
|
| NetFlow 定义 NetFlow 配置。 |
|
| sFlow 定义 SFlow 配置。 |
18.20.1.24. .spec.exportNetworkFlows.ipfix 复制链接链接已复制到粘贴板!
- 描述
- IPFIX 定义 IPFIX 配置。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| ipfixCollectors 是字符串列表,格式为 ip:port,最多 10 个项目 |
18.20.1.25. .spec.exportNetworkFlows.netFlow 复制链接链接已复制到粘贴板!
- 描述
- NetFlow 定义 NetFlow 配置。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| NetFlow 定义 NetFlow 收集器,它将消耗从 OVS 导出的流程数据。它是格式为 ip:port 的字符串列表,最多有十个项目 |
18.20.1.26. .spec.exportNetworkFlows.sFlow 复制链接链接已复制到粘贴板!
- 描述
- sFlow 定义 SFlow 配置。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| sFlowCollectors 是字符串列表,格式为 ip:port,最多 10 个项目 |
18.20.1.27. .spec.kubeProxyConfig 复制链接链接已复制到粘贴板!
- 描述
- kubeProxyConfig 允许配置所需的代理配置。如果没有指定,则 OpenShift 将直接选择 sensable 默认值。没有被所有网络供应商使用 - 目前只有 openshift-sdn。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 默认到 0.0.0.0 上的 "bind" 地址 |
|
| 内部 kube-proxy 参数。在较早版本的 OCP 中,出于性能原因,有时需要在大型集群中调整此调整,但这已不再需要,因此不需要修改默认值。默认:30s |
|
| 传递给 kubeproxy 进程的任何其他参数 |
|
| ProxyArgumentList 是传递给 kubeproxy 进程的参数列表 |
18.20.1.28. .spec.kubeProxyConfig.proxyArguments 复制链接链接已复制到粘贴板!
- 描述
- 传递给 kubeproxy 进程的任何其他参数
- 类型
-
对象
18.20.1.29. .spec.migration 复制链接链接已复制到粘贴板!
- 描述
- 迁移启用并配置集群网络迁移。把它设置为目标网络类型以允许更改默认网络。如果未设置,则更改集群默认网络插件的操作将被拒绝。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| networkType 是网络迁移的目标类型,支持的值是 OpenShiftSDN、OVNKubernetes |
18.20.1.30. .status 复制链接链接已复制到粘贴板!
- 描述
- NetworkStatus 是详细的 operator 状态,它干扰 Network clusteroperator 对象。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| conditions 是条件及其状态列表 |
|
| OperatorCondition 只是标准条件字段。 |
|
| 生成用于确定何时需要协调项目,或者以需要反应的方式更改项目。 |
|
| GenerationStatus 跟踪给定资源的生成,以便可以做出有关强制更新的决策。 |
|
| observedGeneration 是您已处理的最后生成变化 |
|
| readyReplicas 指示有多少副本就绪并处于所需的状态 |
|
| 版本是此可用性适用于的级别 |
18.20.1.31. .status.conditions 复制链接链接已复制到粘贴板!
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
18.20.1.32. .status.conditions[] 复制链接链接已复制到粘贴板!
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
18.20.1.33. .status.generations 复制链接链接已复制到粘贴板!
- 描述
- 生成用于确定何时需要协调项目,或者以需要反应的方式更改项目。
- 类型
-
array
18.20.1.34. .status.generations[] 复制链接链接已复制到粘贴板!
- 描述
- GenerationStatus 跟踪给定资源的生成,以便可以做出有关强制更新的决策。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| group 是您要跟踪的项的组 |
|
| hash 是为没有生成的资源设置的可选字段,内容敏感,如 secret 和 configmaps |
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
| name 是您要跟踪的项的名称 |
|
| 命名空间是您跟踪的事情的位置 |
|
| Resource 是您要跟踪的事情的资源类型 |
18.20.2. API 端点 复制链接链接已复制到粘贴板!
可用的 API 端点如下:
/apis/operator.openshift.io/v1/networks
-
DELETE
:删除网络的集合 -
GET
: 列出网络类型的对象 -
POST
:创建网络
-
/apis/operator.openshift.io/v1/networks/{name}
-
DELETE
:删除网络 -
GET
:读取指定的网络 -
PATCH
:部分更新指定的网络 -
PUT
:替换指定的网络
-
18.20.2.1. /apis/operator.openshift.io/v1/networks 复制链接链接已复制到粘贴板!
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出被用户友善。 |
- HTTP 方法
-
DELETE
- 描述
- 删除网络集合
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
|
| 观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
GET
- 描述
- 列出网络类型的对象
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
|
| 观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
POST
- 描述
- 创建网络
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
参数 | 类型 | 描述 |
---|---|---|
|
| 网络的名称 |
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出被用户友善。 |
- HTTP 方法
-
DELETE
- 描述
- 删除网络
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| 应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值是 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。 |
|
| 弃用:请使用 PropagationPolicy,此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false,"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置两者。 |
|
| 是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置,但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为: 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系; 'Foreground' - 一个删除前台所有依赖的级联策略。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
GET
- 描述
- 读取指定的网络
参数 | 类型 | 描述 |
---|---|---|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH
- 描述
- 部分更新指定的网络
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
PUT
- 描述
- 替换指定的网络
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
|