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
{{ message }}
This repository was archived by the owner on Feb 24, 2021. It is now read-only.
refactor: Create new compose-builder for generating compose files (#336)
* refactor: Create new compose-builder for generating compose files
Moved all new files from release/nightly-build/compose-files/source to top level compose-builder folder.
Refactored makefiles to account for new file locations
Updated READMEs to account for these changes
closes#335
* refactor: Remove build from makefile in nightly-build/compose-files
* refactor: Change to use `make -C` on portainer targets.
Copy file name to clipboardExpand all lines: compose-builder/README.md
+17-10Lines changed: 17 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,19 @@
1
1
2
2
3
-
## Source for Edgex Docker Compose for `master` builds
3
+
## Edgex Docker Compose Builder
4
4
5
-
This folder contains the **source** compose and environment files for generating the single file docker composes files one level up.
6
-
7
-
> **Note**:
8
-
> *The files here are targeted for EdgeX community developers. Those just needing to run Edgex should use the generated compose files and Makefile one level up. See the accompanying [README](../README.md) for details.*
5
+
This folder contains the `Compose Builder` which is made up of **source** compose and environment files and **makefile** for building the single file docker composes files for the configured `release`. The default release is `nexus` and the files are placed in `release/nightly-build/compose-files`.
9
6
10
7
> **Note to Developers**:
11
-
> *Once you have edited and tested your changes to these source files you **MUST** regenerate the composes using the `Makefile` one level up. See `build-all` in the accompanying [README](../README.md) for details.*
8
+
> *Once you have edited and tested your changes to these source files you **MUST** regenerate the composes using the `make build` command.*
9
+
10
+
Do the following to build compose files for next release such as `hanoi`
11
+
12
+
1. Update the `RELEASE`, `REPOSITORY`, `CORE_EDGEX_REPOSITORY` and `versions` contained in the `.env` file.
13
+
2. Create the release folder, i.e `release/hanoi/compose-files`
14
+
3. Run `make build`
15
+
4.**Undo changes made to `.env` file**. (committed values **must** remain as `nexus/nightly-build`)
16
+
5. Commit changes and open PR
12
17
13
18
The approach used with these source compose files is the `Extending using multiple Compose files` described here: https://docs.docker.com/compose/extends/#multiple-compose-files
14
19
@@ -51,7 +56,7 @@ This folder contains the following compose files:
51
56
This folder contains the following environment files:
52
57
53
58
-**.env**
54
-
This file contains the registry and image version variables referenced in compose files. Docker compose implicitly uses the ".env" file, if it exists, so you will not see it referenced in the compose files. It is referenced in the Makefile so that it can also use these settings.
59
+
This file contains the `version`, `repositories`and image `version` variables referenced in compose files. Docker compose implicitly uses the `.env` file, if it exists, so you will not see it referenced in the compose files. It is referenced in the Makefile so that it can also use these settings.
55
60
-**common.env**
56
61
This file contains the common environment overrides used by all Edgex services.
57
62
-**common-security.env**
@@ -72,7 +77,8 @@ portainer-down Stops Portainer independent of the EdgeX services
72
77
```
73
78
```
74
79
build
75
-
Generates the all standard Edgex compose file variations and stores them one directory level up. Each variation, except UI, includes Device REST & Device Virtual
80
+
Generates the all standard Edgex compose file variations and stores them in the configured relese folder. Each variation, except UI, includes Device REST & Device Virtual. Compose files are named appropriatly for release and options used to generate them.
81
+
76
82
Current variations are:
77
83
full secure
78
84
full secure for arm64
@@ -84,7 +90,8 @@ Current variations are:
84
90
85
91
```
86
92
compose [options]
87
-
Generates the EdgeX compose file as specified by options and stores it one directory level up with appropriate name for the options used.
93
+
Generates the EdgeX compose file as specified by options and stores them in the configured relese folder. Compose files are named appropriatly for release and options used to generate them.
0 commit comments