Skip to content

Commit

Permalink
Merge pull request #5575 from werf/fix-docs
Browse files Browse the repository at this point in the history
[docs] Fix texts
  • Loading branch information
Zhbert committed Apr 28, 2023
2 parents 59b7bf5 + 8deb634 commit a9ad668
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 13 deletions.
20 changes: 10 additions & 10 deletions docs/pages_en/usage/build/images.md
Expand Up @@ -364,17 +364,17 @@ dependencies:

During the build, werf will automatically insert the appropriate names and identifiers into the referenced build-arguments. werf will take care of all orchestration and dependency mapping and then build everything in one step (as part of the `werf build` command).

## Building for target platform
## Building for the target platform

Using `--platform` parameter user can choose target platform for built images:
The user can choose the target platform for the images to be built using the `--platform` parameter:

```shell
werf build --platform linux/arm64
```

— werf builds all final images from werf.yaml for the target platform using emulation.
— werf builds all the final images from werf.yaml for the target platform using emulation.

You can also set target platform with `build.platform` configuration directive:
You can also set the target platform using the `build.platform` configuration directive:

```yaml
# werf.yaml
Expand All @@ -391,15 +391,15 @@ image: backend
dockerfile: backend/Dockerfile
```

In this case running `werf build` command without parameters will start building images for the specified platform (explicitly passed `--platform` parameter redefines werf.yaml setting).
In this case, running the `werf build` command without parameters will start the image build process for the specified platform (the explicitly passed `--platform` parameter will override the werf.yaml settings).

> **NOTE:** Preparation of host-system for multiplatform building, and also additional information about multiplatform support for different syntaxes and backends are available [in the building process article]({{ "/usage/build/process.html" | true_relative_url }}).
> **NOTE:** Refer to the [Build process]({{ "/usage/build/process.html" | true_relative_url }}) article for more information on multi-platform support for different syntaxes and backends, as well as on how to prepaare a host system for multi-platform builds.
### Build multiplatform images
### Building multiplatform images

werf supports buildling of images for multiple platforms at the same time. In such case werf publishes special manifest into the container registry, this manifest includes built images for each specified target platform (when pulling such an image a client will receive image built for the client platform).
werf supports simultaneous image building for multiple platforms. In this case, werf publishes a special manifest in the container registry, which includes the built images for each specified target platform (pulling such an image will provide the client with the image built for the client platform).

Tou can define list of target platforms with such configuration:
Here is how you can define a list of target platforms:

```yaml
# werf.yaml
Expand All @@ -412,7 +412,7 @@ build:
- linux/arm/v7
```

This list also can be redefined by the `--platform` parameter like that:
You can also override this list using the `--platform` parameter as follows:

```shell
werf build --platform=linux/amd64,linux/i386
Expand Down
6 changes: 4 additions & 2 deletions docs/pages_en/usage/build/process.md
Expand Up @@ -364,13 +364,15 @@ The format of `WERF_BUILDAH_ULIMIT=type=softlimit[:hardlimit][,type=softlimit[:h

### Multiplatform builds

Multiplatform building uses crossplatform instructions execution mechanics provided by the [linux kernel](https://en.wikipedia.org/wiki/Binfmt_misc) and qemu emulator. The easiest way to register the most architectures emulation in your host system is to use qemu-user-static like that:
Multiplatform builds use the cross-platform instruction execution mechanics provided by the [Linux kernel](https://en.wikipedia.org/wiki/Binfmt_misc) and the QEMU emulator. The easiest way to register emulators for most architectures on your host system is to use the `qemu-user-static` image:

```shell
docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
```

This table summarizes support of multiplatform building for different configuration syntax, modes of building and build backends:
[List of supported architectures](https://www.qemu.org/docs/master/about/emulation.html).

The table below summarizes support of multiplatform building for different configuration syntaxes, building modes, and build backends:

| | buildah | docker-server |
|--- |--- |--- |
Expand Down
4 changes: 3 additions & 1 deletion docs/pages_ru/usage/build/process.md
Expand Up @@ -364,12 +364,14 @@ werf может использовать драйвер хранилища `over

### Мультиплатформенная сборка

Мультиплатформенная сборка использует механизмы кроссплатформенного исполнения инструкций, предоставляемые [ядром linux](https://en.wikipedia.org/wiki/Binfmt_misc) и эмулятором qemu. Самый простой способ зарегистрировать в хост-системе эмуляторы для большинства архитектур — воспользоваться образом qemu-user-static:
Мультиплатформенная сборка использует механизмы кроссплатформенного исполнения инструкций, предоставляемые [ядром Linux](https://en.wikipedia.org/wiki/Binfmt_misc) и эмулятором QEMU. Самый простой способ зарегистрировать в хост-системе эмуляторы для большинства архитектур — воспользоваться образом `qemu-user-static`:

```shell
docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
```

[Перечень поддерживаемых архитектур](https://www.qemu.org/docs/master/about/emulation.html).

Поддержка мультиплатформенной сборки для разных вариантов синтаксиса сборки, режимов сборки и используемого бекенда:

| | buildah | docker-server |
Expand Down

0 comments on commit a9ad668

Please sign in to comment.