Cozystack Cluster Configuration on Cozystack

Cozystack ConfigMap Reference

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

This page explains the role of Cozystack’s main ConfigMap and provides a full reference for its values.

Cozystack’s main configuration is defined by a single Kubernetes ConfigMap. This ConfigMap includes Cozystack bundle and components setup, key network settings, exposed services, and other options.

Example

Here’s an example of configuration for installing Cozystack with bundle paas-full, with root host “example.org”, and Cozystack Dashboard and API exposed and available to users:

apiVersion: v1
kind: ConfigMap
metadata:
 name: cozystack
 namespace: cozy-system
data:
 bundle-name: "paas-full"
 root-host: "example.org"
 api-server-endpoint: "https://api.example.org:443"
 expose-services: "dashboard,api"
 ipv4-pod-cidr: "10.244.0.0/16"
 ipv4-pod-gateway: "10.244.0.1"
 ipv4-svc-cidr: "10.96.0.0/16"
 ipv4-join-cidr: "100.64.0.0/16"

Reference

Value (`data.*`)	Bundles	Description
`bundle-name`	all	Name of bundle to use for installation.
`bundle-enable`	all	Optional bundle components included in the installation. Read more about this option in “How to enable and disable bundle components”.
`bundle-disable`	all	Bundle components excluded (disabled) from the installation. Read more about this option in “How to enable and disable bundle components”.
`values-<component>`	all	JSON or YAML formatted values passed to specific component installation. Read more about this option in “how to overwrite parameters for specific components”.
`root-host`	all	The main domain for all services created under Cozystack, such as the dashboard, Grafana, Keycloak, etc.
`api-server-endpoint`	all	Used for generating kubeconfig files for your users. It is recommended to use a routable FQDN or IP address instead of local-only addresses.
`telemetry-enabled`	all	Enable telemetry feature in Cozystack (default: `true`).
`expose-services`	all	Comma-separated list of services to expose to the internet. Possible values: `api,dashboard,cdi-uploadproxy,vm-exportproxy`.
`expose-ingress`	all	Ingress controller to use for exposing services. (default: `tenant-root`)
`expose-external-ips`	all	Comma-separated list of external IPs used for the specified ingress controller. If not specified, a LoadBalancer service is used by default.
`ipv4-pod-cidr`	`paas-full`, `distro-full`	The pod subnet used by Pods to assign IPs
`ipv4-pod-gateway`	`paas-full`	The gateway address for the pod subnet
`ipv4-svc-cidr`	`paas-full`, `distro-full`	The pod subnet used by Services to assign IPs
`ipv4-join-cidr`	`paas-full`	The `join` subnet, as a special subnet for network communication between the Node and Pod. Follow the kube-ovn documentation to learn more about these options.
`oidc-enabled`	`paas-full`, `paas-hosted`	Enable oidc feature in Cozystack (default: `false`)
`cpu-allocation-ratio`	`paas-full`, `paas-hosted`	CPU allocation ratio: `1/cpu-allocation-ratio` CPU requested per 1 vCPU. Defaults to 10. See Resource Management for detailed explanation and examples.

Cozystack Bundles: Overview and Comparison

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

Introduction

Bundles are pre-defined combinations of Cozystack components. Each bundle is tested, versioned, and guaranteed to work as a unit. They simplify installation, reduce the risk of misconfiguration, and make it easier to choose the right set of features for your deployment.

This guide is for infrastructure engineers, DevOps teams, and platform architects planning to deploy Cozystack in different environments. It explains how Cozystack bundles help tailor the installation to specific needs—whether you’re building a fully featured platform-as-a-service or just need a minimal Kubernetes cluster.

Cozystack Components Reference

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

Overwriting Component Parameters

You might want to override specific options for the components. To achieve this, you must specify values in JSON or YAML format using the data.values-<component> option in the Cozystack ConfigMap.

For example, if you want to overwrite k8sServiceHost and k8sServicePort for cilium, take a look at its values.yaml file.

Then specify these options in the values-cilium section of your Cozystack configuration, as shown below:

apiVersion: v1
kind: ConfigMap
metadata:
 name: cozystack
 namespace: cozy-system
data:
 bundle-name: "distro-full"
 ipv4-pod-cidr: "10.244.0.0/16"
 ipv4-svc-cidr: "10.96.0.0/16"
 values-cilium: |
 cilium:
 k8sServiceHost: 11.22.33.44
 k8sServicePort: 6443

Enabling and Disabling Components

Bundles have optional components that need to be explicitly enabled (included) in the installation. Regular bundle components can, on the other hand, be disabled (excluded) from the installation, when you don’t need them.

Telemetry

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

This document outlines the telemetry feature within the Cozystack project, detailing the rationale behind data collection, the nature of the data collected, data handling practices, and instructions for opting out.

Why We Collect Telemetry

Cozystack, as an open source project, thrives on community feedback and usage insights. Telemetry data allows maintainers to understand how Cozystack is being used in real-world scenarios. This data informs decisions related to feature prioritization, testing strategies, bug fixes, and overall project evolution. Without telemetry, decisions would rely on guesswork or limited feedback, which might slow down improvement cycles or introduce features that don’t align with users’ needs. Telemetry ensures that development is guided by actual usage patterns and community requirements, fostering a more robust and user-centric platform.