[feat]Build multi-architecture Docker images for Python agent #297

jiang1997 · 2023-03-17T15:46:05Z

Closes: Build multi architecture Docker images for Python agent skywalking#10542
Update the CHANGELOG.md.

jiang1997 · 2023-03-17T15:51:47Z

I have simply tried docker build buildx by referring to apache/skywalking-eyes#132 .
But it turns out that skywalking-python can't be installed directly on linux/arm64.

 => => extracting sha256:a2ae4d14db5909da83c9bbe5296aa28df736473d058728285f074eda6e427b0e                                                                      0
 => [linux/amd64 2/2] RUN pip install --no-cache-dir "apache-skywalking[grpc]==0.8.0"                                                                         26
 => ERROR [linux/arm64 2/2] RUN pip install --no-cache-dir "apache-skywalking[grpc]==0.8.0"                                                                   10
------                                                                                                                                                          
 > [linux/arm64 2/2] RUN pip install --no-cache-dir "apache-skywalking[grpc]==0.8.0":                                                                           
#0 8.577 ERROR: Exception:
#0 8.577 Traceback (most recent call last):
#0 8.577   File "/usr/local/lib/python3.8/site-packages/pip/_internal/cli/base_command.py", line 167, in exc_logging_wrapper
#0 8.577     status = run_func(*args)
#0 8.577   File "/usr/local/lib/python3.8/site-packages/pip/_internal/cli/req_command.py", line 205, in wrapper
#0 8.577     return func(self, options, args)
#0 8.577   File "/usr/local/lib/python3.8/site-packages/pip/_internal/commands/install.py", line 285, in run
#0 8.577     session = self.get_default_session(options)
#0 8.577   File "/usr/local/lib/python3.8/site-packages/pip/_internal/cli/req_command.py", line 75, in get_default_session

To delve deeper, I'll be creating a Linux/ARM64 environment.

Superskyyy · 2023-03-17T17:54:27Z

Welcome back! Please remember to add a changelog for this feature.

Superskyyy · 2023-03-17T18:01:11Z

I cant tell what's wrong from the traceback you posted though.

kezhenxu94

I can build locally when I set the VERSION=1.0.0 (make build-image VERSION=1.0.0) so you might want to update your repo and set the same version.

We should also verify this in CI:
- Build docker images without pushing to remote registry in PR checks, with make build-image.
- Build and push images to ghcr.io with make push-image, example

docker/Makefile

jiang1997 · 2023-03-18T21:10:37Z

I have simply tried docker build buildx by referring to apache/skywalking-eyes#132 . But it turns out that skywalking-python can't be installed directly on linux/arm64.

 => => extracting sha256:a2ae4d14db5909da83c9bbe5296aa28df736473d058728285f074eda6e427b0e                                                                      0
 => [linux/amd64 2/2] RUN pip install --no-cache-dir "apache-skywalking[grpc]==0.8.0"                                                                         26
 => ERROR [linux/arm64 2/2] RUN pip install --no-cache-dir "apache-skywalking[grpc]==0.8.0"                                                                   10
------                                                                                                                                                          
 > [linux/arm64 2/2] RUN pip install --no-cache-dir "apache-skywalking[grpc]==0.8.0":                                                                           
#0 8.577 ERROR: Exception:
#0 8.577 Traceback (most recent call last):
#0 8.577   File "/usr/local/lib/python3.8/site-packages/pip/_internal/cli/base_command.py", line 167, in exc_logging_wrapper
#0 8.577     status = run_func(*args)
#0 8.577   File "/usr/local/lib/python3.8/site-packages/pip/_internal/cli/req_command.py", line 205, in wrapper
#0 8.577     return func(self, options, args)
#0 8.577   File "/usr/local/lib/python3.8/site-packages/pip/_internal/commands/install.py", line 285, in run
#0 8.577     session = self.get_default_session(options)
#0 8.577   File "/usr/local/lib/python3.8/site-packages/pip/_internal/cli/req_command.py", line 75, in get_default_session

To delve deeper, I'll be creating a Linux/ARM64 environment.

solved according to this docker/buildx#464 (comment)

jiang1997 · 2023-03-18T21:34:06Z

I can build locally when I set the VERSION=1.0.0 (make build-image VERSION=1.0.0) so you might want to update your repo and set the same version.

We should also verify this in CI:

Build docker images without pushing to remote registry in PR checks, with make build-image.

Build and push images to ghcr.io with make push-image, example

When building a new docker image with CI, would it be better to use the local skywalking-python package instead of the one provided by PyPI?

kezhenxu94 · 2023-03-19T00:16:50Z

I can build locally when I set the VERSION=1.0.0 (make build-image VERSION=1.0.0) so you might want to update your repo and set the same version.

We should also verify this in CI:

Build docker images without pushing to remote registry in PR checks, with make build-image.

Build and push images to ghcr.io with make push-image, example

When building a new docker image with CI, would it be better to use the local skywalking-python package instead of the one provided by PyPI?

Yes sure we should use the local skywalking Python package because that's what we want to verify.

jiang1997 · 2023-03-19T19:26:15Z

For now, the version number has to be set inside publish-docker.yaml.

.github/workflows/publish-docker.yaml

docker/Dockerfile

docker/Makefile

.github/workflows/publish-docker.yaml

docker/Dockerfile

kezhenxu94 · 2023-03-23T04:06:06Z

.github/workflows/publish-docker.yaml

+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build and push docker image
+        run: |
+          make push-image


I tried to build and push locally and hours passed it is still running, I think we can parallize this by adding make -j 10 push-image?

I have tried make -j 10 push-image, but seems that docker buildx can't run parallel.
Firstly, container skywalking_python_main can't be shared between parallel building tasks, secondly, even though we create target-specific containers, because this line works at system level, CI still runs into errors.

After some digging, I found that the most time-consuming step is building gRPC related whl packages when building image for arm64 python3.11. Cuz there is no needed binary whl package off the shelf so far. grpc/grpc#32454

I discovered that with the --builder option in Docker, we can make multiple targets simultaneously, but not to much(with make -j 10 may run out of disk space).
Compared with non-parallel building, we can save about 10 minutes.

kezhenxu94

I pushed this PR to a branch in the repo and the workflow is verified to work, @Superskyyy wanna check the images number?

https://github.com/apache/skywalking-python/pkgs/container/skywalking-python%2Fskywalking-python

kezhenxu94 · 2023-03-29T10:33:53Z

docker/Makefile

+push-py3.8-slim: BASE_PYTHON_IMAGE = python:3.8-slim
+push-py3.9-slim: BASE_PYTHON_IMAGE = python:3.9-slim
+push-py3.10-slim: BASE_PYTHON_IMAGE = python:3.10-slim
+push-py3.11-slim: BASE_PYTHON_IMAGE = python:3.11-slim


Do we need to remove this ? You removed 3.11 in the TARGETS

It's okay to remove it. I'm reserving it for future needs.

build docker images with buildx

6b56fda

Superskyyy added this to the 1.1.0 milestone Mar 17, 2023

Superskyyy added the feature New feature label Mar 17, 2023

Superskyyy assigned jiang1997 Mar 17, 2023

kezhenxu94 reviewed Mar 18, 2023

View reviewed changes

docker/Makefile Outdated Show resolved Hide resolved

docker/Makefile Outdated Show resolved Hide resolved

jiang1997 added 2 commits March 20, 2023 03:05

add a new workflow to push docker image

bb83dd4

update changelog.md

e62e608

jiang1997 changed the title ~~[wip]Build multi-architecture Docker images for Python agent~~ [feat]Build multi-architecture Docker images for Python agent Mar 19, 2023

jiang1997 marked this pull request as ready for review March 19, 2023 19:21

kezhenxu94 reviewed Mar 20, 2023

View reviewed changes

.github/workflows/publish-docker.yaml Outdated Show resolved Hide resolved

docker/Dockerfile Outdated Show resolved Hide resolved

jiang1997 force-pushed the multi-architecture branch 3 times, most recently from 0c73ead to 36c5c45 Compare March 20, 2023 16:04

add a extra stage to build package inside docker/dockerfile

51de7f4

jiang1997 force-pushed the multi-architecture branch from 36c5c45 to 51de7f4 Compare March 20, 2023 16:10

kezhenxu94 reviewed Mar 21, 2023

View reviewed changes

docker/Makefile Show resolved Hide resolved

.github/workflows/publish-docker.yaml Outdated Show resolved Hide resolved

.github/workflows/publish-docker.yaml Outdated Show resolved Hide resolved

docker/Dockerfile Outdated Show resolved Hide resolved

jiang1997 added 2 commits March 22, 2023 22:18

use commit sha as VERSION when publish docker image

1522969

remove whl file after install when build docker image

7e4099a

kezhenxu94 reviewed Mar 23, 2023

View reviewed changes

exclude py3.11

a258405

kezhenxu94 previously approved these changes Mar 25, 2023

View reviewed changes

wu-sheng and others added 2 commits March 25, 2023 12:02

Merge branch 'master' into multi-architecture

a473525

remove temporary files

78ff08b

jiang1997 dismissed kezhenxu94’s stale review via 78ff08b March 25, 2023 12:29

build parallel

d7a61ff

kezhenxu94 mentioned this pull request Mar 27, 2023

[GSOC][Feature] Python agent performance enhancement with asyncio apache/skywalking#10408

Closed

2 tasks

kezhenxu94 reviewed Mar 29, 2023

View reviewed changes

kezhenxu94 approved these changes Mar 30, 2023

View reviewed changes

Superskyyy approved these changes Mar 30, 2023

View reviewed changes

Superskyyy merged commit 128278a into apache:master Apr 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feat]Build multi-architecture Docker images for Python agent #297

[feat]Build multi-architecture Docker images for Python agent #297

jiang1997 commented Mar 17, 2023 •

edited

Loading

jiang1997 commented Mar 17, 2023

Superskyyy commented Mar 17, 2023 •

edited

Loading

Superskyyy commented Mar 17, 2023

kezhenxu94 left a comment

jiang1997 commented Mar 18, 2023

jiang1997 commented Mar 18, 2023 •

edited

Loading

kezhenxu94 commented Mar 19, 2023

jiang1997 commented Mar 19, 2023

kezhenxu94 Mar 23, 2023

jiang1997 Mar 24, 2023 •

edited

Loading

jiang1997 Mar 26, 2023 •

edited

Loading

kezhenxu94 left a comment

kezhenxu94 Mar 29, 2023

jiang1997 Mar 30, 2023

[feat]Build multi-architecture Docker images for Python agent #297

[feat]Build multi-architecture Docker images for Python agent #297

Conversation

jiang1997 commented Mar 17, 2023 • edited Loading

jiang1997 commented Mar 17, 2023

Superskyyy commented Mar 17, 2023 • edited Loading

Superskyyy commented Mar 17, 2023

kezhenxu94 left a comment

Choose a reason for hiding this comment

jiang1997 commented Mar 18, 2023

jiang1997 commented Mar 18, 2023 • edited Loading

kezhenxu94 commented Mar 19, 2023

jiang1997 commented Mar 19, 2023

kezhenxu94 Mar 23, 2023

Choose a reason for hiding this comment

jiang1997 Mar 24, 2023 • edited Loading

Choose a reason for hiding this comment

jiang1997 Mar 26, 2023 • edited Loading

Choose a reason for hiding this comment

kezhenxu94 left a comment

Choose a reason for hiding this comment

kezhenxu94 Mar 29, 2023

Choose a reason for hiding this comment

jiang1997 Mar 30, 2023

Choose a reason for hiding this comment

jiang1997 commented Mar 17, 2023 •

edited

Loading

Superskyyy commented Mar 17, 2023 •

edited

Loading

jiang1997 commented Mar 18, 2023 •

edited

Loading

jiang1997 Mar 24, 2023 •

edited

Loading

jiang1997 Mar 26, 2023 •

edited

Loading