Validate

Validate local config files satisfy a release’s schemas.

API key scopes

If validating from a CI pipeline, the following API key scopes are required:

releases:read
config_schemas:read

Usage

Current directory
Custom root
Device paths

By default, validating a deployment reads the config files from the current directory.

miru deployment validate \
  --release {release-version}

Use the --root flag to read the config files from a custom root directory.

miru deployment validate \
  --release {release-version} \
  --root {root-dir}

Use --root / to read config files from the exact location they are written to on production devices.

miru deployment validate \
  --release {release-version} \
  --root /

Use sudo miru ... to read config files from restricted paths.

Flags

string

required

Release version to validate against, matched exactly.Examples: v1.2.0

string

Directory to read config files from. Defaults to the current directory.Each slot is read from its device path relative to this directory, so /srv/miru/configs/mobility.json is read from {--root}/srv/miru/configs/mobility.json. Pass / to read files at their actual device paths.Examples: ./robot-42-fs, /

Examples

$ miru deployment validate \
    --release v1.2.0 \
    --root ./robot-42-fs

◐ Validating release v1.2.0

  /home/you/robot-42-fs
  └── srv/miru/configs
      ├── mobility.json  Mobility
      └── planning.json  Planning

✓ Deployment Valid

Authentication

Schemas

Configs

Releases

Devices

Deployments

Utilities

API key scopes

Usage

Examples

​API key scopes

​Usage

​Examples

API key scopes

Usage

Examples