Mesosphere Universe

The Mesosphere package repository.

Package entries

Organization

Packages are encapsulated in their own directory, with one subdirectory for each package version.

└── foo
    ├── 0
    │   ├── command.json
    │   ├── marathon.json
    │   └── package.json
    ├── 1
    │   ├── command.json
    │   ├── marathon.json
    │   └── package.json
    └── ...

Sample package directory layout.

Content

`package.json`

{
  "name": "foo",
  "version": "1.2.3",
  "scm": "https://github.com/bar/foo.git",
  "maintainer": "help@bar.io",
  "description": "Does baz."
}

Sample package.json (minimal).

Additionally, site-specific metadata and dependencies may be specified, as shown in the following example.

{
  "name": "foo",
  "version": "1.2.3",
  "scm": "https://github.com/bar/foo.git",
  "maintainer": "help@bar.io",
  "website": "http://bar.io/foo",
  "description": "Does baz.",
  "dataSchema": {
    "type": "object",
    "properties": {
      "foo.baz": {
        "type": "integer",
        "description": "How many times to do baz.",
        "minimum": 0,
        "maximum": 16,
        "required": false,
        "default": 4
      }
    },
    "required": ["foo.baz"]
  },
  "dependencies": [
    { "name": "biz", "version": "1.2.+" }
  ]
}

Sample package.json (advanced).

`marathon.json`

This file describes how to run the package as a Marathon app.

User-supplied metadata (as described in package.json) can be injected using moustache template systax.

{
  "id": "foo",
  "cpus": "1.0",
  "mem": "1024",
  "instances": "1",
  "args": ["{{{foo.baz}}}"],
  "container": {
    "type": "DOCKER",
    "docker": {
      "image": "bar/foo",
      "network": "BRIDGE",
      "portMappings": [
        {
          "containerPort": 8080,
          "hostPort": 0,
          "servicePort": 0,
          "protocol": "tcp"
        }
      ]
    }
  }
}

Sample marathon.json.

See the Marathon API Documentation for more detailed instruction on app definitions.

`command.json`

This file is optional. Describes how to install the package's CLI. Currently the only supported format is a Python egg.

{
  "python": "https://pypi.python.org/packages/source/f/foo/foo-1.2.3.tar.gz"
}

Sample command.json.

Validation

Package content is validated using JSON Schema. The schema definitions live in /repo/meta/schema.

Directory Structure

├── LICENSE
├── README.md
├── docs
│   ├── best-practices.md
│   └── contributing.md
├── hooks
│   └── pre-commit
├── repo
│   ├── meta
│   │   ├── index.json
│   │   ├── index.json.gz
│   │   ├── schema
│   │   │   ├── command-schema.json
│   │   │   ├── index-schema.json
│   │   │   ├── marathon-schema.json
│   │   │   └── package-schema.json
│   │   └── version.json
│   └── packages
│       ├── B
│       │   ├── bar
│       │   │   ├── 0
│       │   │   │   ├── command.json
│       │   │   │   ├── marathon.json
│       │   │   │   └── package.json
│       │   │   └── ...
│       │   └── ...
│       ├── F
│       │   ├── foo
│       │   │   ├── 0
│       │   │   │   ├── marathon.json
│       │   │   │   └── package.json
│       │   │   └── ...
│       │   └── ...
│       └── ...
└── scripts
    ├── 1-validate-packages.sh
    ├── 2-build-index.sh
    ├── 3-validate-index.sh
    ├── 4-detect-dependency-cycles.sh
    ├── build.sh
    └── install-git-hooks.sh

cmaloney/universe