From 5fc6d3493d16adf060332e1e14aa6e53d74b3a5b Mon Sep 17 00:00:00 2001 From: Brendan Melville Date: Thu, 12 Nov 2015 14:24:39 -0800 Subject: [PATCH 1/5] Adding documentation about type registries. --- docs/types/registry.md | 82 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 docs/types/registry.md diff --git a/docs/types/registry.md b/docs/types/registry.md new file mode 100644 index 000000000..ca5859ff7 --- /dev/null +++ b/docs/types/registry.md @@ -0,0 +1,82 @@ +# Type Registry + +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. + +## File structure +The repository must use the following file structure to store Deployment +Manager template types: + +``` +/ + types/ + / + / + + / + ... + / + ... +``` + +## Versions +Each type may contain any number of versions. Versions may be as simple as +`v1`, `latest`, or `head`, or may be more complex to contain major and minor +version numbers. Version format is user-defined. + +## Type files +Each type version must contain a top-level Deployment Manager template, named +either `.py` or `.jinja`, depending on the templating +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 `