Commit b9f135aa authored by Brendan Melville's avatar Brendan Melville

Some minor cleanups on the registry doc.

parent 0cdf40a7
......@@ -2,16 +2,19 @@
The Deployment Manager client allows you to deploy
[template types](https://github.com/kubernetes/deployment-manager/blob/master/docs/design/design.md#templates)
directly from a Github repository. In order for a repository to integrate with
Deployment Manager, it must store Deployment Manager templates in a manner that
conforms to the required **Type Registry** structure detailed below.
directly from a Github repository. You can use types from existing registries
or integrate with your own repository.
In order for a Github repository to integrate with Deployment Manager, it must
store Deployment Manager templates in a manner that conforms to the required
**Type Registry** structure detailed in this document.
## File structure
The repository must use the following file structure to store Deployment
Manager template types:
```
<repository root>/
<repository-root>/
types/
<type-1>/
<version-1>/
......@@ -34,9 +37,9 @@ language used for the type.
A
[template schema](https://github.com/kubernetes/deployment-manager/blob/master/docs/design/design.md#template-schemas)
must also be present, named `<template>.schema`. Other files
may exist as part of the type and imported through the schema, including
sub-templates, data files, or other metadata used by the template.
must also be present, named `<template>.schema` (e.g., `my-template.py.schema`).
Other files may exist as part of the type and imported through the schema,
including sub-templates, data files, or other metadata used by the template.
## Test Configuration
Each type version should include an example YAML configuration called
......@@ -55,7 +58,7 @@ An example of a valid type registry repository looks like:
redis.jinja
redis.jinja.schema
replicatedservice/
v1/
v3/
example.yaml
replicatedservice.py
replicatedservice.py.schema
......@@ -80,3 +83,8 @@ registry with the `--registry` flag:
$ dm --registry my-repo/registry deploy <type-name>:<version>
```
For types that require properties:
```
$ dm --properties prop1=value1,prop2=value2 deploy <type-name>:<version>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment