myriarchd
Myriarch server - OpAMP based management of OpenTelemetry Collectors.
CLI reference
Reference of every command and option of the myriarch binaries, generated from the command line definitions.
This directory is generated from the command line definitions of the binaries by make docs-gen. Do not edit the files by hand: make docs-check fails when they differ from the code.
| Command | Description |
|---|---|
| myriarchd | Myriarch server - OpAMP based management of OpenTelemetry Collectors |
| myrctl | Validate and render myriarch GitOps repositories |
| myriarch-updater | Myriarch host agent: installs collector updates offered via OpAMP |
| myriarch-sim | Simulate OpAMP supervisors and myriarch-updaters against myriarchd |
The short name myr is an optional alias of myrctl. It is not installed and not shipped as a second binary: create it yourself, for example with alias myr=myrctl in a POSIX shell or Set-Alias myr myrctl in PowerShell. Everything documented for myrctl applies to myr.
myriarchd auth
Helpers for the credentials of the bootstrap admin.
myriarchd auth hash-password
Print the bcrypt hash of a password read from standard input.
myriarchd config
Check and inspect a myriarchd configuration without starting myriarchd.
myriarchd config print
Print the effective configuration (defaults, file, environment) as YAML, secrets redacted.
myriarchd config validate
Check a configuration exactly like myriarchd serve loads it, without starting anything.
myriarchd dev
Run myriarchd for local development (embedded PostgreSQL, dev login, quickstart GitOps repo).
myriarchd healthcheck
Check that a running myriarchd is ready and serves its OpAMP endpoint.
myriarchd migrate
Apply database migrations and exit.
myriarchd serve
Run the myriarchd server.
myriarchd version
Print the version.
myrctl
Validate and render myriarch GitOps repositories.
myrctl render
Render the collector config of a fleet for a (sample) agent.
myrctl validate
Validate all objects of a GitOps repository (default dir: .).
myrctl version
Print the version.
myriarch-updater
Myriarch host agent: installs collector updates offered via OpAMP.
myriarch-updater container
Run as PID 1 of a container: supervise the OpAMP supervisor and update the collector binary on a volume.
myriarch-updater copy
Copy a regular file atomically (for init containers without a shell).
myriarch-updater fetch-trusted-root
Fetch the Sigstore trusted root via TUF and write it as trusted_root.json (diagnostics, mirror image build).
myriarch-updater install
Install myriarch-updater as OS service (systemd unit / Windows service).
myriarch-updater install-self
Copy this binary into a directory as myriarch-updater (for init containers).
myriarch-updater licenses
Print the license of myriarch, or with –third-party the notices of the included software.
myriarch-updater run
Run the updater (foreground or as OS service).
myriarch-updater start
Start the service.
myriarch-updater status
Show the service state (and, with –config, the installed collector version).
myriarch-updater stop
Stop the service.
myriarch-updater uninstall
Stop and remove the myriarch-updater service.
myriarch-updater verify-bundle
Verify an artifact against a Sigstore bundle offline (diagnostics).
myriarch-updater version
Print the version.
myriarch-sim
Simulate OpAMP supervisors and myriarch-updaters against myriarchd.
myriarch-sim run
Run the simulation.
myriarch-sim version
Print the version.