Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ It uses the {{< product-c8y-iot >}} [@c8y/client JavaScript library](https://www

- {{< product-c8y-iot >}} credentials (tenant, user and password).
- Slack channel to post messages to, [Slack app and OAuth token](https://slack.dev/node-slack-sdk/getting-started).
- Docker local installation.
- Docker local installation in a version not newer than v27.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Robert, the proposed update (whole PR) is valid for the 2025 annual release only. In terms of GitHub branches: this update should be merged to release/y2025 but not develop.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Were you able to reproduce the error when using Docker v28+?

- A *.env* file in the root directory with the following content:

```properties
Expand All @@ -23,6 +23,10 @@ SLACK_OAUTH_TOKEN=<YOUR-TOKEN-GOES-HERE>
SLACK_CHANNEL_ID=<YOUR-CHANNEL_ID-GOES-HERE>
```

{{< c8y-admon-info >}}
For building Docker images, the Docker engine version must not be newer than v27.
{{< /c8y-admon-info >}}

### Developing the microservice {#developing-the-microservice}

#### Configure a Node.js application {#configure-a-nodejs-application}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,19 @@ In this tutorial, you will learn how to create and run a microservice written in

Create an account on [{{< domain-c8y >}}](https://{{< domain-c8y >}}), for example by using a free trial. At this step you will be provided with a dedicated URL that you can also use to test your microservice below.

Make sure that you have a recent version of Docker installed. You can, for example, install [Docker Desktop](https://www.docker.com/products/docker-desktop/) for your operating system.
Make sure that you have a Docker version not newer than v27 installed. You can, for example, install [Docker Desktop](https://www.docker.com/products/docker-desktop/) for your operating system.

{{< product-c8y-iot >}} hosts linux/amd64 Docker containers. If you run, for example, a recent Mac with Apple silicon, you need to configure Docker to build linux/amd64 containers:

```shell
$ export DOCKER_DEFAULT_PLATFORM=linux/amd64
```

{{< c8y-admon-info >}}
For building Docker images, the Docker engine version must not be newer than v27.
{{< /c8y-admon-info >}}


### Create a sample Python web application {#create-a-python-web-application}

This example uses Python 3 with the [Flask](https://flask.palletsprojects.com/) web framework and the [Waitress](https://docs.pylonsproject.org/projects/waitress/en/latest/) HTTP server. Start by creating the _application.py_ script with the following content:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -514,6 +514,10 @@ used for the microservice start without further verification. For example be sur
condition: Xms < Xmx.
{{< /c8y-admon-info >}}

{{< c8y-admon-info >}}
For building Docker images, the Docker engine version must not be newer than v27.
{{< /c8y-admon-info >}}

##### Setting parameters on command line {#package-goal-command-line}

For information about how and whether it is possible to set parameters on command line refer to column
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ OS name: "mac os x", version: "10.14.6", arch: "x86_64", family: "mac"

You will also need a Docker installation, and in case that you don't have it yet, go to the [Docker website](https://www.docker.com/get-started) to download and install it.

{{< product-c8y-iot >}} microservices are Docker containers for the Linux/Amd64 platform. Other architectures are currently not supported. The Docker engine must provide the API version 1.38 or newer. This is the case for Docker versions 18.06 and later. Use the following command to verify your Docker installation:
{{< product-c8y-iot >}} microservices are Docker containers for the Linux/Amd64 platform. Other architectures are currently not supported. The Docker engine must provide the API version 1.38 or newer. This is the case for Docker versions 18.06 and later.
However, the Docker version must not be newer than v27. Use the following command to verify your Docker installation:

```shell
$ docker version
Expand Down