Managed Applications: Guides and Reference on Cozystack

Application Backup and Recovery

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

This guide covers backing up and restoring Cozystack-managed databases — Postgres, MariaDB, and ClickHouse — as a tenant user: running one-off and scheduled backups, checking status, and restoring from a backup either in place or into a separate target instance.

Storage, credentials, and the BackupClass are admin-provisioned. Before you can run a BackupJob, an administrator provisions the S3 storage and the per-application credential Secrets your driver expects, and creates the cluster-scoped BackupClass you reference. Ask your administrator for:

Adding External Applications to Cozystack Catalog

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

Cozystack administrators can add applications from external sources in addition to the standard application catalog. These applications appear in the same catalog and behave like regular managed applications for platform users.

This guide explains the structure of an external application package and how to add it to a Cozystack cluster.

For a complete working example, see github.com/cozystack/external-apps-example.

Just like standard Cozystack applications, this external application package uses Helm and FluxCD. To learn more about developing application packages, read the Cozystack Developer Guide.

Managed ClickHouse Service

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

ClickHouse is an open source high-performance and column-oriented SQL database management system (DBMS). It is used for online analytical processing (OLAP).

Backup orchestration

Two backup paths coexist on the chart; pick one per release.

Recommended: BackupClass + Plan via the Altinity strategy

The cluster-scoped Altinity strategy (strategy.backups.cozystack.io/v1alpha1) wraps Altinity’s clickhouse-backup in a one-shot batch/v1.Job per BackupJob / RestoreJob. It is engine-aware (FREEZE + upload), supports both in-place and targetApplicationRef (to-copy) restore, and does not require any in-chart CronJob.

FoundationDB

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

A managed FoundationDB service for Cozystack.

Overview

FoundationDB is a distributed database designed to handle large volumes of structured data across clusters of commodity servers. It organizes data as an ordered key-value store and employs ACID transactions for all operations.

This package provides a managed FoundationDB cluster deployment using the FoundationDB Kubernetes Operator.

Features

High Availability: Multi-instance deployment with automatic failover
ACID Transactions: Full ACID transaction support across the cluster
Scalable: Easily scale storage and compute resources
Backup Integration: Optional S3-compatible backup storage
Monitoring: Built-in monitoring and alerting through WorkloadMonitor
Flexible Configuration: Support for custom FoundationDB parameters

Configuration

Basic Configuration

# Cluster process configuration
cluster:
 version: "7.3.63"
 processCounts:
 storage: 3 # Number of storage processes (determines cluster size)
 stateless: -1 # Automatically calculated
 cluster_controller: 1
 faultDomain:
 key: "kubernetes.io/hostname"
 valueFrom: "spec.nodeName"

Storage

storage:
 size: "16Gi" # Storage size per instance
 storageClass: "" # Storage class (optional)

Resources

# Use preset sizing
resourcesPreset: "medium" # small, medium, large, xlarge, 2xlarge

# Or custom resource configuration
resources:
 cpu: "2000m"
 memory: "4Gi"

Backups

The recommended backup flow uses the Cozystack backups framework: a cluster-scoped BackupClass binds apps.cozystack.io/FoundationDB to a strategy.backups.cozystack.io/FoundationDB strategy, and tenants drive runs via BackupJob / RestoreJob. See examples/backups/foundationdb/ for an end-to-end walkthrough (admin setup, backup, in-place restore, to-copy restore).

Managed Harbor Container Registry

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

Harbor is an open-source trusted cloud-native registry project that stores, signs, and scans content.

Prerequisites

The Cozystack Harbor app stores its registry data exclusively in S3-compatible object storage: the chart pins the registry backend to S3 and exposes no filesystem option. That bucket is provisioned through COSI (objectstorage.k8s.io) from a SeaweedFS deployment, so before deploying Harbor the tenant must have SeaweedFS available — enabled on the same tenant or inherited from a parent tenant (the resolved class is propagated down the tenant tree, surfaced as the namespace.cozystack.io/seaweedfs namespace annotation).

Managed Kafka Service

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

Both kafka.storageClass and zookeeper.storageClass are annotated as immutable in the chart schema — see docs/storage-immutability.md for the contract and which consumers enforce it.

Parameters

Common parameters

Name	Description	Type	Value
`external`	Enable external access from outside the cluster.	`bool`	`false`
`tls`	TLS configuration. Strimzi manages the cluster PKI automatically (no cert-manager is involved for this chart): the operator auto-creates `<release>-cluster-ca-cert` and `<release>-clients-ca-cert` secrets, both exposed for client trust setup. The internal TLS listener on 9093 is always on; this toggle only controls the external listener on 9094.	`object`	`{}`
`tls.enabled`	Enable TLS on the external listener. When unset, inherits the value of `external` (TLS is on when external access is enabled). Warning: setting this to false while external is true exposes Kafka over plaintext on a public IP via LoadBalancer. Strimzi does not provide authentication on this listener unless SCRAM, mTLS, or OAuth is separately configured. Use only in controlled networks.	`*bool`	`null`

Application-specific parameters

Name	Description	Type	Value
`topics`	Topics configuration.	`[]object`	`[]`
`topics[i].name`	Topic name.	`string`	`""`
`topics[i].partitions`	Number of partitions.	`int`	`0`
`topics[i].replicas`	Number of replicas.	`int`	`0`
`topics[i].config`	Topic configuration.	`object`	`{}`

Kafka configuration

Name	Description	Type	Value
`kafka`	Kafka configuration.	`object`	`{}`
`kafka.replicas`	Number of Kafka replicas.	`int`	`3`
`kafka.resources`	Explicit CPU and memory configuration. When omitted, the preset defined in `resourcesPreset` is applied.	`object`	`{}`
`kafka.resources.cpu`	CPU available to each replica.	`quantity`	`""`
`kafka.resources.memory`	Memory (RAM) available to each replica.	`quantity`	`""`
`kafka.resourcesPreset`	Default sizing preset used when `resources` is omitted.	`string`	`c1.small`
`kafka.size`	Persistent Volume size for Kafka.	`quantity`	`10Gi`
`kafka.storageClass`	StorageClass used to store the Kafka data.	`string`	`""`

ZooKeeper configuration

Name	Description	Type	Value
`zookeeper`	ZooKeeper configuration.	`object`	`{}`
`zookeeper.replicas`	Number of ZooKeeper replicas.	`int`	`3`
`zookeeper.resources`	Explicit CPU and memory configuration. When omitted, the preset defined in `resourcesPreset` is applied.	`object`	`{}`
`zookeeper.resources.cpu`	CPU available to each replica.	`quantity`	`""`
`zookeeper.resources.memory`	Memory (RAM) available to each replica.	`quantity`	`""`
`zookeeper.resourcesPreset`	Default sizing preset used when `resources` is omitted.	`string`	`c1.small`
`zookeeper.size`	Persistent Volume size for ZooKeeper.	`quantity`	`5Gi`
`zookeeper.storageClass`	StorageClass used to store the ZooKeeper data.	`string`	`""`

Parameter examples and reference

resources and resourcesPreset

resources sets explicit CPU and memory configurations for each replica. When left empty, the preset defined in resourcesPreset is applied.

Managed MariaDB Service

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

The Managed MariaDB Service offers a powerful and widely used relational database solution. This service allows you to create and manage a replicated MariaDB cluster seamlessly.

Deployment Details

This managed service is controlled by mariadb-operator, ensuring efficient management and seamless operation.

storageClass is annotated as immutable in the chart schema — see docs/storage-immutability.md for the contract and which consumers enforce it.

Управляемый сервис MongoDB

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

MongoDB — популярная документоориентированная NoSQL-база данных, известная своей гибкостью и масштабируемостью. Управляемый сервис MongoDB предоставляет самовосстанавливающийся реплицируемый кластер под управлением Percona Operator for MongoDB.

Детали развёртывания

Этот управляемый сервис контролируется Percona Operator for MongoDB, обеспечивающим эффективное управление и бесперебойную работу.

Документация: https://docs.percona.com/percona-operator-for-mongodb/
Github: https://github.com/percona/percona-server-mongodb-operator

Режимы развёртывания

Режим набора реплик (Replica Set, по умолчанию)

По умолчанию MongoDB разворачивается как набор реплик (replica set) с указанным числом реплик. Этот режим подходит для большинства сценариев, требующих высокой доступности.

Управляемый сервис NATS

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

NATS — это простая, безопасная и высокопроизводительная система обмена сообщениями с открытым исходным кодом. Она предоставляет уровень данных для облачных (cloud native) приложений, обмена сообщениями IoT и микросервисных архитектур.

storageClass помечен как неизменяемый (immutable) в схеме чарта — см. docs/storage-immutability.md, где описан этот контракт и какие потребители его обеспечивают.

Параметры

Общие параметры

Имя	Описание	Тип	Значение
`replicas`	Количество реплик.	`int`	`2`
`resources`	Явная конфигурация CPU и памяти для каждой реплики NATS. Если не задано, применяется пресет, указанный в `resourcesPreset`.	`object`	`{}`
`resources.cpu`	CPU, доступный каждой реплике.	`quantity`	`""`
`resources.memory`	Память (RAM), доступная каждой реплике.	`quantity`	`""`
`resourcesPreset`	Пресет размера по умолчанию, используемый, когда `resources` не задан.	`string`	`t1.nano`
`storageClass`	StorageClass, используемый для хранения данных.	`string`	`""`
`external`	Включить внешний доступ извне кластера.	`bool`	`false`
`tls`	Конфигурация TLS. Если не задано, TLS следует значению флага `external`.	`object`	`{}`
`tls.enabled`	Включить TLS. Если не задано, TLS включается автоматически, когда `external` равен true.	`*bool`	`null`

Параметры, специфичные для приложения

Имя	Описание	Тип	Значение
`users`	Карта конфигурации пользователей.	`map[string]object`	`{}`
`users[name].password`	Пароль пользователя.	`string`	`""`
`jetstream`	Конфигурация Jetstream.	`object`	`{}`
`jetstream.enabled`	Включить или отключить Jetstream для постоянного обмена сообщениями в NATS.	`bool`	`true`
`jetstream.size`	Размер постоянного хранилища Jetstream.	`quantity`	`10Gi`
`config`	Конфигурация NATS.	`object`	`{}`
`config.merge`	Дополнительная конфигурация для слияния с конфигурацией NATS.	`*object`	`{}`
`config.resolver`	Дополнительная конфигурация resolver для слияния с конфигурацией NATS.	`*object`	`{}`

Примеры и справочник по параметрам

resources и resourcesPreset

resources задаёт явные конфигурации CPU и памяти для каждой реплики. Если оставить пустым, применяется пресет, указанный в resourcesPreset.

Управляемый сервис OpenBAO

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

OpenBAO — это решение для управления секретами с открытым исходным кодом, ответвлённое (форк) от HashiCorp Vault. Оно обеспечивает управление секретами на основе идентичности и шифрованием для облачной инфраструктуры.

storageClass помечен как неизменяемый (immutable) в схеме чарта — см. docs/storage-immutability.md, где описан этот контракт и какие потребители его обеспечивают.

Параметры

Общие параметры

Имя	Описание	Тип	Значение
`replicas`	Количество реплик OpenBAO. Режим высокой доступности (HA) с Raft включается автоматически при replicas > 1. Переключение между режимами standalone (файловое хранилище) и HA (хранилище Raft) требует миграции данных.	`int`	`1`
`resources`	Явная конфигурация CPU и памяти для каждой реплики OpenBAO. Если не задано, применяется пресет, указанный в `resourcesPreset`.	`object`	`{}`
`resources.cpu`	CPU, доступный каждой реплике.	`quantity`	`""`
`resources.memory`	Память (RAM), доступная каждой реплике.	`quantity`	`""`
`resourcesPreset`	Пресет размера по умолчанию, используемый, когда `resources` не задан.	`string`	`t1.small`
`size`	Размер Persistent Volume Claim для хранения данных.	`quantity`	`10Gi`
`storageClass`	StorageClass, используемый для хранения данных.	`string`	`""`
`external`	Включить внешний доступ извне кластера.	`bool`	`false`

Параметры, специфичные для приложения

Имя	Описание	Тип	Значение
`ui`	Включить веб-интерфейс OpenBAO.	`bool`	`true`

Управляемый сервис PostgreSQL

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

PostgreSQL в настоящее время является лидирующим выбором среди реляционных баз данных и известен своей надёжной функциональностью и производительностью. Управляемый сервис PostgreSQL использует реализацию на стороне платформы для предоставления самовосстанавливающегося реплицируемого кластера. Этот кластер эффективно управляется с помощью широко признанного оператора CloudNativePG, получившего популярность в сообществе.

Детали развёртывания

Этот управляемый сервис контролируется оператором CloudNativePG, обеспечивающим эффективное управление и бесперебойную работу.

Управляемый сервис Qdrant

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

Qdrant — это высокопроизводительная векторная база данных и движок поиска по сходству, разработанный для приложений искусственного интеллекта и машинного обучения. Он обеспечивает эффективное хранение и извлечение многомерных векторов с продвинутыми возможностями фильтрации, что делает его идеальным для рекомендательных систем, семантического поиска и приложений RAG (Retrieval-Augmented Generation, генерация с дополненной выборкой).

Детали развёртывания

Сервис разворачивает Qdrant как StatefulSet с автоматическим режимом кластера, когда настроено несколько реплик.

Управляемый сервис RabbitMQ

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

RabbitMQ — это надёжный брокер сообщений, играющий ключевую роль в современных распределённых системах. Наш управляемый сервис RabbitMQ упрощает развёртывание и управление кластерами RabbitMQ, обеспечивая надёжность и масштабируемость для ваших задач обмена сообщениями.

Детали развёртывания

Сервис использует официальный оператор RabbitMQ. Это обеспечивает надёжность и бесперебойную работу ваших экземпляров RabbitMQ.

Github: https://github.com/rabbitmq/cluster-operator/
Документация: https://www.rabbitmq.com/kubernetes/operator/operator-overview.html

storageClass помечен как неизменяемый (immutable) в схеме чарта — см. docs/storage-immutability.md, где описан этот контракт и какие потребители его обеспечивают.

Управляемый сервис Redis

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

Redis — это исключительно универсальное и очень быстрое хранилище данных и кэш в оперативной памяти, способное значительно повысить производительность ваших приложений. Управляемый сервис Redis предлагает беспроблемное решение для развёртывания кластеров Redis и управления ими, гарантируя, что ваши данные всегда доступны и отзывчивы.

Детали развёртывания

Сервис использует Spotahome Redis Operator для эффективного управления и оркестрации кластеров Redis.

Справочник по приложению Tenant

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

Тенант — это основная единица безопасности на платформе. Ближайшая аналогия — пространства имён ядра Linux.

Тенанты могут создаваться рекурсивно и подчиняются следующим правилам:

Именование тенантов

Имена тенантов должны быть буквенно-цифровыми:

Только строчные буквы (a-z) и цифры (0-9)
Должны начинаться со строчной буквы
Дефисы (-) не допускаются, в отличие от других сервисов
Максимальная длина зависит от конфигурации кластера (префикс Helm-релиза и корневой домен)

Это ограничение существует для поддержания согласованного именования в тенантах, вложенных тенантах и развёрнутых в них сервисах. Тенант нельзя назвать foo-bar, потому что разбор внутренних имён ресурсов вроде tenant-foo-bar был бы неоднозначным.