Kubectl OpenAI 插件 ✨

本项目是一个 kubectl 插件，用于使用 OpenAI GPT 生成并应用 Kubernetes 清单文件。

我的主要动机是避免在开发或测试时手动查找和收集各种随机的清单文件。

演示

安装

Homebrew

添加到 brew tap 并安装：

brew tap sozercan/kubectl-ai https://github.com/sozercan/kubectl-ai
brew install kubectl-ai

Krew

添加到 krew 索引并安装：

kubectl krew index add kubectl-ai https://github.com/sozercan/kubectl-ai
kubectl krew install kubectl-ai/kubectl-ai

GitHub 发布

• 从 GitHub 发布页面 下载二进制文件。

• 如果您希望将其用作 kubectl 插件，请将 kubectl-ai 二进制文件复制到您的 PATH 中。否则，您也可以单独使用该二进制文件。

使用方法

前提条件

kubectl-ai 需要有效的 Kubernetes 配置，并且需要以下之一：

• OpenAI API 密钥
• Azure OpenAI 服务 的 API 密钥和端点
• 兼容 OpenAI API 的本地端点（例如 AIKit 或 LocalAI）

对于 OpenAI、Azure OpenAI 或兼容 OpenAI API 的端点，您可以使用以下环境变量：

export OPENAI_API_KEY=<您的 OpenAI 密钥>
export OPENAI_DEPLOYMENT_NAME=<您的 OpenAI 部署/模型名称，默认为 "gpt-3.5-turbo-0301">
export OPENAI_ENDPOINT=<您的 OpenAI 端点，例如 "https://my-aoi-endpoint.openai.azure.com" 或 "http://localhost:8080/v1">

如果设置了 OPENAI_ENDPOINT 变量，则会使用该端点；否则将使用 OpenAI API。

Azure OpenAI 服务不允许在部署名称中使用某些字符，例如 .。因此，kubectl-ai 会自动将 gpt-3.5-turbo 替换为 gpt-35-turbo 以适应 Azure。但是，如果您使用的 Azure OpenAI 部署名称与模型名称完全不同，可以设置 AZURE_OPENAI_MAP 环境变量来映射模型名称到 Azure OpenAI 部署名称。例如：

export AZURE_OPENAI_MAP="gpt-3.5-turbo=my-deployment"

设置一个本地兼容 OpenAI API 的端点

如果您没有 OpenAI API 访问权限，可以在本地机器上使用 AIKit 设置一个本地兼容 OpenAI API 的端点，无需任何 GPU！有关更多信息，请参阅 AIKit 文档。

docker run -d --rm -p 8080:8080 ghcr.io/sozercan/llama3.1:8b
export OPENAI_ENDPOINT="http://localhost:8080/v1"
export OPENAI_DEPLOYMENT_NAME="llama-3.1-8b-instruct"
export OPENAI_API_KEY="n/a"

按照上述方式设置环境后，您可以像往常一样使用 kubectl-ai。

标志和环境变量

• --require-confirmation 标志或 REQUIRE_CONFIRMATION 环境变量可用于在应用清单之前提示用户确认。默认为 true。

• --temperature 标志或 TEMPERATURE 环境变量可设置为 0 到 1 之间的值。较高的温度会产生更具创造性的补全结果，而较低的温度则会产生更确定性的补全结果。默认为 0。

• --use-k8s-api 标志或 USE_K8S_API 环境变量可用于使用 Kubernetes OpenAPI 规范生成清单。这将产生非常准确的补全结果，包括 CRD（如果配置的集群中存在）。此设置会使用更多的 OpenAI API 调用，并且需要 函数调用，而该功能仅在 0613 或更高版本的模型中可用。默认为 false。不过，为了准确性和完整性，建议启用此选项。

• --k8s-openapi-url 标志或 K8S_OPENAPI_URL 环境变量可用于指定自定义的 Kubernetes OpenAPI 规范 URL。此设置仅在启用 --use-k8s-api 时生效。默认情况下，kubectl-ai 会使用已配置的 Kubernetes API 服务器获取规范，除非您配置了此设置。您可以使用 默认的 Kubernetes OpenAPI 规范 或生成包含自定义资源定义 (CRD) 的自定义规范。您可以通过运行 kubectl get --raw /openapi/v2 > swagger.json 来生成自定义的 OpenAPI 规范。

管道输入和输出

Kubectl AI 可以与管道输入和输出一起使用。例如：

$ cat foo-deployment.yaml | kubectl ai "将副本数改为 5" --raw | kubectl apply -f -

保存到文件

$ cat foo-deployment.yaml | kubectl ai "将副本数改为 5" --raw > my-deployment-updated.yaml

与外部编辑器结合使用

如果您想使用外部编辑器编辑生成的清单，可以设置 --raw 标志，并将其通过管道传递给您选择的编辑器。例如：

# Visual Studio Code
$ kubectl ai "创建一个 foo 命名空间" --raw | code -

# Vim
$ kubectl ai "创建一个 foo 命名空间" --raw | vim -

示例

创建具有特定值的对象

$ kubectl ai "创建一个拥有 3 个副本的 nginx 部署"
✨ 尝试应用以下清单：
apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-deployment
  labels:
    app: nginx
spec:
  replicas: 3
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx:1.7.9
        ports:
        - containerPort: 80
使用方向键导航：↓ ↑ → ←
? 您是否要应用此清单？[重新提示/应用/不应用]：
+   重新提示
  ▸ 应用
    不应用

重新提示以优化您的提示

...
重新提示：更新为 5 个副本，并将端口改为 8080
✨ 尝试应用以下清单：
apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-deployment
  labels:
    app: nginx
spec:
  replicas: 5
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx:1.7.9
        ports:
        - containerPort: 8080
使用方向键导航：↓ ↑ → ←
? 您是否要应用此清单？[重新提示/应用/不应用]：
+   重新提示
  ▸ 应用
    不应用

多个对象

$ kubectl ai "创建一个名为 foo 的命名空间，然后在该命名空间中创建一个 nginx Pod"
✨ 尝试应用以下清单：
apiVersion: v1
kind: Namespace
metadata:
  name: foo
---
apiVersion: v1
kind: Pod
metadata:
  name: nginx
  namespace: foo
spec:
  containers:
  - name: nginx
    image: nginx:latest
使用方向键导航：↓ ↑ → ←
? 您是否要应用此清单？[重新提示/应用/不应用]：
+   重新提示
  ▸ 应用
    不应用

可选的 --require-confirmation 标志

$ kubectl ai "创建一个类型为 LoadBalancer、选择器为 'app:nginx' 的服务" --require-confirmation=false
✨ 尝试应用以下清单：
apiVersion: v1
kind: Service
metadata:
  name: nginx-service
spec:
  selector:
    app: nginx
  ports:
  - port: 80
    targetPort: 80
  type: LoadBalancer

请注意，该插件目前尚无法了解集群的当前状态，因此它始终会生成完整的清单。

kubectl-ai 快速上手指南

kubectl-ai 是一个 kubectl 插件，利用 OpenAI GPT 模型自动生成并应用 Kubernetes 资源清单（Manifest）。它能帮助开发者在开发或测试时，避免手动查找和拼凑杂乱的 YAML 文件。

环境准备

在使用前，请确保满足以下条件：

1. Kubernetes 环境：已配置有效的 kubeconfig，可正常访问集群。
2. AI 服务凭证：需具备以下任一服务的访问权限：
   • OpenAI API Key
   • Azure OpenAI Service (API Key 和 Endpoint)
   • 兼容 OpenAI 接口的本地服务 (如 AIKit, LocalAI 等，无需 GPU 也可运行)

设置环境变量以配置凭证（根据实际选择其一）：

# 方案 A: 使用 OpenAI
export OPENAI_API_KEY=<your OpenAI key>
export OPENAI_DEPLOYMENT_NAME="gpt-3.5-turbo-0301" # 可选，默认值

# 方案 B: 使用 Azure OpenAI
export OPENAI_API_KEY=<your Azure key>
export OPENAI_ENDPOINT="https://my-aoi-endpoint.openai.azure.com"
export OPENAI_DEPLOYMENT_NAME="<your-deployment-name>"
# 注意：Azure 不支持部署名中包含 "."，插件会自动处理 gpt-3.5-turbo 为 gpt-35-turbo
# 若部署名完全不同，可设置映射：export AZURE_OPENAI_MAP="gpt-3.5-turbo=my-deployment"

# 方案 C: 使用本地兼容接口 (例如运行了 AIKit)
export OPENAI_ENDPOINT="http://localhost:8080/v1"
export OPENAI_DEPLOYMENT_NAME="llama-3.1-8b-instruct"
export OPENAI_API_KEY="n/a"

安装步骤

推荐通过 Homebrew 或 Krew 进行安装。

方式一：使用 Homebrew (macOS/Linux)

brew tap sozercan/kubectl-ai https://github.com/sozercan/kubectl-ai
brew install kubectl-ai

方式二：使用 Krew (跨平台)

kubectl krew index add kubectl-ai https://github.com/sozercan/kubectl-ai
kubectl krew install kubectl-ai/kubectl-ai

方式三：手动安装

从 GitHub Releases 下载对应系统的二进制文件，将其重命名为 kubectl-ai 并放入系统 PATH 目录中即可。

基本使用

安装并配置好环境变量后，即可直接使用自然语言描述需求，插件将生成 YAML 并提示是否应用。

示例 1：创建资源

创建一个包含 3 个副本的 Nginx Deployment：

kubectl ai "create an nginx deployment with 3 replicas"

执行后，终端会显示生成的 Manifest，并通过交互式菜单询问操作：

• Reprompt: 重新输入指令以修正结果（例如："update to 5 replicas"）。
• Apply: 确认并将资源配置应用到集群。
• Don't Apply: 放弃操作。

示例 2：多资源创建

一条指令创建命名空间及内部的 Pod：

kubectl ai "create a foo namespace then create nginx pod in that namespace"

示例 3：跳过确认直接应用

若希望生成后直接应用（慎用），可添加 --require-confirmation=false 标志：

kubectl ai "create a service with type LoadBalancer with selector as 'app:nginx'" --require-confirmation=false

高级技巧：管道与编辑

结合管道符，可以将现有文件作为输入，或将输出重定向到编辑器：

# 修改现有文件并直接应用
cat foo-deployment.yaml | kubectl ai "change replicas to 5" --raw | kubectl apply -f -

# 生成内容并发送到 VS Code 编辑
kubectl ai "create a foo namespace" --raw | code -

提示：为了获得更精准的结果（包括支持 CRD），建议设置 --use-k8s-api 标志，这将使插件读取当前集群的 OpenAPI Spec 来辅助生成。