You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/modules/ROOT/pages/reference/architecture.adoc
+12-3Lines changed: 12 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,10 +25,19 @@ Commodore fetches the following dependencies:
25
25
=== Component discovery
26
26
27
27
To discover all required components, Commodore reads the https://reclass.pantsfullofunix.net/operations.html#yaml-fs-storage[`applications` array] which is made available by reclass.
28
-
Unless instructed otherwise, Commodore will fetch components from subfolder `commodore-components` in the xref:reference/cli.adoc#_catalog_compile[global Git base].
28
+
If a component should be disabled in a subset of the hierarchy, it can be removed from the `applications` array by adding the component name prefixed with a `~`.
29
29
30
-
The file `commodore.yml` in the root of the Global configuration repository can be used to override the repository autodiscovery for components.
31
-
The file must contain a key `components` which holds an array of dictionaries with keys `name` and `url`.
30
+
[source,yaml]
31
+
----
32
+
applications:
33
+
- ~component-to-remove
34
+
----
35
+
36
+
Note that this only works to remove components which have been included previously, and won't remove components that are included further down in the hierarchy.
37
+
38
+
Commodore currently has no mechanism to automatically discover components based on their names.
39
+
Instead all components which are referenced in the hierarchy must be listed in key `components` in the file `commodore.yml` in the root of the global configuration repository.
40
+
The key `components` holds an array of dictionaries with keys `name` and `url`.
32
41
Each array entry specifies the repository URL of a single component.
33
42
A sample `commodore.yml` can be found below.
34
43
The file `commodore.yml` is also used to define the xref:commodore:ROOT:reference:hierarchy.adoc[Commodore class hierarchy].
0 commit comments