elodina/universe

Name: universe

Owner: Elodina

Description: The Mesosphere Universe package repository.

Created: 2015-08-16 00:08:49.0

Updated: 2015-12-23 03:16:29.0

Pushed: 2015-12-24 13:23:24.0

Homepage: http://mesosphere.github.io/universe

Size: 614

Language: Python

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Mesosphere Universe Build Status

The DCOS package repository for packages that have been certified by Mesosphere.

Experimental packages can be found in the Multiverse repository.

Installation

The DCOS CLI comes pre-configured to use the Universe repository.

If you would like to add this to your CLI manually:

 config prepend package.sources https://github.com/mesosphere/universe/archive/version-1.x.zip
Branches

The default branch for this repository is version-1.x, which reflects the current schema for the Universe. In the future, if the format changes significantly, there will be additional branches.

The cli-tests branch is used for integration testing by the DCOS CLI and provides a fixed and well known set of packages to write tests against.

Contributing a Package

Interested in making your package or service available to the world? The instructions below will help you set up a local copy of the Universe for development.

Local Set Up

  1. Clone the repo (or you may wish to fork it first):

    clone https://github.com/mesosphere/universe.git /path/to/universe

  2. You may need to install the jsonschema Python package if you don't have it:

     pip install jsonschema

  3. Install pre-commit hook:

     /path/to/universe/scripts/install-git-hooks.sh

  4. To use the local cloned repository from the DCOS CLI for testing your own package:

     config prepend package.sources "file:///path/to/universe"

The pre-commit hook will run build.sh before allowing you to commit. This script validates your package definitions and regenerates the index file. You may need to git add repo/meta/index.json after running it once before you are able to pass validation and commit your changes.

Whenever you make changes locally, be sure to update the CLI's cache to pick them up:

 package update
Merging to Universe

Before merging to Universe, you must run build.sh to regenerate the package index. If you have installed the pre-commit hook as above, this will be done automatically on commit.

Packages in the Universe are required to pass Mesosphere certification. The certification requirements for the Multiverse repository are less strict, which is preferable for alpha or beta quality packages. Full certification requirements are available from Mesosphere support.

Once your package meets these requirements, please submit a pull request against the version-1.x branch with your changes.

Package entries
Organization

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

foo
??? 0
?   ??? command.json
?   ??? config.json
?   ??? marathon.json
?   ??? package.json
??? 1
?   ??? command.json
?   ??? config.json
?   ??? marathon.json
?   ??? package.json
??? ...

Sample package directory layout.

Content
package.json 

ame": "foo",
ersion": "1.2.3",
ags": ["mesosphere", "framework"],
aintainer": "help@bar.io",
escription": "Does baz.",
cm": "https://github.com/bar/foo.git",
ebsite": "http://bar.io/foo",
mages": {
"icon-small": "http://some.org/foo/small.png",
"icon-medium": "http://some.org/foo/medium.png",
"icon-large": "http://some.org/foo/large.png",
"screenshots": [
  "http://some.org/foo/screen-1.png",
  "http://some.org/foo/screen-2.png"
]

ostInstallNotes": "Have fun foo-ing and baz-ing!"

Sample package.json.

The required fields are:

While images is an optional field, it is highly recommended you include icons and screenshots in your package and update the path definitions accordingly. Specifications are as follows:

NOTE: To ensure your service icons look beautiful on retina-ready displays, please supply 2x versions of all icons. No changes are needed to package.json - simply supply an additional icon file with the text @2x in the name before the file extension. For example, the icon icon-cassandra-small.png would have a retina-ready alternate image named icon-cassandra-small@2x.png.

config.json

This file describes the configuration properties supported by the package. Each property can specify whether or not it is required, a default value, as well as some basic validation.

Users can then override specific values at installation time by passing an options file to the DCOS CLI.


ype": "object",
roperties": {
"foo": {
  "type": "object",
  "properties": {
    "baz": {
      "type": "integer",
      "description": "How many times to do baz.",
      "minimum": 0,
      "maximum": 16,
      "required": false,
      "default": 4
    }
  },
  "required": ["baz"]
}

equired": ["foo"]

Sample config.json.

config.json must be a valid JSON Schema file. Check out the JSON Schema examples.

marathon.json

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

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


d": "foo",
pus": "1.0",
em": "1024",
nstances": "1",
rgs": ["{{{foo.baz}}}"],
ontainer": {
"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 Pip requirements file where each element in the array is a line in the requirements file.


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

Sample command.json.

See the Command Schema for a detailed description of the schema.

Versioning

The registry specification is versioned separately in the file /repo/meta/version.json.


ersion": "0.1.0-alpha"

Sample repo/meta/version.json.

This version is updated with any change to the required file content (typically validated using JSON schema) or expected file organization in the repo directory.

NOTE: The current version is 0.1.0-alpha to facilitate rapid iteration. This version will be fixed and incremented as described above as programs that consume the format reach maturity.

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
?   ??? schema
?   ?   ??? command-schema.json
?   ?   ??? config-schema.json
?   ?   ??? index-schema.json
?   ?   ??? marathon-schema.json
?   ?   ??? package-schema.json
?   ??? version.json
??? packages
    ??? B
    ?   ??? bar
    ?   ?   ??? 0
    ?   ?   ?   ??? command.json
    ?   ?   ?   ??? config.json
    ?   ?   ?   ??? marathon.json
    ?   ?   ?   ??? package.json
    ?   ?   ??? ...
    ?   ??? ...
    ??? F
    ?   ??? foo
    ?   ?   ??? 0
    ?   ?   ?   ??? config.json
    ?   ?   ?   ??? 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
Sources and Transfer Protocols

This section describes transfer of package metadata from a universe source to a client program.

??????????????   ??????????????????
blic universe?   ?private universe?
??????????????   ??????????????????
      git \         / http
           \       /
            \     /
           ????????           ??????????
           ?client?-----------?marathon?
           ????????    http   ??????????
              |
              |
        ?????????????
        ?local cache?
        ?????????????

Sample (simplified) architecture for a universe client program.

Package sources are described as URLs.

Source URLs encode the transfer protocol. Recommendations for several transfer protocols follow.

Filesystem

A URL that designates a local directory.
Example: file:///some/nfs/mount/universe

Git

A URL that designates a git repository.
Example: git://github.com/mesosphere/universe.git

HTTP and HTTPS

A URL that designates a zip file accessible over HTTP or HTTPS with media type application/zip.
Example: http://my.org/files/universe/packages.zip

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.