diff --git a/content/en/docs/installing-on-linux/introduction/vars.md b/content/en/docs/installing-on-linux/introduction/vars.md index 6a55fe017..5174c9709 100644 --- a/content/en/docs/installing-on-linux/introduction/vars.md +++ b/content/en/docs/installing-on-linux/introduction/vars.md @@ -1,35 +1,125 @@ --- title: "Kubernetes Cluster Configurations" -keywords: 'KubeSphere, Kubernetes, docker, cluster, configuration' +keywords: 'Kubernetes, cluster, configuration, KubeKey' description: 'Customize your Kubernetes settings in the configuration file for your cluster.' linkTitle: "Kubernetes Cluster Configurations" weight: 3160 --- -This tutorial explains how to customize Kubernetes cluster configurations in `config-sample.yaml` (needed for [Multi-node Installation](../multioverview/)) when you use [KubeKey](https://github.com/kubesphere/kubekey) to provision a cluster. You can refer to the following section to understand each parameter. +When creating a Kubernetes cluster, you can use [KubeKey](../kubekey/) to define a configuration file (`config-sample.yaml`) which contains basic information of your cluster. Refer to the following example for Kubernetes-related parameters in the configuration file. ```yaml -######################### Kubernetes ######################### - -kubernetes: - version: v1.17.9 # The default k8s version is v1.17.9; you can specify 1.15.2, v1.16.13 or v1.18.6 based on your needs. - imageRepo: kubesphere # DockerHub Repo - clusterName: cluster.local # Kubernetes Cluster Name - masqueradeAll: false # masqueradeAll tells kube-proxy to SNAT everything if using the pure iptables proxy mode. [Default: false] - maxPods: 110 # maxPods is the number of pods that can run on this Kubelet. [Default: 110] - nodeCidrMaskSize: 24 # Internal network node size allocation. This is the size allocated to each node in your network. [Default: 24] - proxyMode: ipvs # The mode specifies which proxy mode to use. [Default: ipvs] + kubernetes: + version: v1.19.8 + imageRepo: kubesphere + clusterName: cluster.local + masqueradeAll: false + maxPods: 110 + nodeCidrMaskSize: 24 + proxyMode: ipvs network: - plugin: calico # Calico by default. KubeSphere Network Policy is based on Calico. You can also specify Flannel based on your needs. + plugin: calico calico: - ipipMode: Always # IPIP Mode to use for the IPv4 POOL created at start up. If it is set to a value other than Never, vxlanMode should be set to "Never". [Always | CrossSubnet | Never] [Default: Always] - vxlanMode: Never # VXLAN Mode to use for the IPv4 POOL created at start up. If it is set to a value other than Never, ipipMode should be set to "Never". [Always | CrossSubnet | Never] [Default: Never] - vethMTU: 1440 # The maximum transmission unit (MTU) setting determines the largest packet size that can be transmitted through your network. [Default: 1440] - kubePodsCIDR: 10.233.64.0/18 # A valid CIDR range for Kubernetes pod subnet. It should not overlap with node subnet, and it should not overlap with Kubernetes services subnet. - kubeServiceCIDR: 10.233.0.0/18 # A valid CIDR range for Kubernetes services. It should not overlap with node subnet, and it should not overlap with Kubernetes pod subnet. + ipipMode: Always + vxlanMode: Never + vethMTU: 1440 + kubePodsCIDR: 10.233.64.0/18 + kubeServiceCIDR: 10.233.0.0/18 registry: - registryMirrors: [] # For users who need to speed up downloads. - insecureRegistries: [] # Set an address of insecure image registry. See https://docs.docker.com/registry/insecure/ - privateRegistry: "" # Configure a private image registry for air-gapped installation (e.g. docker local registry or Harbor). - addons: [] # You can specify any add-ons with one or more Helm Charts or YAML files in this field (e.g. CSI plugins or cloud provider plugins). + registryMirrors: [] + insecureRegistries: [] + privateRegistry: "" + addons: [] ``` + +The below table describes the above parameters in detail. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
kubernetes
versionThe Kubernetes version to be installed. If you do not specify a Kubernetes version, {{< contentLink "docs/installing-on-linux/introduction/kubekey" "KubeKey" >}} v1.1.0 will install Kubernetes v1.19.8 by default. For more information, see {{< contentLink "docs/installing-on-linux/introduction/kubekey/#support-matrix" "Support Matrix" >}}.
imageRepoThe Docker Hub repository where images will be downloaded.
clusterNameThe Kubernetes cluster name.
masqueradeAll*masqueradeAll tells kube-proxy to SNAT everything if using the pure iptables proxy mode. It defaults to false.
maxPods*The maximum number of Pods that can run on this Kubelet. It defaults to 110.
nodeCidrMaskSize*The mask size for node CIDR in your cluster. It defaults to 24.
proxyMode*The proxy mode to use. It defaults to ipvs.
network
pluginThe CNI plugin to use. KubeKey installs Calico by default while you can also specify Flannel. Note that some features can only be used when Calico is adopted as the CNI plugin, such as Pod IP Pools.
calico.ipipMode*The IPIP Mode to use for the IPv4 POOL created at startup. If it is set to a value other than Never, vxlanMode should be set to Never. Allowed values are Always, CrossSubnet and Never. It defaults to Always.
calico.vxlanMode*The VXLAN Mode to use for the IPv4 POOL created at startup. If it is set to a value other than Never, ipipMode should be set to Never. Allowed values are Always, CrossSubnet and Never. It defaults to Never.
calico.vethMTU*The maximum transmission unit (MTU) setting determines the largest packet size that can be transmitted through your network. It defaults to 1440.
kubePodsCIDRA valid CIDR block for your Kubernetes Pod subnet. It should not overlap with your node subnet and your Kubernetes Services subnet.
kubeServiceCIDRA valid CIDR block for your Kubernetes Services. It should not overlap with your node subnet and your Kubernetes Pod subnet.
registry
registryMirrorsConfigure a Docker registry mirror to speed up downloads. For more information, see {{< contentLink "https://docs.docker.com/registry/recipes/mirror/#configure-the-docker-daemon" "Configure the Docker daemon" >}}.
insecureRegistriesSet an address of insecure image registry. For more information, see {{< contentLink "https://docs.docker.com/registry/insecure/" "Test an insecure registry" >}}.
privateRegistry*Configure a private image registry for air-gapped installation (for example, a Docker local registry or Harbor). For more information, see {{< contentLink "docs/installing-on-linux/introduction/air-gapped-installation/" "Air-gapped Installation on Linux" >}}.
+ +{{< notice note >}} + +- \* By default, KubeKey does not define these parameters in the configuration file while you can manually add them and customize their values. +- `addons` is used to install cloud-native add-ons (YAML or Chart). For more information, see [this file](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/addons.md). +- This page only lists part of the parameters in the configuration file created by KubeKey. For more information about other parameters, see [this example file](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md). + +{{}} diff --git a/content/zh/docs/installing-on-linux/introduction/vars.md b/content/zh/docs/installing-on-linux/introduction/vars.md index cddaa0a36..f7514b578 100644 --- a/content/zh/docs/installing-on-linux/introduction/vars.md +++ b/content/zh/docs/installing-on-linux/introduction/vars.md @@ -1,36 +1,126 @@ --- title: "Kubernetes 集群配置" -keywords: 'KubeSphere, kubernetes, docker, 集群, jenkins, prometheus' -description: '在集群的配置文件中添加自定义设置。' - +keywords: 'Kubernetes, 集群, 配置, KubeKey' +description: '在集群的配置文件中设置 Kubernetes 自定义配置。' linkTitle: "Kubernetes 集群配置" weight: 3160 --- -本教程介绍使用 [KubeKey](https://github.com/kubesphere/kubekey) 安装集群时，如何在 `config-sample.yaml` 文件中配置 Kubernetes 集群参数（[多节点安装时](../multioverview/)需要此文件）。文件中每个参数的说明如下： +When creating a Kubernetes cluster, you can use [KubeKey](../kubekey/) to define a configuration file (`config-sample.yaml`) which contains basic information of your cluster. Refer to the following example for Kubernetes-related parameters in the configuration file. ```yaml -######################### Kubernetes ######################### - -kubernetes: - version: v1.17.9 # The default k8s version is v1.17.9, you can specify 1.15.2, v1.16.13, v1.18.6 as you want - imageRepo: kubesphere # DockerHub Repo - clusterName: cluster.local # Kubernetes Cluster Name - masqueradeAll: false # masqueradeAll tells kube-proxy to SNAT everything if using the pure iptables proxy mode. [Default: false] - maxPods: 110 # maxPods is the number of pods that can run on this Kubelet. [Default: 110] - nodeCidrMaskSize: 24 # internal network node size allocation. This is the size allocated to each node on your network. [Default: 24] - proxyMode: ipvs # mode specifies which proxy mode to use. [Default: ipvs] + kubernetes: + version: v1.19.8 + imageRepo: kubesphere + clusterName: cluster.local + masqueradeAll: false + maxPods: 110 + nodeCidrMaskSize: 24 + proxyMode: ipvs network: - plugin: calico # Calico by default, KubeSphere Network Policy is based on Calico. You can also specify Flannel as you want + plugin: calico calico: - ipipMode: Always # IPIP Mode to use for the IPv4 POOL created at start up. If set to a value other than Never, vxlanMode should be set to "Never". [Always | CrossSubnet | Never] [Default: Always] - vxlanMode: Never # VXLAN Mode to use for the IPv4 POOL created at start up. If set to a value other than Never, ipipMode should be set to "Never". [Always | CrossSubnet | Never] [Default: Never] - vethMTU: 1440 # The maximum transmission unit (MTU) setting determines the largest packet size that can be transmitted through your network. [Default: 1440] - kubePodsCIDR: 10.233.64.0/18 # A valid CIDR range for Kubernetes pod subnet, it should not overlap with node subnet, and it should not overlap with Kubernetes services subnet. - kubeServiceCIDR: 10.233.0.0/18 # A valid CIDR range for Kubernetes services, it should not overlap with node subnet, and it should not overlap with Kubernetes pod subnet + ipipMode: Always + vxlanMode: Never + vethMTU: 1440 + kubePodsCIDR: 10.233.64.0/18 + kubeServiceCIDR: 10.233.0.0/18 registry: - registryMirrors: [] # For users who need to accelerate image download speed - insecureRegistries: [] # Configure an address of Insecure image Registry, see https://docs.docker.com/registry/insecure/ - privateRegistry: "" # Configure a private image registry for air-gapped installation (e.g. docker local registry or Harbor) - addons: [] # You can specify any add-ons with one or more Helm Charts or YAML files in this field, e.g. CSI plugins or cloud provider plugins. + registryMirrors: [] + insecureRegistries: [] + privateRegistry: "" + addons: [] ``` + +The below table describes the above parameters in detail. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
kubernetes
versionThe Kubernetes version to be installed. If you do not specify a Kubernetes version, {{< contentLink "docs/installing-on-linux/introduction/kubekey" "KubeKey" >}} v1.1.0 will install Kubernetes v1.19.8 by default. For more information, see {{< contentLink "docs/installing-on-linux/introduction/kubekey/#support-matrix" "Support Matrix" >}}.
imageRepoThe Docker Hub repository where images will be downloaded.
clusterNameThe Kubernetes cluster name.
masqueradeAll*masqueradeAll tells kube-proxy to SNAT everything if using the pure iptables proxy mode. It defaults to false.
maxPods*The maximum number of Pods that can run on this Kubelet. It defaults to 110.
nodeCidrMaskSize*The mask size for node CIDR in your cluster. It defaults to 24.
proxyMode*The proxy mode to use. It defaults to ipvs.
network
pluginThe CNI plugin to use. KubeKey installs Calico by default while you can also specify Flannel. Note that some features can only be used when Calico is adopted as the CNI plugin, such as Pod IP Pools.
calico.ipipMode*The IPIP Mode to use for the IPv4 POOL created at startup. If it is set to a value other than Never, vxlanMode should be set to Never. Allowed values are Always, CrossSubnet and Never. It defaults to Always.
calico.vxlanMode*The VXLAN Mode to use for the IPv4 POOL created at startup. If it is set to a value other than Never, ipipMode should be set to Never. Allowed values are Always, CrossSubnet and Never. It defaults to Never.
calico.vethMTU*The maximum transmission unit (MTU) setting determines the largest packet size that can be transmitted through your network. It defaults to 1440.
kubePodsCIDRA valid CIDR block for your Kubernetes Pod subnet. It should not overlap with your node subnet and your Kubernetes Services subnet.
kubeServiceCIDRA valid CIDR block for your Kubernetes Services. It should not overlap with your node subnet and your Kubernetes Pod subnet.
registry
registryMirrorsConfigure a Docker registry mirror to speed up downloads. For more information, see {{< contentLink "https://docs.docker.com/registry/recipes/mirror/#configure-the-docker-daemon" "Configure the Docker daemon" >}}.
insecureRegistriesSet an address of insecure image registry. For more information, see {{< contentLink "https://docs.docker.com/registry/insecure/" "Test an insecure registry" >}}.
privateRegistry*Configure a private image registry for air-gapped installation (for example, a Docker local registry or Harbor). For more information, see {{< contentLink "docs/installing-on-linux/introduction/air-gapped-installation/" "Air-gapped Installation on Linux" >}}.
+ + +{{< notice note >}} + +- \* By default, KubeKey does not define these parameters in the configuration file while you can manually add them and customize their values. +- `addons` is used to install cloud-native add-ons (YAML or Chart). For more information, see [this file](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/addons.md). +- This page only lists part of the parameters in the configuration file created by KubeKey. For more information about other parameters, see [this example file](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md). + +{{}}