Cozystack API on Cozystack

Go Types

Mon, 01 Jan 0001 00:00:00 +0000

Типы Go

Cozystack публикует свои типы ресурсов Kubernetes в виде Go-модуля, что позволяет управлять ресурсами Cozystack из любого Go-кода. Типы доступны по адресу pkg.go.dev/github.com/cozystack/cozystack/api/apps/v1alpha1.

Установка

Добавьте зависимость в ваш Go-модуль:

go get github.com/cozystack/cozystack/api/apps/v1alpha1@v1.5.0

Сценарии использования

Типы Go полезны для:

Создания инструментов автоматизации — разработки скриптов или приложений, программно развёртывающих ресурсы Cozystack и управляющих ими
Интеграции с внешними системами — подключения Cozystack к собственным CI/CD-конвейерам, системам мониторинга или оркестрации
Валидации конфигураций — проверки спецификаций ресурсов перед их применением к кластеру
Генерации документации — разбора и анализа существующих ресурсов Cozystack
Создания дашбордов — разработки пользовательских интерфейсов для управления Cozystack

Доступные пакеты

Модуль содержит пакеты для каждого типа ресурса; вы можете изучить их для вашей конкретной версии по адресу pkg.go.dev/github.com/cozystack/cozystack/api/apps/v1alpha1

REST API Reference

Mon, 01 Jan 0001 00:00:00 +0000

Справочник ApplicationDefinition

Mon, 01 Jan 0001 00:00:00 +0000

Обзор

ApplicationDefinition (applicationdefinitions.cozystack.io/v1alpha1) — это CRD кластерного масштаба, описывающий каждый тип приложения, предоставляемый платформой. Каждое определение объявляет Kind Kubernetes, который используют тенанты в агрегированном API (spec.application.kind), схему OpenAPI для отображения формы на дашборде и валидации пользовательского ввода (spec.application.openAPISchema), а также метаданные дашборда: категорию, иконку и отображаемые имена (spec.dashboard).

Агрегированный API-сервер (cozystack-api) перечисляет все ApplicationDefinition один раз при запуске и регистрирует соответствующий ресурс под apps.cozystack.io/v1alpha1. Набор тенант-ориентированных Kind не меняется пока работает API-сервер — добавление, удаление или переименование ApplicationDefinition вступает в силу только после перезапуска cozystack-api.