#Создание Pipelines для Tekton Hub

#Обзор

Это руководство описывает конкретные требования и рекомендации по созданию Pipelines, которые работают с каталогами Tekton Hub. В нем рассматриваются метаданные, специфичные для Hub, а также стандарты валидации и композиции.

#Метаданные, специфичные для Hub

#Обязательные Labels для Hub

metadata:
  name: my-custom-pipeline
  labels:
    app.kubernetes.io/version: "0.1"  # Must match catalog version directory

#Обязательные Annotations для Hub

metadata:
  annotations:
    tekton.dev/pipelines.minVersion: "0.17.0"    # Minimum Tekton version
    tekton.dev/categories: "Integration & Delivery"  # Hub category
    tekton.dev/tags: "ci,build,test,deploy"     # Hub search tags
    tekton.dev/displayName: "CI/CD Pipeline"    # Hub display name
    tekton.dev/platforms: "linux/amd64,linux/arm64"  # Supported platforms

#Ссылки на Task из Hub

#Ссылка на Task каталога для Hub

spec:
  tasks:
  - name: git-clone
    taskRef:
      resolver: hub
      params:
      - name: catalog
        value: "catalog"  # Hub catalog name
      - name: type
        value: tekton
      - name: kind
        value: task
      - name: name
        value: git-clone  # Task name from Hub
      - name: version
        value: "0.9"      # Task version
    params:
    - name: url
      value: $(params.repo-url)
    workspaces:
    - name: output
      workspace: source-code

#Категории и теги Hub

#Стандартные категории Pipeline

• Integration & Delivery
• Continuous Integration
• Continuous Deployment
• Testing
• Security
• Build & Package

#Эффективная маркировка Pipeline тегами

• Используйте теги, специфичные для рабочего процесса (ci, cd, cicd)
• Включайте технологические стеки (nodejs, java, python, golang)
• Добавляйте целевые среды развертывания (kubernetes, cloud, containers)

#Стандарты параметров Hub

#Требования к параметрам, специфичные для Hub

spec:
  params:
  - name: repo-url
    description: "Git repository URL for source code"  # Clear description for Hub UI
    type: string
  - name: target-environment
    description: "Deployment target environment"
    type: string
    default: "development"  # Sensible default
  - name: build-args
    description: "Additional build arguments"
    type: array
    default: []  # Safe default for arrays

#Шаблон Pipeline для Hub

apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: my-hub-pipeline
  labels:
    app.kubernetes.io/version: "0.1"  # Match catalog version
  annotations:
    tekton.dev/pipelines.minVersion: "0.17.0"
    tekton.dev/categories: "Integration & Delivery"  # Hub category
    tekton.dev/tags: "ci,build,deploy"               # Hub search tags
    tekton.dev/displayName: "My CI/CD Pipeline"      # Hub display name
    tekton.dev/platforms: "linux/amd64,linux/arm64"  # Platforms
spec:
  description: >-
    Pipeline description for Hub documentation
  params:
  - name: git-url
    description: Git repository URL
  - name: image-name
    description: Container image name
    default: "myapp:latest"
  workspaces:
  - name: source-code
    description: Source code workspace
  - name: registry-creds
    description: Distribution registry credentials
    optional: true

  tasks:
  - name: fetch-source
    taskRef:
      resolver: hub
      params:
      - name: catalog
        value: "catalog"
      - name: type
        value: tekton
      - name: kind
        value: task
      - name: name
        value: git-clone  # Reference Hub catalog task
      - name: version
        value: "0.9"
    params:
    - name: url
      value: $(params.git-url)
    workspaces:
    - name: output
      workspace: source-code

  - name: build-image
    taskRef:
      resolver: hub
      params:
      - name: catalog
        value: "catalog"
      - name: type
        value: tekton
      - name: kind
        value: task
      - name: name
        value: buildah    # Reference Hub catalog task
      - name: version
        value: "0.4"
    runAfter: [fetch-source]
    params:
    - name: image
      value: $(params.image-name)
    workspaces:
    - name: source
      workspace: source-code
    - name: registryconfig
      workspace: registry-creds

  finally:
  - name: cleanup
    taskRef:
      resolver: hub
      params:
      - name: catalog
        value: "catalog"
      - name: type
        value: tekton
      - name: kind
        value: task
      - name: name
        value: cleanup-workspace
      - name: version
        value: "0.1"
    workspaces:
    - name: source
      workspace: source-code

#Лучшие практики Hub

#Композиция Task для Hub

• По возможности используйте Task из того же каталога Hub
• Для стабильности ссылайтесь на конкретные версии Task
• Обеспечивайте понятное сопоставление параметров
• Документируйте зависимости между Task

#Управление Workspace для Hub

• Используйте понятные имена и описания Workspace
• Помечайте необязательные Workspace как optional: true
• Документируйте поток данных Workspace между Task
• По возможности минимизируйте требования к Workspace

#Повторное использование Pipeline для Hub

• Проектируйте для типовых сценариев использования
• Предоставляйте гибкие параметры
• Указывайте разумные значения по умолчанию
• Поддерживайте несколько сценариев развертывания

#Требования к тестированию Hub

#Обязательные тестовые файлы Pipeline

• Предоставьте рабочий каталог samples/ с примерами PipelineRun
• Включите run.yaml, демонстрирующий типичное использование
• Выполняйте тестирование с различными комбинациями параметров
• Проверяйте конфигурации Workspace
• Тестируйте сценарии обработки ошибок

#Чеклист валидации Pipeline для Hub

• Присутствуют обязательные метаданные Hub
• Пример PipelineRun работает корректно
• Все параметры документированы с описаниями
• Workspace надлежащим образом описаны
• Ссылки на Task используют Task каталога Hub
• Проверена совместимость с платформами
• Включены finally tasks для очистки

#Безопасность Pipeline для Hub

#Требования безопасности Hub

• В определениях Pipeline не должно быть жестко заданных секретов
• Используйте безопасные ссылки на Task
• Документируйте необходимые разрешения service account
• Следуйте принципу минимальных привилегий
• Проверяйте входные параметры

#Требования к документации

#Стандарты документации Pipeline для Hub

• В каталоге pipeline включите полный README.md
• Документируйте полный рабочий процесс и его назначение
• Предоставляйте понятные описания параметров
• Включайте примеры использования и типовые конфигурации
• Документируйте предварительные требования и зависимости
• Объясняйте требования к Workspace
• Включайте руководство по устранению неполадок

#Чеклист публикации в Hub

#✅ Соответствие требованиям Hub

• Присутствуют обязательные метаданные Hub (labels и annotations)
• Label версии соответствует структуре каталога
• Все параметры имеют понятные описания
• Workspace надлежащим образом документированы
• Используются ссылки на Task каталога Hub
• Указана совместимость с платформами
• Предоставлен рабочий пример PipelineRun
• Есть полный README с примерами использования
• Выполнены требования валидации Hub

#✅ Стандарты качества

• Pipeline можно повторно использовать в разных средах
• Реализованы обработка ошибок и очистка
• Нет жестко заданных значений или секретов
• Соблюдены лучшие практики безопасности
• Проверена кроссплатформенная совместимость
• Документация полная и точная
• Производительность оптимизирована за счет параллельного выполнения, где это возможно