Kubernetes CLI (kubectl) GitHub Action 安装与配置指南

Kubernetes CLI (kubectl) GitHub Action 安装与配置指南

kubectl GitHub Action for interacting with kubectl (k8s) 项目地址: https://gitcode.com/gh_mirrors/kube/kubectl

1. 项目基础介绍

本项目是一个GitHub Action，用于在GitHub工作流中与Kubernetes (kubectl) 进行交互。它允许开发者在持续集成/持续部署（CI/CD）过程中执行kubectl命令，以管理Kubernetes集群。该项目主要使用Shell和Dockerfile编程语言。

2. 项目使用的关键技术和框架

• GitHub Actions: 是GitHub提供的持续集成服务，允许您在代码仓库中自动化您的软件开发工作流程。
• Docker: 用于创建轻量级的、可移植的计算容器，本项目使用Dockerfile来配置和构建运行环境。
• kubectl: Kubernetes的命令行工具，用于与Kubernetes集群进行通信。

3. 项目安装和配置的准备工作与详细步骤

准备工作

在开始之前，您需要确保以下几点：

• 您有一个GitHub账户。
• 您对GitHub Actions有基本的了解。
• 您有一个Kubernetes集群，并且可以访问它的配置信息（例如kubeconfig文件）。

安装步骤

步骤1：创建一个新的GitHub仓库

在GitHub上创建一个新的仓库，您将在其中配置和使用GitHub Action。

步骤2：添加Kubernetes配置文件到仓库

将您的Kubernetes配置文件（通常是~/.kube/config）转换为base64编码，并将其作为秘密变量存储在GitHub仓库的Settings -> Secrets中。这可以通过以下命令完成：

cat ~/.kube/config | base64

在GitHub仓库的秘密设置中添加一个名为KUBE_CONFIG的秘密，并将上述base64编码的字符串作为值。

步骤3：在仓库中创建工作流文件

在您的GitHub仓库中创建一个.github/workflows目录，并在该目录下创建一个新的YAML文件，例如kubectl.yml。

步骤4：配置工作流文件

编辑kubectl.yml文件，添加以下内容：

name: Kubectl Example

on: [push]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: 使用kubectl获取pods
        uses: actions-hub/kubectl@master
        env:
          KUBE_CONFIG: ${{ secrets.KUBE_CONFIG }}
        with:
          args: get pods

这个工作流将在每次代码推送到仓库时触发，并执行以下步骤：

• 使用actions/checkout@v4来检出仓库代码。
• 使用actions-hub/kubectl@master来运行kubectl命令，获取所有pods的信息。

步骤5：提交并推送工作流文件

将工作流文件提交到您的仓库，并推送更改到GitHub。GitHub Actions将自动开始执行您定义的工作流。

git add .github/workflows/kubectl.yml
git commit -m "Add kubectl GitHub Action"
git push origin main

完成这些步骤后，您就成功地在您的GitHub项目中安装并配置了Kubernetes CLI (kubectl) GitHub Action。

kubectl GitHub Action for interacting with kubectl (k8s) 项目地址: https://gitcode.com/gh_mirrors/kube/kubectl