Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 1.85 KB

README.md

File metadata and controls

56 lines (36 loc) · 1.85 KB
Raw

marathon-validate

A tiny command line tool to validate application or group configuration files for Marathon and DC/OS.

Purpose

If you're running a Mesos or DC/OS cluster and build custom applications for if, most of the time you'll have to create either a Marathon app definition JSON file, or a group definition JSON file.

As the structure of these files can get a little complicated, marathon-validate was created to be able to do a quick sanity check of these files from the command line.

Therefore, marathon-validate will use the JSON schema files contained in the Marathon GitHub project to validate the input file against.

Installation

To be able to use marathon-validate, you need to have Node.js (and NPM) installed on your system. Then you can use

npm install -g marathon-validate

to install it globally. You can verify the correct installation by issuing

$ marathon-validate --version
0.1.0

Usage

$ marathon-validate --help

  Usage: marathon-validate [options] <file>

  Options:

    -h, --help                output usage information
    -V, --version             output the version number
    -a, --app                 Check an App JSON
    -g, --group               Check a Group JSON
    -m, --marathon <version>  Use schema of specific Marathon version

If you want validate your application.json file in the current folder against the master version of the JSON schema, you can do a

$ marathon-validate -a application.json

To validate your application.json against a specific release version (e.g. v1.1.1), you can use

$ marathon-validate -a -m v1.1.1 application.json

This should work with all tags from the Marathon project.