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/core-concepts/core-concepts.md
+17-7Lines changed: 17 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,18 +20,28 @@ The architecture documentation explains how in general DevStream works. If you h
20
20
21
21
DevStream defines your DevOps toolchain in config files.
22
22
23
-
The major part of the config file is definition of your DevOps _Tools_.
23
+
We have three config files:
24
24
25
-
Each _Tool_ has its name, instanceID (unique identifier), and options for that tool.
25
+
- main config file
26
+
- variable config file
27
+
- tool config file
26
28
27
-
Each _Tool_ can also have its dependencies, and can refer to other tool's output as values of its own options.
29
+
The main config file contains:
28
30
29
-
### 2. Tool
31
+
-`varFile`: the file path for the var file
32
+
-`toolFile`: the file path for the tool file
33
+
-`state`: settings related to the state. For more information, see [here](./stateconfig.md).
34
+
35
+
The variable config file is a YAML file containing keys and values, which can be used in the tool config file.
36
+
37
+
The tool config file a list of _Tools_, each containing its name, instanceID (unique identifier), and options for that tool.
30
38
31
-
//TODO(daniel-hutao): @IronCore Please help to update the descriptions below.
39
+
_Note: you can put multiple YAML files into the same one with three dashes (`---`) separating different files. Read more on this [here](https://stackoverflow.com/questions/50788277/why-3-dashes-hyphen-in-yaml-file) and [here](https://www.javatpoint.com/yaml-structure)._
40
+
41
+
### 2. Tool
32
42
33
-
-One of the major part of the _Config_ is a list of tools, defined in [here](https://github.com/devstream-io/devstream/blob/main/internal/pkg/configloader/config.go#L23).
34
-
- Each _Tool_ has its Name, InstanceID, and Options, as defined [here](https://github.com/devstream-io/devstream/blob/main/internal/pkg/configloader/config.go#L40).
43
+
-Each _Tool_ corresponds to a plugin, which can either be used to install, configure, or integrate some DevOps tools.
44
+
- Each _Tool_ has its Name, InstanceID, and Options, as defined [here](https://github.com/devstream-io/devstream/blob/main/internal/pkg/configloader/toolconfig.go#L13).
35
45
- Each _Tool_ can have its dependencies, which are specified by the `dependsOn` keyword.
36
46
37
47
The dependency `dependsOn` is an array of strings, with each element being a dependency. Each dependency is named in the format of "TOOL_NAME.INSTANCE_ID".
0 commit comments