Skip to content

Commit

Permalink
Merge pull request #4427 from fisuda/hardening/jp-doc-building
Browse files Browse the repository at this point in the history
(JP) FIX improve documentation about building Orion (#4426)
  • Loading branch information
fgalan authored Sep 11, 2023
2 parents 39aac51 + 79d878c commit dd2c914
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
2 changes: 2 additions & 0 deletions doc/manuals.jp/admin/build_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Orion Context Broker のリファレンス配布は Debian 12 です。これは、broker を他のディストリビューションに組み込むことができないことを意味しません (実際には可能です)。このセクションには、Debian を使用していない人に役立つ可能性があるため、他のディストリビューションに組み込む方法に関する指示が含まれる場合があります。ただし、"公式にサポートされている" 唯一の手順は Debian 12 用の手順です。

公式以外のディストリビューションで Docker コンテナ・イメージをビルドする方法は、Docker ドキュメントの [3.1 非公式ディストリビューションでのビルド](../../../docker/README.jp.md#31-building-in-not-official-distributions)・セクションで確認できます。

## Debian 12 (正式サポート)

Orion Context Broker は、以下のライブラリをビルドの依存関係として使用します :
Expand Down
10 changes: 9 additions & 1 deletion docker/README.jp.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Orion Context Broker を試してみたいし、データベースについて

`docker build` コマンドのパラメータ `-t orion` は、イメージに名前を付けます。この名前は何でもかまいませんし、`-t org/fiware-orion` のような組織も含めています。この名前は後でイメージに基づいてコンテナを実行するために使用されます。

上記のステップ3には、2つの Dockerfile が用意されています: Debian ベースの公式のもの (`Dockefile` 自体) と、公式ではありませんが、Alpine をベース・ディストリビューションとして使用する場合の開始点として役立つ `Dockefile.alpine` です。
上記のステップ3には、2つの Dockerfile が用意されています: Debian ベースの公式のもの (`Dockefile` 自体) と、公式ではありませんが、[Alpine](https://www.alpinelinux.org/) をベース・ディストリビューションとして使用する場合の開始点として役立つ `Dockefile.alpine` です。

`docker build` のパラメータ `--build-arg` はビルド時の変数を設定できます。

Expand All @@ -135,6 +135,14 @@ Orion Context Broker を試してみたいし、データベースについて

イメージとビルド・プロセスの詳細については、[Docker のドキュメント](https://docs.docker.com/userguide/dockerimages/)を参照してください。

<a name="31-building-in-not-official-distributions"></a>
### 3.1 非公式ディストリビューションでのビルド

[インストール・ドキュメントの要件セクション](../doc/manuals.jp/admin/install.md#requirements)で説明されているように、Debian 12 は公式にサポートされている唯一のディストリビューションです。ただし、次のコマンドは、代替ディストリビューションをベースとする Docker コンテナを構築するためにテストされています。

* Ubuntu 22.04 LTS: `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. その他の情報

Docker コンテナと Orion Context Broker を操作する際に留意すべき事項です。
Expand Down
4 changes: 2 additions & 2 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,8 @@ If you want to know more about images and the building process you can find it i
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`
* Ubuntu 22.04 LTS: `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

Expand Down

0 comments on commit dd2c914

Please sign in to comment.