Merge pull request #20498 from Silthus/docs/local-config

docs: add example for including local catalog files
2023-10-11 11:50:13 +02:00
parent ec4a432c8d e57ba03798
commit 33de43f491
1 changed files with 14 additions and 0 deletions
@@ -44,6 +44,20 @@ When multiple `catalog-info.yaml` files with the same `metadata.name` property
 are discovered, one will be processed and all others will be skipped. This
 action is logged for further investigation.

+### Local File (`type: file`) Configurations
+
+In addition to url locations, you can use the `file` location type to bring in content from the local file system. You should only use this for local development, test setups and example data, not for production data.
+You are also not able to use placeholders in them like `$text`. You can however reference other files relative to the current file. See the full [catalog example data set here](https://github.com/backstage/backstage/tree/master/packages/catalog-model/examples) for an extensive example.
+
+Here is an example pulling in the `all.yaml` file from the examples folder. Note the use of `../../` to go up two levels from the current execution path of the backend. This is typically `packages/backend/`.
+
+```yaml
+catalog:
+  locations:
+    - type: file
+      target: ../../examples/all.yaml
+```
+
 ### Integration Processors

 Integrations may simply provide a mechanism to handle `url` location type for an