holos

README

Holos

Holos is a configuration management tool for Kubernetes implementing the rendered manifests pattern. It handles configurations ranging from single resources to multi-cluster platforms across regions.

Key components:

• Platform schemas defining component integration
• Building blocks unifying Helm, Kustomize and Kubernetes configs with CUE
• BuildPlan pipeline for generating, transforming and validating manifests

---
title: Rendering Overview
---
graph LR
    Platform[<a href="https://holos.run/docs/v1alpha5/api/author/#Platform">Platform</a>]
    Component[<a href="https://holos.run/docs/v1alpha5/api/author/#ComponentConfig">Components</a>]

    Helm[<a href="https://holos.run/docs/v1alpha5/api/author/#Helm">Helm</a>]
    Kustomize[<a href="https://holos.run/docs/v1alpha5/api/author/#Kustomize">Kustomize</a>]
    Kubernetes[<a href="https://holos.run/docs/v1alpha5/api/author/#Kubernetes">Kubernetes</a>]

    BuildPlan[<a href="https://holos.run/docs/v1alpha5/api/core/#BuildPlan">BuildPlan</a>]

    ResourcesArtifact[<a href="https://holos.run/docs/v1alpha5/api/core/#Artifact">Resources<br/>Artifact</a>]
    GitOpsArtifact[<a href="https://holos.run/docs/v1alpha5/api/core/#Artifact">GitOps<br/>Artifact</a>]

    Generators[<a href="https://holos.run/docs/v1alpha5/api/core/#Generator">Generators</a>]
    Transformers[<a href="https://holos.run/docs/v1alpha5/api/core/#Transformer">Transformers</a>]
    Validators[<a href="https://holos.run/docs/v1alpha5/api/core/#Validator">Validators</a>]
    Files[Manifest<br/>Files]

    Platform --> Component
    Component --> Helm --> BuildPlan
    Component --> Kubernetes --> BuildPlan
    Component --> Kustomize --> BuildPlan

    BuildPlan --> ResourcesArtifact --> Generators
    BuildPlan --> GitOpsArtifact --> Generators

    Generators --> Transformers --> Validators --> Files

Setup

brew install holos-run/tap/holos

Refer to setup for other installation methods and dependencies.

Example

See our tutorial for a complete hello world example.

package holos

holos: Component.BuildPlan

Component: #Helm & {
	Name: "podinfo"
	Chart: {
		version: "6.6.2"
		repository: {
			name: "podinfo"
			url:  "https://stefanprodan.github.io/podinfo"
		}
	}
	Values: ui: {
		message: string | *"Hello World" @tag(message, type=string)
	}
}

Organizational Role

Platform engineers use Holos to generate Kubernetes manifests, both locally and in CI pipelines. The manifests are committed to version control and deployed via GitOps tools like ArgoCD or Flux.

Holos integrates seamlessly with existing Helm charts, Kustomize bases, and other version-controlled configurations.

Advantages of Holos

Safe

Holos leverages CUE for strong typing and validation of configuration data, ensuring consistent output from Helm and other tools.

Consistent

A unified pipeline processes all configurations - whether from CUE, Helm, or Kustomize - through the same well-defined stages.

Flexible

Composable building blocks for generation, transformation, validation and integration let teams assemble workflows that match their needs.

The core is intentionally unopinionated about platform configuration patterns. Common needs like environments and clusters are provided as customizable topics recipes rather than enforced structures.

Getting Help

Get support through our Discord channel or GitHub discussions. Configuration challenges arise at all experience levels - we welcome your questions and are here to help.

License

Holos is licensed under Apache 2.0 as found in the LICENSE file.

Documentation

Overview

Package holos defines types for the rest of the system.

Index

• type FileContent
• type FilePath
• type InstancePath
• type PathCueMod

Types

type FileContent

type FileContent string

FileContent represents the contents of a file as a string.

type FilePath

type FilePath string

FilePath represents the path of a file relative to the current working directory of holos at runtime.

type InstancePath

type InstancePath string

A InstancePath is a string representing the absolute filesystem path of a holos instance. It is given a unique type so the API is clear.

type PathCueMod

type PathCueMod string

A PathCueMod is a string representing the absolute filesystem path of a cue module. It is given a unique type so the API is clear.