README
¶
timoni
Timoni is a package manager for Kubernetes, powered by CUE and inspired by Helm.
The Timoni project strives to improve the UX of authoring Kubernetes configs. Instead of mingling Go templates with YAML like Helm, or layering YAML on top of each-other like Kustomize, Timoni relies on cuelang's type safety, code generation and data validation features to offer a better experience of creating, packaging and delivering apps to Kubernetes.
[!IMPORTANT] Note that Timoni in under active development and is still in its infancy. The APIs and command-line interface may change in a backwards incompatible manner.
Get Started
To get started with Timoni please visit the documentation website at timoni.sh.
Concepts
- Module - App definition containing Kubernetes CUE templates and configuration schema, distributed as OCI artifacts.
- Instance - App instantiation referencing the module and workloads deployed on a Kubernetes cluster.
- Bundle - App composition bundling multiple modules and configurations into a deployable unit.
- OCI Artifact - Packaging format used for distributing modules and bundles to container registries.
[!TIP] If you are familiar with Helm, a Timoni module is the equivalent of a chart, a Timoni bundle is the equivalent of an umbrella chart, and a Timoni instance is the equivalent of a Helm release.
Features
App Packaging and Distribution
Timoni enables software vendors to define complex application deployments, packaged as Modules, using type-safe Kubernetes templates and rich customisation options for end-users.
The app configuration packaged in a Module is distributed as an Open Container Initiative (OCI) artifact, next to the app images, in a container registry. Timoni Modules are semantically versioned and cryptographically signed.
With Timoni, platform engineers can manage the lifecycle of Kubernetes controllers, including the upgrade of CRDs. Module authors can import CRD schemas from YAML files and incorporate Kubernetes custom resources in their app deployments.
App Lifecycle Management
With Timoni, users can manage the whole lifecycle of applications deployed on Kubernetes. From highly customised installation to seamless upgrades, end-to-end testing, safe rollback and uninstallation.
With Timoni, users can bundle microservices and distributed monoliths into a deployable unit. The Timoni Bundle offers a declarative way of managing the app delivery across clusters, where secrets and other environment-specific config values are dynamically loaded during installation or upgrades.
License
Timoni is Apache 2.0 licensed and accepts contributions via GitHub pull requests. Please see the contributing guide for more information.
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v1alpha1
Package v1alpha1 contains the API Schema definitions for Timoni API.
|
Package v1alpha1 contains the API Schema definitions for Timoni API. |
|
cmd
|
|
|
timoni
command
|
|
|
internal
|
|
|
engine
Package engine manages the acquisition and compilation of Timoni's CUE modules.
|
Package engine manages the acquisition and compilation of Timoni's CUE modules. |
|
flags
Package flags contains common flags used by Timoni's commands.
|
Package flags contains common flags used by Timoni's commands. |
|
runtime
Package runtime manages the reflection of Timoni's instances on Kubernetes clusters.
|
Package runtime manages the reflection of Timoni's instances on Kubernetes clusters. |
|
Package schemas embeds the Timoni CUE schemas so that they can be consumed by the Go API as the single source of truth, while also being published as the importable 'timoni.sh/core/v1alpha1' package.
|
Package schemas embeds the Timoni CUE schemas so that they can be consumed by the Go API as the single source of truth, while also being published as the importable 'timoni.sh/core/v1alpha1' package. |