msb-public
/
helm
mirror of https://github.com/helm/helm
1
0
Code Issues Projects Releases Wiki Activity

Some minor cleanups on the registry doc.

Browse Source
pull/69/head
Brendan Melville 9 years ago
parent 0cdf40a7d1
commit b9f135aa8f
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File

24
docs/types/registry.md
Unescape View File

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

Write Preview
Loading…
Cancel
Save