Reference For: developers, administrators

kyvernon system

The system command of the kyvernon CLI with its subcommands and arguments.

kyvernon system

Liveness, readiness and the controller's Prometheus metrics

Usage
kyvernon system <COMMAND>

Subcommands: health, ready, metrics, controller-backups, set-controller-backup, controller-backup

kyvernon system health

Liveness (/healthz)

Usage
kyvernon system health

API operation: GET /healthz

kyvernon system ready

Readiness (/readyz): exit code 1 when not ready

Usage
kyvernon system ready

API operation: GET /readyz

kyvernon system metrics

Controller metrics in Prometheus text format (/metrics)

Usage
kyvernon system metrics

API operation: GET /metrics

kyvernon system controller-backups

Archives of the controller state: where they go, the schedule, the last run

Usage
kyvernon system controller-backups

API operation: GET /v1/backup/controller

kyvernon system set-controller-backup

Change the schedule, folder and retention of the controller archives

Usage
kyvernon system set-controller-backup [OPTIONS]
ArgumentDescriptionRequired
--targetFolder on the controller the archives go to (absolute)yes
--scheduleHH:MM UTC or an interval such as 12h
--retentionArchives kept
default 7
--disabledKeep the schedule but take no archives on it

API operation: PUT /v1/backup/controller

kyvernon system controller-backup

Archive the controller state now (a task)

Usage
kyvernon system controller-backup [OPTIONS]
ArgumentDescriptionRequired
--waitWait for the task

API operation: POST /v1/backup/controller/run

Version 0.1.