config,docs: add templates as allowed kind and document process

2020-09-01 10:36:21 +02:00
parent 0627c24637
commit 81cb294dac
4 changed files with 31 additions and 2 deletions
@@ -58,6 +58,28 @@ Currently the catalog supports loading definitions from GitHub + Local Files. To
 load from other places, not only will there need to be another preparer, but the
 support to load the location will also need to be added to the Catalog.

+You can add the template files to the catalog through
+[static location configuration](../software-catalog/configuration.md#static-location-configuration),
+for example
+
+```yaml
+catalog:
+  locations:
+    - type: github
+      target: https://github.com/spotify/cookiecutter-golang/blob/master/template.yaml
+      allow: [Template]
+```
+
+Templates can also be added by posting the to the catalog directly. Note that if
+you're doing this, you need to configure the catalog to allow template entities
+to be ingested from any source, for example:
+
+```yaml
+catalog:
+  rules:
+    allow: [Component, API, Template]
+```
+
 For loading from a file, the following command should work when the backend is
 running: