RKE集群参数

使用 RKE 启动的集群时，您可以选择自定义 Kubernetes 选项，通过 Rancher UI 或集群配置文件配置 Kubernetes 选项。

  • Rancher UI：通过 Rancher UI 设置 Kubernetes 集群的通用自定义的选项。
  • 集群配置文件：除了 Rancher UI 之外，高级用户还可以通过 RKE 配置文件，在 YAML 中指定 RKE 安装中可用的任何选项，system_images参数除外。

在 v2.0.0 至 v2.2.x 版本中，Rancher 用于配置集群的配置文件与 Rancher Kubernetes Engine 的集群配置文件相同。

在 v2.3.0 和更新的版本中，RKE 信息与其他选项的层级是分开的，因此，高级用户使用方法 2 在 v2.3.0 和更新版本的 Rancher 配置中 RKE 集群参数时，应在rancher_kubernetes_engine_config参数下修改配置 RKE 集群参数。详情请参考集群配置文件

Rancher UI

创建 RKE 集群时，您可以使用集群选项部分配置基本的 Kubernetes 选项。

Kubernetes 版本

安装在集群节点上的 Kubernetes 版本。Rancher 基于原生的 Kubernetes Hyperkube 打包自己的 Kubernetes 版本。

网络插件

集群使用的网络插件。有关不同网络提供商的更多详细信息，请查看我们的网络常见问题解答。

重要

启动集群后，您无法更改网络插件，请谨慎选择要使用的网络插件。Kubernetes 不支持切换网络插件。创建集群后，如果您需要更改网络插件，只能删除整个集群及其所有应用程序，重新创建集群和配置网络插件。

开箱即用，Rancher 与以下网络插件兼容：

Canal 注意事项：

在 v2.0.0-v2.0.4 和 v2.0.6 中，使用 Canal 时，默认的集群网络隔离选项是开启的阻止了项目之间的 Pod 通过 Pod IP 直接通信。

从 v2.0.7 开始，如果您使用 Canal，您还可以选择使用网络隔离，自行决定项目中的 Pod 是否可以通过 Pod IP 直接通信。

Rancher v2.0.0 - v2.0.6 请用户注意：

  • 在以前的 Rancher 版本中，Canal 隔离了项目网络通信，而且没有禁用它的选项。如果您正在使用这些 Rancher 版本，请注意，使用 Canal 会阻止不同项目中的 Pod 之间通过 Pod Ip 的所有通信。
  • 如果您有使用 Canal 的集群并且要升级到 v2.0.7，则这些集群默认情况下会启用项目网络隔离。如果要禁用项目网络隔离，请编辑集群并禁用该选项。

Flannel 注意事项：

Flannel 是 Rancher v2.0.5 默认使用的网络插件，不会阻止项目之间的网络通信。

Weave 注意事项：

当 Weave 被选为网络插件时，Rancher 将通过生成随机密码自动启用加密。如果要手动指定密码，请参考如何使用RKE 配置文件和Weave 网络插件选项配置集群。

Kubernetes Cloud Provider

您可以配置Kubernetes Cloud Provider。如果您想要在 Kubernetes 中使用卷和存储, 通常，您必须选择特定的 Cloud Provider 才能使用它。例如，如果您想使用 Amazon EBS，则需要选择 aws Cloud Provider。

注意： 如果您要使用的 Cloud Provider 不在 UI 的选项，则需要使用 RKE 配置文件来配置 Cloud Provider。请参考 RKE Cloud Provider 文档了解如何配置 Cloud Provider。

如果要查看集群的所有配置选项，请单击右下角的显示高级选项。高级选项如下所述：

私有镜像仓库

v2.2.0 可用

集群级别的私有镜像仓库配置仅用于启动集群。

在 Rancher 中设置私有镜像仓库的主要方法有两种：通过全局视图中的设置选项卡设置全局默认镜像仓库，以及通过集群级别设置中的高级选项设置私有镜像仓库。全局默认镜像仓库旨在用于不需要登录认证的镜像仓库的离线安装。集群级别的私有镜像仓库旨在用于所有需要登录认证的私有镜像仓库。

如果您的私有镜像仓库需要登录认证，则需要通过编辑从镜像仓库中提取镜像的每个集群的集群选项，并将登录认证信息传递给 Rancher。

私有镜像仓库配置选项告诉 Rancher 从哪里拉取集群中使用的系统镜像和插件镜像。

  • 系统镜像 是维护 Kubernetes 集群所需的组件。
  • 插件镜像 用于部署多个集群组件包括网络插件、ingress 控制器、DNS 插件或 metrics-server。

请参阅 RKE 有关私有镜像仓库文档了解配置集群组件过程中关于私有镜像仓库的更多信息。

授权集群访问地址

v2.2.0 可用

授权集群端点可用于直接访问 Kubernetes API Server，无需通过 Rancher 进行通信。

授权的集群端点仅适用于 Rancher 启动的 Kubernetes 集群。换句话说，它只适用于 Rancher 使用 RKE来配置集群的集群。它不适用于托管的 Kubernetes 集群，例如 Amazon 的 EKS。

授权集群端点仅在 Rancher 使用 RKE配置的集群中可用。它不适用于托管的 Kubernetes 供应商的集群，如亚马逊的 EKS。此外，授权集群端点不能对导入 Rancher 的 RKE 集群启用；它只对 Rancher 启动的 Kubernetes 集群可用。

这在 Rancher 启动的 Kubernetes 集群中默认启用，使用具有controlplane 角色的节点的 IP 和默认的 Kubernetes 自签名证书。

有关授权的集群端点如何工作以及使用它的原因的更多详细信息，请参阅产品架构。

我们建议将负载均衡器与授权的集群端点一起使用。有关详细信息，请参阅推荐架构。

节点池

有关使用 Rancher UI 在 RKE 集群中设置节点池的信息，请参阅 本页。。

高级选项

在 Rancher UI 中创建集群时，可以配置以下高级选项。

NGINX Ingress

启用或禁用 NGINX ingress 控制器的选项。

Node Port 范围

更改可用于节点端口服务的端口范围的选项默认值为30000-32767。

监控指标

启用或禁用 metrics-server 的选项。

Pod 安全策略

启用并选择默认的Pod 安全策略的选项。必须先配置 Pod 安全策略，然后才能使用此选项。

节点 Docker 版本检查

要求在添加到集群的集群节点上安装受支持的 Docker 版本或允许在集群节点上安装不受支持的 Docker 版本。

Docker 根目录

如果要添加到集群的节点配置了非默认的 Docker 根目录（默认为/var/lib/docker），请在此选项中指定正确的 Docker 根目录。

定期的 etcd 快照

选项来启用或禁用定期的 etcd 快照。

集群配置文件

除了 Rancher UI 之外，高级用户还可以通过 RKE 配置文件，在 YAML 中指定 RKE 安装可用选项，system_images选项除外。

注意： 在 Rancher v2.0.5 和 v2.0.6 中，配置文件（YAML）中的服务名称应该只包含下划线：例如，kube_api和kube_controller。

  • 单击编辑 YAML，使用 Rancher UI 编辑 RKE 配置文件。
  • 单击从文件读取，从现有 RKE 文件读取 RKE 参数信息。

image

Rancher v2.0.0-v2.2.x 和 Rancher v2.3.0+ 配置文件的结构是不同的。以下是两者的配置文件示例。

Rancher v2.3.0+ 配置文件结构

RKE（Rancher Kubernetes Engine）是 Rancher 配置 Kubernetes 集群的工具。Rancher 的集群配置文件过去与RKE 配置文件具有相同的结构，但后来结构发生了变化，RKE 集群配置选项与非 RKE 配置选项分，集群的配置嵌套在集群配置文件中的rancher_kubernetes_engine_config参数下。使用早期版本的 Rancher 创建的集群配置文件将需要按照此格式更新。下面是一个新版集群配置文件示例。

  1. #
  3. ## Cluster Config
  5. #
  7. docker_root_dir: /var/lib/docker
  9. enable_cluster_alerting: false
  11. enable_cluster_monitoring: false
  13. enable_network_policy: false
  15. local_cluster_auth_endpoint:
  17.   enabled: true
  19. #
  21. ## Rancher Config
  23. #
  25. rancher_kubernetes_engine_config: # Your RKE template config goes here.
  27.   addon_job_timeout: 30
  29.   authentication:
  31.     strategy: x509
  33.   ignore_docker_version: true
  35.   #
  37.   ## # Currently only nginx ingress provider is supported.
  39.   ## # To disable ingress controller, set `provider: none`
  41.   ## # To enable ingress on specific nodes, use the node_selector, eg:
  43.   ##    provider: nginx
  45.   ##    node_selector:
  47.   ##      app: ingress
  49.   #
  51.   ingress:
  53.     provider: nginx
  55.   kubernetes_version: v1.15.3-rancher3-1
  57.   monitoring:
  59.     provider: metrics-server
  61.   #
  63.   ##   If you are using calico on AWS
  65.   #
  67.   ##    network:
  69.   ##      plugin: calico
  71.   ##      calico_network_provider:
  73.   ##        cloud_provider: aws
  75.   #
  77.   ## # To specify flannel interface
  79.   #
  81.   ##    network:
  83.   ##      plugin: flannel
  85.   ##      flannel_network_provider:
  87.   ##      iface: eth1
  89.   #
  91.   ## # To specify flannel interface for canal plugin
  93.   #
  95.   ##    network:
  97.   ##      plugin: canal
  99.   ##      canal_network_provider:
  101.   ##        iface: eth1
  103.   #
  105.   network:
  107.     options:
  109.       flannel_backend_type: vxlan
  111.     plugin: canal
  113.   #
  115.   ##    services:
  117.   ##      kube-api:
  119.   ##        service_cluster_ip_range: 10.43.0.0/16
  121.   ##      kube-controller:
  123.   ##        cluster_cidr: 10.42.0.0/16
  125.   ##        service_cluster_ip_range: 10.43.0.0/16
  127.   ##      kubelet:
  129.   ##        cluster_domain: cluster.local
  131.   ##        cluster_dns_server: 10.43.0.10
  133.   #
  135.   services:
  137.     etcd:
  139.       backup_config:
  141.         enabled: true
  143.         interval_hours: 12
  145.         retention: 6
  147.         safe_timestamp: false
  149.       creation: 12h
  151.       extra_args:
  153.         election-timeout: 5000
  155.         heartbeat-interval: 500
  157.       gid: 0
  159.       retention: 72h
  161.       snapshot: false
  163.       uid: 0
  165.     kube_api:
  167.       always_pull_images: false
  169.       pod_security_policy: false
  171.       service_node_port_range: 30000-32767
  173.   ssh_agent_auth: false
  175. windows_prefered_cluster: false

Rancher v2.0.0-v2.2.x 配置文件结构

以下是一个旧版本的集群配置文件示例。

  1. addon_job_timeout: 30
  3. authentication:
  5.   strategy: x509
  7. ignore_docker_version: true
  9. #
  11. ## # Currently only nginx ingress provider is supported.
  13. ## # To disable ingress controller, set `provider: none`
  15. ## # To enable ingress on specific nodes, use the node_selector, eg:
  17. ##    provider: nginx
  19. ##    node_selector:
  21. ##      app: ingress
  23. #
  25. ingress:
  27.   provider: nginx
  29. kubernetes_version: v1.15.3-rancher3-1
  31. monitoring:
  33.   provider: metrics-server
  35. #
  37. ##   If you are using calico on AWS
  39. #
  41. ##    network:
  43. ##      plugin: calico
  45. ##      calico_network_provider:
  47. ##        cloud_provider: aws
  49. #
  51. ## # To specify flannel interface
  53. #
  55. ##    network:
  57. ##      plugin: flannel
  59. ##      flannel_network_provider:
  61. ##      iface: eth1
  63. #
  65. ## # To specify flannel interface for canal plugin
  67. #
  69. ##    network:
  71. ##      plugin: canal
  73. ##      canal_network_provider:
  75. ##        iface: eth1
  77. #
  79. network:
  81.   options:
  83.     flannel_backend_type: vxlan
  85.   plugin: canal
  87. #
  89. ##    services:
  91. ##      kube-api:
  93. ##        service_cluster_ip_range: 10.43.0.0/16
  95. ##      kube-controller:
  97. ##        cluster_cidr: 10.42.0.0/16
  99. ##        service_cluster_ip_range: 10.43.0.0/16
  101. ##      kubelet:
  103. ##        cluster_domain: cluster.local
  105. ##        cluster_dns_server: 10.43.0.10
  107. #
  109. services:
  111.   etcd:
  113.     backup_config:
  115.       enabled: true
  117.       interval_hours: 12
  119.       retention: 6
  121.       safe_timestamp: false
  123.     creation: 12h
  125.     extra_args:
  127.       election-timeout: 5000
  129.       heartbeat-interval: 500
  131.     gid: 0
  133.     retention: 72h
  135.     snapshot: false
  137.     uid: 0
  139.   kube_api:
  141.     always_pull_images: false
  143.     pod_security_policy: false
  145.     service_node_port_range: 30000-32767
  147. ssh_agent_auth: false

默认 DNS 插件

下表显示了默认情况下部署的 DNS 插件。CoreDNS 只能在 Kubernetes v1.12.0 及更高版本上使用。

有关如何配置不同的 DNS 插件的详细信息，请参阅关于 DNS 插件的文档。

Rancher 版本Kubernetes 版本默认 DNS 插件
v2.2.5+v1.14.0+CoreDNS
v2.2.5+v1.13.x-kube-dns
v2.2.4-任何版本kube-dns

Rancher 特有选项

v2.2.0 可用

除了 RKE 配置文件选项之外，还有可以在配置文件（YAML）中配置 Rancher 的特有选项)：docker_root_dir、enable_cluster_monitoring、enable_network_policy和local_cluster_auth_endpoint。

docker_root_dir

参阅Docker 根目录。

enable_cluster_monitoring

启用或禁用集群监控选项。

enable_network_policy

启用或禁用项目网络隔离选项。

local_cluster_auth_endpoint

参考授权集群访问地址。

例子:

  1. local_cluster_auth_endpoint:
  3.   enabled: true
  5.   fqdn: "FQDN"
  7.   ca_certs: "BASE64_CACERT"

自定义网络插件

v2.2.4 可用

您可以使用 RKE 的用户定义附加功能添加自定义网络插件。您可以在部署 Kubernetes 集群后定义要部署的任何附加组件。

有两种方法可以指定附加组件:

有关如何通过编辑配置自定义网络插件的示例 cluster.yml，请参阅 RKE 文档。