Skip to content

Commit

Permalink
FIX improve documentation about building Orion
Browse files Browse the repository at this point in the history
  • Loading branch information
fgalan committed Sep 11, 2023
1 parent 22af6eb commit 39aac51
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
2 changes: 2 additions & 0 deletions doc/manuals/admin/build_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Orion Context Broker reference distribution is Debian 12. This doesn't mean that the broker cannot be built in other distributions (actually, it can). This section may include indications on how to build in other distributions, just in the case it may help people that don't use Debian. However, note that the only "officially supported" procedure is the one for Debian 12.

You can also have a look to [3.1 Building in not official distributions](../../../docker/README.md#31-building-in-not-official-distributions) section in the Docker documentation to check how to build Docker containers images in distributions other than the official one.

## Debian 12 (officially supported)

The Orion Context Broker uses the following libraries as build dependencies:
Expand Down
10 changes: 9 additions & 1 deletion docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Check that everything works with

The parameter `-t orion` in the `docker build` command gives the image a name. This name could be anything, or even include an organization like `-t org/fiware-orion`. This name is later used to run the container based on the image.

Two Dockerfiles are provided for step 3 above: the official one (`Dockefile` itself) based in Debian and `Dockefile.alpine`, which is not official but in can be useful as starting point if you want to use Alpine as base distribution.
Two Dockerfiles are provided for step 3 above: the official one (`Dockefile` itself) based in Debian and `Dockefile.alpine`, which is not official but in can be useful as starting point if you want to use [Alpine](https://www.alpinelinux.org/) as base distribution.

The parameter `--build-arg` in the `docker build` can be set build-time variables.

Expand All @@ -137,6 +137,14 @@ The parameter `--build-arg` in the `docker build` can be set build-time variable

If you want to know more about images and the building process you can find it in [Docker's documentation](https://docs.docker.com/userguide/dockerimages/).

### 3.1 Building in not official distributions

As explained in the [requirements section of the installation documentation](../doc/manuals/admin/install.md#requirements), Debian 12 is the only officially supported
distribution. However, the following commands have been tested to build Docker containers based in alternative distributions:

* Ubuntu 22.04 TLS: `docker build -t orion-ubuntu22.04 --build-arg IMAGE_NAME=ubuntu --build-arg IMAGE_TAG=22.04 --build-arg CLEAN_DEV_TOOLS=0`
* Alpine 3.16.0: `docker build -t orion-alpine3.16 -f Dockerfile.alpine`

## 4. Other info

Things to keep in mind while working with docker containers and Orion Context Broker.
Expand Down

0 comments on commit 39aac51

Please sign in to comment.