如何在3种不同环境中使用CRDs-catalog：本地开发、CI/CD和Air-Gapped环境终极指南

【免费下载链接】CRDs-catalogPopular Kubernetes CRDs (CustomResourceDefinition) in JSON schema format.项目地址: https://gitcode.com/gh_mirrors/cr/CRDs-catalog

CRDs-catalog是一个强大的Kubernetes自定义资源定义（CRD）JSON模式集合，它提供了数百种流行CRD的验证模式。通过在不同环境中正确使用CRDs-catalog，您可以实现Kubernetes资源的离线验证、提升开发效率并确保CI/CD管道的可靠性。这个完整的CRD验证解决方案让您能够在没有集群访问权限的情况下进行资源验证，实现真正的"左移"安全策略。

📋 什么是CRDs-catalog及其核心价值

CRDs-catalog项目汇集了数百个热门Kubernetes CRD的JSON模式文件，这些模式可以直接被Datree、Kubeconform和Kubeval等工具使用。核心价值在于它允许开发者在本地开发、CI/CD流水线甚至隔离环境中验证自定义资源，而无需访问实际的Kubernetes集群。

主要功能包括：

• 离线验证：在没有Kubernetes集群连接的情况下验证YAML文件
• 开发工具集成：与VS Code的Red Hat YAML插件无缝集成
• 多环境支持：适应本地开发、CI/CD和隔离网络环境
• 自动模式提取：提供CRD提取工具从现有集群生成模式

🖥️ 本地开发环境配置

快速安装和基础使用

在本地开发环境中使用CRDs-catalog非常简单。首先克隆仓库：

git clone https://gitcode.com/gh_mirrors/cr/CRDs-catalog.git cd CRDs-catalog

VS Code智能感知配置

配置VS Code的Red Hat YAML插件以获得完整的智能感知支持。在您的YAML文件中添加schema注释：

# yaml-language-server: $schema=https://datreeio.github.io/CRDs-catalog/cilium.io/ciliumnetworkpolicy_v2.json apiVersion: cilium.io/v2 kind: CiliumNetworkPolicy metadata: name: example-policy spec: endpointSelector: matchLabels: app: myapp

使用自动化注释工具

项目提供了Utilities/annotate-yaml.py脚本，可以自动为您的YAML文件添加schema注释：

python3 Utilities/annotate-yaml.py your-manifest.yaml

这个工具会自动检测YAML中的CRD资源类型，并添加正确的schema URL，大大简化了配置过程。

本地验证工作流程

1. 安装验证工具：

   # 安装datree brew install datree # 或者安装kubeconform brew install kubeconform

2. 使用本地模式进行验证：

   # 使用datree datree test deployment.yaml # 使用kubeconform kubeconform -schema-location default \ -schema-location 'file:///path/to/CRDs-catalog/{{.Group}}/{{.ResourceKind}}_{{.ResourceAPIVersion}}.json' \ deployment.yaml

🔄 CI/CD管道集成

GitHub Actions自动化验证

在CI/CD管道中集成CRDs-catalog可以确保所有部署的Kubernetes资源都符合预期模式。以下是GitHub Actions的完整配置示例：

name: Validate Kubernetes Manifests on: pull_request: paths: - 'k8s/**' - 'manifests/**' jobs: validate: runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v3 - name: Checkout CRDs-catalog uses: actions/checkout@v3 with: repository: datreeio/CRDs-catalog path: crd-schemas - name: Install kubeconform run: | wget https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz tar xzf kubeconform-linux-amd64.tar.gz sudo mv kubeconform /usr/local/bin/ - name: Validate manifests run: | for file in $(find ./manifests -name "*.yaml" -o -name "*.yml"); do echo "Validating $file" kubeconform -schema-location default \ -schema-location 'file://./crd-schemas/{{.Group}}/{{.ResourceKind}}_{{.ResourceAPIVersion}}.json' \ "$file" done

GitLab CI配置

对于GitLab用户，可以这样配置CI/CD验证：

validate-k8s: image: alpine:latest stage: validate before_script: - apk add --no-cache curl tar - curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz -o kubeconform.tar.gz - tar xzf kubeconform.tar.gz - mv kubeconform /usr/local/bin/ script: - git clone --depth 1 https://gitcode.com/gh_mirrors/cr/CRDs-catalog.git crd-schemas - find ./k8s -name "*.yaml" -o -name "*.yml" | while read file; do kubeconform -schema-location default \ -schema-location "file://./crd-schemas/{{.Group}}/{{.ResourceKind}}_{{.ResourceAPIVersion}}.json" \ "$file" done

Jenkins Pipeline集成

在Jenkins中，您可以使用以下Pipeline脚本：

pipeline { agent any stages { stage('Validate Kubernetes Manifests') { steps { script { sh ''' git clone --depth 1 https://gitcode.com/gh_mirrors/cr/CRDs-catalog.git crd-schemas wget https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz tar xzf kubeconform-linux-amd64.tar.gz for file in $(find ./manifests -name "*.yaml" -o -name "*.yml"); do echo "Validating $file" ./kubeconform -schema-location default \ -schema-location "file://./crd-schemas/{{.Group}}/{{.ResourceKind}}_{{.ResourceAPIVersion}}.json" \ "$file" done ''' } } } } }

🔒 Air-Gapped隔离环境部署

离线环境准备工作

在隔离网络环境中，您需要预先准备所有依赖。以下是完整的离线部署方案：

1. 准备离线包：

   # 1. 下载CRDs-catalog仓库 git clone --depth 1 https://gitcode.com/gh_mirrors/cr/CRDs-catalog.git # 2. 下载验证工具 wget https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz # 3. 创建离线包 tar czf offline-crd-validation.tar.gz \ CRDs-catalog/ \ kubeconform-linux-amd64.tar.gz \ README-offline.md

从生产集群提取CRD模式

使用Utilities/crd-extractor.sh工具从您的生产集群提取CRD模式：

# 在有网络连接的机器上运行 cd CRDs-catalog/Utilities KUBECTL_CONTEXT=production-cluster ./crd-extractor.sh

这个脚本会：

1. 连接到指定的Kubernetes集群
2. 提取所有CRD定义
3. 转换为JSON模式格式
4. 按API组组织文件结构

离线环境部署流程

1. 传输文件到隔离环境：

   # 使用安全传输方式 scp offline-crd-validation.tar.gz airgapped-server:/tmp/

2. 在隔离环境中安装：

   # 在隔离服务器上 cd /opt tar xzf /tmp/offline-crd-validation.tar.gz tar xzf kubeconform-linux-amd64.tar.gz mv kubeconform /usr/local/bin/ # 设置环境变量 export CRD_SCHEMA_DIR=/opt/CRDs-catalog

3. 配置验证脚本： 创建/usr/local/bin/validate-k8s.sh：

   #!/bin/bash SCHEMA_DIR="/opt/CRDs-catalog" for file in "$@"; do echo "Validating $file" kubeconform -schema-location default \ -schema-location "file://$SCHEMA_DIR/{{.Group}}/{{.ResourceKind}}_{{.ResourceAPIVersion}}.json" \ "$file" done

定期更新策略

建立定期更新机制确保模式与生产集群保持同步：

# 更新脚本示例 #!/bin/bash # update-crd-schemas.sh # 1. 在有网络的环境中提取最新CRD cd /tmp git clone --depth 1 https://gitcode.com/gh_mirrors/cr/CRDs-catalog.git new-schemas cd new-schemas/Utilities KUBECTL_CONTEXT=production-cluster ./crd-extractor.sh # 2. 创建更新包 cd .. tar czf crd-update-$(date +%Y%m%d).tar.gz . # 3. 安全传输到隔离环境 # （根据您的安全策略实现传输）

🛠️ 高级配置和最佳实践

性能优化技巧

1. 缓存模式文件：

   # 使用本地缓存避免重复下载 export KUBECONFORM_CACHE_DIR="$HOME/.kubeconform-cache" mkdir -p "$KUBECONFORM_CACHE_DIR"

2. 并行验证：

   # 使用xargs并行处理多个文件 find ./manifests -name "*.yaml" -o -name "*.yml" | \ xargs -P 4 -I {} kubeconform -schema-location default \ -schema-location 'file://./crd-schemas/{{.Group}}/{{.ResourceKind}}_{{.ResourceAPIVersion}}.json' {}

自定义模式管理

对于私有CRD，使用CRD提取工具创建自定义模式：

# 从特定集群上下文提取 cd CRDs-catalog/Utilities KUBECTL_CONTEXT=my-cluster ./crd-extractor.sh # 指定输出目录 OUTPUT_DIR=/custom/schemas KUBECTL_CONTEXT=my-cluster ./crd-extractor.sh

集成到开发工作流

1. Git预提交钩子： 在.git/hooks/pre-commit中添加：

   #!/bin/bash for file in $(git diff --cached --name-only --diff-filter=ACM | grep -E '\.(yaml|yml)$'); do kubeconform -schema-location default \ -schema-location 'file://./crd-schemas/{{.Group}}/{{.ResourceKind}}_{{.ResourceAPIVersion}}.json' \ "$file" || exit 1 done

2. IDE配置： 配置VS Code的settings.json：

   { "yaml.schemas": { "file:///path/to/CRDs-catalog/*.json": ["*.yaml", "*.yml"] }, "yaml.format.enable": true, "yaml.validate": true }

🚀 故障排除和常见问题

常见错误及解决方案

1. 模式未找到错误：

   # 错误：找不到对应的JSON模式 # 解决方案：使用CRD提取工具生成缺失的模式 cd CRDs-catalog/Utilities ./crd-extractor.sh

2. 网络连接问题：

   # 在隔离环境中使用本地文件路径 kubeconform -schema-location default \ -schema-location 'file:///absolute/path/to/CRDs-catalog/{{.Group}}/{{.ResourceKind}}_{{.ResourceAPIVersion}}.json' \ manifest.yaml

3. 版本兼容性问题：

   # 确保使用的CRD版本与集群版本匹配 # 检查API版本 kubectl api-versions | grep your-crd-group

调试技巧

启用详细输出以诊断问题：

# 启用调试模式 kubeconform -verbose -schema-location default \ -schema-location 'file://./crd-schemas/{{.Group}}/{{.ResourceKind}}_{{.ResourceAPIVersion}}.json' \ manifest.yaml # 检查模式文件是否存在 find ./crd-schemas -name "*your-crd*.json"

📊 环境配置对比表

🎯 总结

CRDs-catalog为Kubernetes资源验证提供了完整的解决方案，无论您是在本地开发、CI/CD流水线还是隔离环境中工作。通过合理配置，您可以：

1. 提升开发效率：通过VS Code智能感知快速编写正确的YAML
2. 确保代码质量：在CI/CD中自动验证所有Kubernetes清单
3. 满足安全合规：在隔离环境中实现完整的验证流程
4. 减少部署错误：提前发现资源定义问题

记住，无论选择哪种环境配置，核心原则都是将验证左移，在资源部署到集群之前发现问题。CRDs-catalog让这一过程变得简单而高效。

开始使用CRDs-catalog，让您的Kubernetes部署更加可靠和安全！🚀

【免费下载链接】CRDs-catalogPopular Kubernetes CRDs (CustomResourceDefinition) in JSON schema format.项目地址: https://gitcode.com/gh_mirrors/cr/CRDs-catalog