diff --git a/docs/types/registry.md b/docs/types/registry.md new file mode 100644 index 000000000..f1484c95a --- /dev/null +++ b/docs/types/registry.md @@ -0,0 +1,90 @@ +# 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. You can use types from existing repositories +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: + +``` +/ + types/ + / + / + + / + ... + / + ... +``` + +## Versions +Types are versioned based on [Semantic Versioning](http://semver.org/), for +example, *v1.1.0*. A type may have any number of versions. + +## Types +Each type version must contain a top-level Deployment Manager template +[Deployment Manager template](https://github.com/kubernetes/deployment-manager/blob/master/docs/design/design.md#templates) +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 `