ellinj/pks-resource

pks-resource

镜像概述和主要用途

pks-resource是一个用于向Kubernetes集群应用更新的PKS资源，适用于Concourse CI/CD流程，可通过PKS API认证并执行kubectl命令操作Kubernetes集群资源。

版本信息

Initial Release 1.0.0

• PKS CLI版本：1.4.0-build.194
• Helm Client版本：v2.12.1

核心功能和特性

• 支持通过PKS API认证并连接Kubernetes集群
• 提供kubectl命令执行能力，包括apply、delete、label等操作
• 支持部署后等待Pod就绪功能，可通过标签选择器指定检查范围
• 支持命名空间作用域配置，可灵活覆盖默认命名空间

源配置（Source Configuration）

集群配置（cluster configs）

• pks_endpoint：PKS API服务器的地址和端口。
• pks_user：用于PKS API认证的用户名。
• pks_password：用于PKS API认证的密码。
• pks_cluster：要部署的集群名称。
• namespace：可选。命名空间作用域，默认为default。若与kubeconfig一同设置，namespace将覆盖当前上下文中的命名空间。
• certificate_authority：待实现。证书颁发机构的证书文件。当前与PKS API端点通信时禁用SSL验证。

  yaml
  certificate_authority: |
      -----BEGIN CERTIFICATE-----
      ...
      -----END CERTIFICATE-----
  

• insecure_skip_tls_verify：待实现。若为true，将不检查API服务器证书的有效性，这会使HTTPS连接不安全。默认为false。当前始终跳过验证。

行为（Behavior）

check：无操作。

in：无操作。

out：控制Kubernetes集群。

执行kubectl命令操作Kubernetes集群，如kubectl apply、kubectl delete、kubectl label等。

参数（Parameters）

• kubectl：必填。指定要对一个或多个资源执行的操作，例如apply、delete、label。
• context：可选。指定kubeconfig或kubeconfig_file时使用的上下文。
• wait_until_ready：可选。等待所有Pod就绪的秒数，0表示不等待，默认为30。
• wait_until_ready_interval：可选。检查Pod是否就绪的时间间隔（秒），默认为3。
• wait_until_ready_selector：可选。https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors%EF%BC%8C%E7%94%A8%E4%BA%8E%E6%8C%87%E5%AE%9A%E8%A6%81%E6%A3%80%E6%9F%A5%E5%B0%B1%E7%BB%AA%E7%8A%B6%E6%80%81%E7%9A%84Pod%E9%9B%86%E5%90%88%EF%BC%8C%E9%BB%98%E8%AE%A4%E4%B8%BA%E5%91%BD%E5%90%8D%E7%A9%BA%E9%97%B4%E5%86%85%E7%9A%84%E6%89%80%E6%9C%89Pod%E3%80%82
• namespace：可选。命名空间作用域，将覆盖其他参数和源配置中的命名空间。

使用示例

Concourse配置示例

yaml
resource_types:
- name: kubernetes
  type: docker-image
  source:
    repository: ellinj/pks-resource
    tag: "latest"

resources:
- name: kubernetes-production
  type: kubernetes
  source:
    pks_endpoint: ((PKS_ENDPOINT))
    pks_user: ((PKS_USER))
    pks_password: ((PKS_PASSWORD))
    pks_cluster: ((PKS_CLUSTER))
    namespace: production
- name: my-app
  type: git
  source:
    ...

jobs:
- name: kubernetes-deploy-production
  plan:
  - get: my-app
    trigger: true
  - put: kubernetes-production
    params:
      kubectl: apply -f my-app/k8s -f my-app/k8s/production
      wait_until_ready_selector: app=myapp

强制更新部署示例

yaml
jobs:
- name: force-update-deployment
  serial: true
  plan:
  - put: mycluster
    params:
      kubectl: |
        patch deploy nginx -p '{"spec":{"template":{"metadata":{"labels":{"updated_at":"'$(date +%s)'"}}}}}'
      wait_until_ready_selector: run=nginx

许可证

本软件基于MIT许可证发布。