Create a Docker-Compose App¶
In the Configuring Git section, you should have set up git
with your
auth token, meaning you can clone your Factory repositories from
https://source.foundries.io/factories/<factory>/
and begin creating new
Targets for your devices to update to.
Example Apps¶
This default example shows how apps are enabled. You should read the contents of
the shellhttpd
folder to see how this application has been defined, or read
the other examples to learn how you can define an app from scratch.
Clone your containers.git repo and enter it:
We initialise your
containers.git
repository with a simple compose app example inshellhttpd.disabled/
Tip
Directory names ending with
.disabled
in containers.git are ignored by our CI system.Enable the
shellhttpd
example app:Add, commit and push:
-
When changes are made to
containers.git
in your Factory sources, a new Target is built by our CI system. Devices that are registered to your Factory will be able to see this Target and conditionally update to it, depending on their device configuration.
Device Configuration
Once the Target is built successfully, any devices that are registered to
the Factory will begin updating to this new Target. The app shellhttpd
that has been defined will be available for usage in this Target. This can
be verified by running:
By default devices will run all applications that are defined in the containers.git repository and therefore available in the latest Target. This behavior can be changed by enabling only specific applications. Read Enabling/Disabling Apps to learn how.
This example describes how to create a docker-compose app for the Mosquitto MQTT Broker from scratch.
Clone your containers.git repo and enter it. Make sure to replace
<factory>
in the example with the name of your Factory:Create a directory named
mosquitto
andcd
into it. This folder name defines the name of the container image that will be pulled on your device fromhub.foundries.io
:Create a file named
Dockerfile
to describe your container, with the following contents:Create a file named
docker-compose.yml
to describe how you want this container to run, with the following contents. Make sure to replace<factory>
in the example below with the name of your Factory:Add, commit and push:
-
When changes are made to
containers.git
in your Factory sources, a new Target is built by our CI system. Devices that are registered to your Factory will be able to see this Target and conditionally update to it, depending on their device configuration.
Device Configuration
Once the Target is built successfully, any devices that are registered to
the Factory will begin updating to this new Target. The app mosquitto
that has been defined will be available for usage in this Target. This can
be verified by running:
By default devices will run all applications that are defined in the containers.git repository and therefore available in the latest Target. This behavior can be changed by enabling only specific applications. Read Enabling/Disabling Apps to learn how.
About Targets¶
You can see the available Targets your Factory has produced:
CLI Output:
details about Target can be printed by passing its version number to the
show
subcommand:
CLI Output:
Tags: master
CI: https://ci.foundries.io/projects/gavin/lmp/builds/4/
Source:
https://source.foundries.io/factories/gavin/lmp-manifest.git/commit/?id=2aaebc4b16c1027c9aae167d6178a8f248027a73
https://source.foundries.io/factories/gavin/meta-subscriber-overrides.git/commit/?id=19cbbe7b890eafed4d88e1fb13d2d61ecef8f3e5
https://source.foundries.io/factories/gavin/containers.git/commit/?id=6a2ef8d1dbab0db634c52950ae4a7c18494021b2
TARGET NAME OSTREE HASH - SHA256
----------- --------------------
raspberrypi3-64-lmp-4 1b0df36794efc32f1c569c8d61f115b04c4d51caa2fa99c17ec85384ae06518d
DOCKER APP VERSION
---------- -------
shellhttpd shellhttpd.dockerapp-4
Completion¶
Now that you’re done, you might want to read Tutorials to see some examples of the things that can be done with your Factory. Additionally, you can read the Reference Manual to learn more about the architecture of FoundriesFactory and the Linux microPlatform.