title: 创建Google集群 description: 本文介绍了如何在 Google GCE 中创建和初始化 K3s 集群，以及为已有的 K3s 集群添加节点的操作步骤。 keywords:

  • k3s中文文档
  • k3s 中文文档
  • k3s中文
  • k3s 中文
  • k3s
  • k3s教程
  • k3s中国
  • rancher
  • k3s 中文教程
  • AutoK3s
  • 创建Google集群

概述

本文介绍了如何在 Google GCE 中创建和初始化 K3s 集群，以及为已有的 K3s 集群添加节点的操作步骤。除此之外，本文还提供了在 Google GCE 上运行 AutoK3s 的进阶操作指导，如配置私有镜像仓库和启用 UI 组件。

前置要求

设置 Service Account

关于 Service Account 的描述，请参考Google 官方文档。

您的账号需要创建 GCE 及相关资源的权限，需要配置对应项目以及计算资源的权限。

设置安全组

EC2 实例至少需要应用以下安全组规则：

  1. Rule        Protocol    Port      Source             Description
  2. InBound     TCP         22        ALL                SSH Connect Port
  3. InBound     TCP         6443      K3s agent nodes    Kubernetes API
  4. InBound     TCP         10250     K3s server & agent Kubelet
  5. InBound     UDP         8472      K3s server & agent (Optional) Required only for Flannel VXLAN
  6. InBound     TCP         2379,2380 K3s server nodes   (Optional) Required only for embedded ETCD
  7. OutBound    ALL         ALL       ALL                Allow All

UI 使用说明

接下来我们将基于 AutoK3s 本地 UI 介绍如何使用 AutoK3s 工具，在 GCE 主机上创建和管理 K3s 集群。如果您想了解 CLI 的使用，请移步到 CLI 使用说明

您可以通过快速体验中的描述，通过 Docker 或者 CLI 启动本地 UI，打开浏览器，访问目标端口 8080 即可。

快速创建集群

您可以使用快速创建功能，在指定的云提供商服务中，快速启动一个K3s集群。

以下图为例，我们将在 GCE 使用默认配置创建一个单节点的 K3s 集群，GCE 虚拟机会在 us-central1 区域中创建。

- 创建Google集群 - 图1

表 1：快速创建参数

参数 说明 默认值
Provider 云提供商名称 google
Name K3s集群名称
Master Master 节点数量 1
Worker Worker 节点数量 0
Service Account Google 服务账号名称（email address)
Service Account File Google 服务账号私钥JSON文件
Project GCE project名称
Region 虚拟机所在的区域（在快速创建页面不允许编辑默认区域，您可以通过模板功能修改默认参数配置） us-central1
Zone 虚拟机所在的地区 us-central1-b

自定义参数创建

如果您不想使用默认的配置，可以点击 Advance 按钮，进入自定义参数页面进行更多参数的设置。 或者您可以在集群列表页点击 Create 按钮进入自定义参数页面进行更多参数的设置。

使用 Google 云提供商创建 K3s 集群的自定义参数配置分为四项，云供应商访问凭证、云提供商对应实例配置、K3s集群配置、高级选项。接下来对每个配置项进行详细说明。

云提供商访问凭证

- 创建Google集群 - 图2

表 2：云提供商访问凭证参数

参数 说明
Provider 云提供商名称
Name K3s集群名称
Service Account Google 服务账号名称（email address)
Secret Key Google 服务账号私钥JSON文件

实例配置

实例配置主要配置的内容为对应云提供商虚拟机的配置，例如实例运行区域、地区、使用的操作系统类型、实例规格、网络配置等信息。

- 创建Google集群 - 图3

表 3：实例配置参数

参数 说明 默认值
Project Google project名称
Region GCE 区域 us-central1
Zone GCE 地区 us-central1-b
Machine Type GCE 实例规格 n1-standard-1(1vCPU/3.75GiB)
Machine Image GCE 系统映像 ubuntu-os-cloud/global/images/ubuntu-1804-bionic-v20210514(Ubuntu 18.04)
Disk Type 磁盘卷类型 pd-standard
Disk Size 磁盘卷大小 10(GiB)
Scopes 访问范围 https://www.googleapis.com/auth/devstorage.read_only,https://www.googleapis.com/auth/logging.write,https://www.googleapis.com/auth/monitoring.write
Preemptible 是否请求抢占式实例 false
Network GCE使用的网络接口(如果您不设置，AutoK3s 将使用default作为网络接口)
Subnetwork 子网接口(如果您不设置，AutoK3s 将使用默认的子网)
Use Internal IP Only 仅使用私有IP false
Open Ports 安全组额外开放端口(如果您不额外设置ports，AutoK3s 将默认开放默认的安全组相关端口)
SSH User SSH 用户 autok3s
SSH Port SSH 端口 22
SSH Key Path 如果您选择了已有的密钥对，需要指定SSH 私钥目录，如果您使用AutoK3s 自动生成的密钥，这里可以不填写任何内容
SSH Key Passphrase 如果您的私钥需要密码验证，请在这里输入密码
SSH Password 如果您使用Password连接到虚拟机，请输入密码
SSH Agent Auth 如果您配置 SSH 代理程序，可以开启此项配置 false
SSH Cert Path 如果您配置了 ssh certificate，在这里您需要将 certificate path 传入进来，以保证 AutoK3s 可以通过ssh连接到远程虚拟机
Tags 虚拟机标签

K3s 参数配置

K3s 参数配置项主要对 K3s 集群进行设置，例如是否部署 HA 模式、K3s 安装版本等。

- 创建Google集群 - 图4

表 4：K3s 配置参数

参数 说明 默认值
K3s Channel 用于获取 K3s 下载 URL 的通道。选项包括：stable, latest, testing。 stable
K3s Version 安装的 K3s 版本，如果设置则覆盖 Channel 选项
Cluster 启用嵌入式 DB 高可用 K3s（即开启 --cluster-init 设置） false
Datastore 指定 etcd、Mysql、Postgres 或 Sqlite（默认）数据源名称
K3s Install Script K3s 安装脚本，对于中国区用户，可以通过下拉菜单选择 rancher-mirror 脚本来安装 https://get.k3s.io
Master Master 节点数量
Master Extra Args Master 节点额外参数设置，例如 --no-deploy traefik
Worker Worker 节点数量
Worker Extra Args Worker 节点额外参数设置，例如 --node-taint key=value:NoExecute
Token 用于将server或agent加入集群的共享secret，如果不设置，会自动生成一个Token
Manifests 自动部署应用清单目录，这里支持设置某个manifest文件或者包含多个manifest文件的目录路径（仅支持一层目录），具体功能可查看这里
TLS Sans 在 TLS 证书中添加其他主机名或 IP 作为主题备用名称，具体功能可查看这里
Registry 私有镜像仓库配置

高级选项

配置要开启的 UI 组件（kubernetes-dashboard/kube-explorer）。

- 创建Google集群 - 图5

表 4：高级选项

参数 说明 默认值
UI 开启的 UI 组件（Kubernetes Dashboard/kube-explorer）

集群模板

您可以使用模板功能，提前预置好常用的集群模板，每次创建集群时可以用模板参数进行填充，极大精简了重复操作。一次编写，多次运行，提升效率。

创建集群模板的参数与上面描述的自定义参数创建集群的表单内容相同，在这里不做赘述。

- 创建Google集群 - 图6

您可以选择最常用的模板，点击右侧下拉框中的 Set Default 按钮，将模板设置为默认模板。

- 创建Google集群 - 图7

设置为默认模板后，您可以通过快速创建功能一键部署常用配置的 K3s 集群。

- 创建Google集群 - 图8

如果您想使用其他模板创建集群，您还可以在快速创建页面的右上角，或者在自定义创建集群的右上角筛选模板，点击 Fill Form 按钮后，会自动根据模板内容填充表单。

- 创建Google集群 - 图9

集群管理

您可以在集群列表页查看和管理使用 AutoK3s 创建的 K3s 集群。

添加节点

选中您要添加节点的集群，点击右侧下拉菜单中的 Join Node 按钮，在弹出的窗口中设置要添加的节点数量即可。

- 创建Google集群 - 图10

Kubectl

如果您想操作 K3s 集群数据，可以点击右上角 Launch Kubectl 按钮，在下拉框中选择要操作的集群后，便可以在 UI 控制台操作选中的集群了。

- 创建Google集群 - 图11

SSH

如果您想连接到远程主机进行操作，您可以在集群列表页面点击集群名称，进入详情页面，选择要连接的主机，点击右侧 Execute Shell 按钮。

- 创建Google集群 - 图12

开启 kube-explorer dashboard

您可以在创建集群时，通过 Additional Options 选择 explorer 选项开启 kube-explorer 功能。

- 创建Google集群 - 图13

也可以通过右侧下拉菜单中选择 Enable Explorer 功能来开启 kube-explorer。

- 创建Google集群 - 图14

开启后，在集群列表会增加 dashboard 跳转链接按钮，点击跳转链接便可以访问 kube-explorer dashboard 页面了。

- 创建Google集群 - 图15

关闭 kube-explorer dashboard

对于已经开启了 kube-explorer 功能的集群，可以在右侧下拉菜单中选择 Disable Explorer 功能来关闭 kube-explorer 服务。

- 创建Google集群 - 图16

CLI 使用说明

在使用命令之前，您需要设置服务账号信息。

  1. export GOOGLE_SERVICE_ACCOUNT_FILE='<service-account-file-path>'
  2. export GOOGLE_SERVICE_ACCOUNT='<service-account-name>'

如想了解更多参数，请运行autok3s <sub-command> --provider google --help命令。

创建普通集群

运行以下命令，在 GCE 上创建并启动创建一个名为 “myk3s”的集群，并为该集群配置 1 个 master 节点和 1 个 worker 节点。

  1. autok3s -d create -p google --name myk3s --master 1 --worker 1

创建高可用 K3s 集群

创建高可用集群的命令分为两种，取决于您选择使用的是内置的 etcd 还是外部数据库。

嵌入式 etcd（k3s 版本 >= 1.19.1-k3s1)

运行以下命令，在 GCE 上创建并启动创建了一个名为“myk3s”，包含 3 个 master 节点的高可用 K3s 集群。

  1. autok3s -d create -p google --name myk3s --master 3 --cluster

外部数据库

在高可用模式下使用外部数据库，需要满足两个条件：

  • master 节点的数量不小于 1。
  • 需要提供外部数据库的存储路径。

所以在以下的代码示例中，我们通过--master 2指定 master 节点数量为 2，满足 master 节点的数量不小于 1 这个条件；且通过--datastore "PATH"指定外部数据库的存储路径，提供外部数据库的存储路径。

运行以下命令，在 GCE 上创建并启动创建了一个名为“myk3s”，包含 2 个master 节点的高可用 K3s 集群：

  1. autok3s -d create -p google --name myk3s --master 2 --datastore "mysql://<user>:<password>@tcp(<ip>:<port>)/<db>"

添加 K3s 节点

请使用autok3s join命令为已有集群添加 K3s 节点。

普通集群

运行以下命令，为“myk3s”集群添加 1 个 worker 节点。

  1. autok3s -d join --provider google --name myk3s --worker 1

高可用 K3s 集群

  1. autok3s -d join --provider google --name myk3s --master 2 --worker 1

删除 K3s 集群

删除一个 k3s 集群，这里删除的集群为 myk3s。

  1. autok3s -d delete --provider google --name myk3s

查看集群列表

显示当前主机上管理的所有 K3s 集群列表。

  1. autok3s list
  1. NAME         REGION      PROVIDER  STATUS   MASTERS  WORKERS    VERSION
  2. myk3s    asia-northeast1  google   Running  1        0        v1.20.2+k3s1

查看集群详细信息

显示具体的 K3s 信息，包括实例状态、主机 ip、集群版本等信息。

  1. autok3s describe -n <clusterName> -p google

注意：如果使用不同的 provider 创建的集群名称相同，describe 时会显示多个集群信息，可以使用-p <provider>对 provider 进一步过滤。例如：autok3s describe -n myk3s -p google。

  1. Name: myk3s
  2. Provider: google
  3. Region: asia-northeast1
  4. Zone: asia-northeast1-b
  5. Master: 1
  6. Worker: 0
  7. Status: Running
  8. Version: v1.20.2+k3s1
  9. Nodes:
  10.   - internal-ip: [x.x.x.x]
  11.     external-ip: [x.x.x.x]
  12.     instance-status: RUNNING
  13.     instance-id: xxxxxxxx
  14.     roles: control-plane,master
  15.     status: Ready
  16.     hostname: xxxxxxxx
  17.     container-runtime: containerd://1.4.3-k3s1
  18.     version: v1.20.2+k3s1

Kubectl

群创建完成后, autok3s 会自动合并 kubeconfig 文件。

  1. autok3s kubectl config use-context myk3s.asia-northeast1.google
  2. autok3s kubectl <sub-commands> <flags>

在多个集群的场景下，可以通过切换上下文来完成对不同集群的访问。

  1. autok3s kubectl config get-contexts
  2. autok3s kubectl config use-context <context>

SSH

SSH 连接到集群中的某个主机，这里选择的集群为 myk3s。

  1. autok3s ssh --provider google --name myk3s

进阶使用

AutoK3s 集成了一些与当前 provider 有关的高级组件，例如私有镜像仓库和 UI。

配置私有镜像仓库

在运行autok3s create或autok3s join时，通过传递--registry /etc/autok3s/registries.yaml以使用私有镜像仓库，例如：

  1. autok3s -d create \
  2.     --provider google \
  3.     --name myk3s \
  4.     --master 1 \
  5.     --worker 1 \
  6.     --registry /etc/autok3s/registries.yaml

使用私有镜像仓库的配置请参考以下内容，如果您的私有镜像仓库需要 TLS 认证，autok3s会从本地读取相关的 TLS 文件并自动上传到远程服务器中完成配置，您只需要完善registry.yaml即可。

  1. mirrors:
  2.   docker.io:
  3.     endpoint:
  4.       - "https://mycustomreg.com:5000"
  5. configs:
  6.   "mycustomreg:5000":
  7.     auth:
  8.       username: xxxxxx # this is the registry username
  9.       password: xxxxxx # this is the registry password
  10.     tls:
  11.       cert_file: # path to the cert file used in the registry
  12.       key_file:  # path to the key file used in the registry
  13.       ca_file:   # path to the ca file used in the registry

启用 UI 组件

AutoK3s 支持两种 UI 组件，包括 kubernetes-dashboard 和 kube-explorer

开启 kubernetes dashboard
  1. autok3s -d create -p google \
  2.     ... \
  3.     --enable dashboard

访问 Token 等设置请参考 此文档 。

开启 kube-explorer
  1. autok3s explorer --context <context> --port 9999

您可以通过 http://127.0.0.1:9999 访问 kube-explorer dashboard 页面。