Skip to main content
版本：v2.0

Kubectl Plugin

Kruise-tools 为 Kruise 的功能提供了一系列命令行工具，包括 kubectl-kruise，它的是 kubectl 的标准插件。

安装​

Install via Krew​

  1. Krew 是一个 kubectl 的插件，krew 本身可以自举安装和升级。 首先, 安装 krew。

  2. 执行 kubectl krew install kruise 来安装 kruise 插件。

  3. 你可以通过 kubectl-kruise 或 kubectl kruise 来使用。

$ kubectl-kruise --help

# or
$ kubectl kruise --help

Install manually​

  1. 你可以从 releases 页面下载二进制文件，目前提供 linux、darwin（OS X）、windows 系统以及 x86_64、arm64 架构。如果你在使用其他的操作系统或架构，需要下载 kruise-tools 源码并通过 make build 打包。

  2. 解压缩，并移动到系统 PATH 路径中。

$ tar xvf kubectl-kruise-darwin-amd64.tar.gz
$ mv darwin-amd64/kubectl-kruise /usr/local/bin/
  1. 你可以通过 kubectl-kruise 或 kubectl kruise 命令来使用。
$ kubectl-kruise --help

# or
$ kubectl kruise --help

升级插件​

通过 Krew 升级​

执行 kubectl krew upgrade kruise 即可升级插件。

手动升级​

手动升级的方式与安装过程一致。

Usage​

expose​

根据一个 workload（如 Deployment、CloneSet）、Service 或 Pod 来生成一个新的 service 对象。

$ kubectl kruise expose cloneset nginx --port=80 --target-port=8000

scale​

为 workload（如 Deployment, ReplicaSet, CloneSet, or Advanced StatefulSet） 设置新的副本数。

$ kubectl kruise scale --replicas=3 cloneset nginx

它的效果与 kubectl scale --replicas=3 cloneset nginx 相同，即原生 kubectl scale 也适用。

rollout​

管理 rollout 资源。此命令提供对 Kruise Rollout 对象的深入检查和控制。

可用命令：

  • approve: 手动将 Rollout 推进到下一步。当 rollout 因手动验证而暂停时，此命令表示金丝雀版本已通过验证，可以进行全面 rollout。
  • undo: 将工作负载回滚到其先前版本。这是一个关键命令，可在发现新版本不稳定或有错误时快速恢复部署。
  • history: 查看工作负载的修订历史。
  • pause: 暂停一个 Rollout。
  • resume: 恢复暂停的 Rollout。
  • restart: 重启一个 Rollout。
  • status: 显示 Rollout 的状态。

使用示例：

$ kubectl kruise rollout undo cloneset/nginx

# 内建 statefulsets
$ kubectl kruise rollout status statefulsets/sts1

# kruise statefulsets
$ kubectl kruise rollout status statefulsets.apps.kruise.io/sts2

# 批准在 "ns-demo" 命名空间中名为 "rollout-demo" 的 kruise rollout 资源
$ kubectl-kruise rollout approve rollout-demo -n ns-demo

describe​

对 Rollout 资源进行深入检查，包括其步骤状态、历史记录、条件和最近事件。

# 检查 default 命名空间中的 "rollouts-demo" Rollout:
kubectl kruise describe rollout rollouts-demo -n default

set​

可用的子命令: env, image, resources, selector, serviceaccount, subject。

$ kubectl kruise set env cloneset/nginx STORAGE_DIR=/local

$ kubectl kruise set image cloneset/nginx busybox=busybox nginx=nginx:1.9.1

exec​

通过 exec 命令直接进入到 Pod 的 sidecar 中。

# exec sidecar in pod
$ kubectl kruise exec mypod -S sidecar-container -i -t -- bash

migrate​

目前支持从 Deployment 迁移到 CloneSet。

# Create an empty CloneSet from an existing Deployment.
$ kubectl kruise migrate CloneSet --from Deployment -n default --dst-name deployment-name --create

# Create a same replicas CloneSet from an existing Deployment.
$ kubectl kruise migrate CloneSet --from Deployment -n default --dst-name deployment-name --create --copy

# Migrate replicas from an existing Deployment to an existing CloneSet.
$ kubectl-kruise migrate CloneSet --from Deployment -n default --src-name cloneset-name --dst-name deployment-name --replicas 10 --max-surge=2

scaledown​

对 cloneset 指定 pod 缩容。

# Scale down 2 with  selective pods
$ kubectl kruise scaledown cloneset/nginx --pods pod-a,pod-b

它会将 cloneset 设置 replicas=replicas-2，并删除指定的两个 pod。