Skip to content

README.md

Latest commit

 

History

History
73 lines (46 loc) · 2.28 KB

README.md

File metadata and controls

73 lines (46 loc) · 2.28 KB

Updatecli Helm Charts

Release Charts

This repository contains the official Helm charts for the Updatecli project.

Charts

Chart Description Version
udash Udash — the Updatecli Dashboard web application (backend API + frontend SPA). udash
udash-agent Udash Agent — runs Updatecli on a schedule and ships reports to a Udash instance. udash-agent

Usage

Add the Helm repository

helm repo add updatecli https://updatecli.github.io/charts
helm repo update

Install a chart

# Udash dashboard
helm install udash updatecli/udash

# Udash agent
helm install udash-agent updatecli/udash-agent

See the individual chart READMEs for full configuration options:

Development

Prerequisites

Lint

make lint

Render templates locally

make template

Regenerate documentation

make docs

Note: README.md files inside each chart directory are auto-generated by helm-docs from values.yaml annotations and the README.md.gotmpl template. Do not edit them directly — edit the template or the annotations instead.

Contributing

Contributions are welcome! Please open an issue or a pull request.

This repository uses Updatecli itself to keep dependencies (Docker image tags, GitHub Actions) up to date automatically.

License

Apache 2.0