Skip to content

Commit 3d32afe

Browse files
docs: DOC-2374 Edit Docker customization step for Trusted boot (#9729) (#9741)
* Edit Docker customization step for Trusted boot * ci: auto-formatting prettier issues * Update build-trusted-iso.md --------- (cherry picked from commit b09f7a2) Co-authored-by: svetlana-efimova <svetlana.efimova@spectrocloud.com> Co-authored-by: svetlana-efimova <205686560+svetlana-efimova@users.noreply.github.com>
1 parent bb18c59 commit 3d32afe

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

docs/docs-content/clusters/edge/trusted-boot/edgeforge/build-trusted-iso.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,20 @@ This document guides you through the process of producing Edge Installer ISOs th
8888

8989
:::
9090

91-
8. Customize the `Dockerfile`. You can install tools and dependencies and configure the image to meet your needs. Add
91+
8. Customize the `Dockerfile` as needed. You can install tools and dependencies and make other image modifications. Add
9292
your customizations below the line tagged with the `Add any other image customizations here` comment in the
93-
Dockerfile. Do not edit or add any lines before this tagged comment. For example, you can add the following line to
94-
the `Dockerfile` to install WireGuard.
93+
`Dockerfile`. Do not edit or add any lines before this tagged comment.
94+
95+
:::warning
96+
97+
When customizing the `Dockerfile` to add custom binaries, install them into `/usr/bin`. Do not use `/usr/local`, as
98+
this directory is mounted from the persistent partition at boot and makes files added during image build unavailable
99+
at runtime.
100+
101+
:::
102+
103+
For example, you can add the following line to the `Dockerfile` to install
104+
[WireGuard](https://www.wireguard.com/install/).
95105

96106
```dockerfile
97107
...
@@ -100,14 +110,25 @@ This document guides you through the process of producing Edge Installer ISOs th
100110
RUN sudo zypper refresh && sudo zypper install --non-interactive wireguard-tools
101111
```
102112

113+
Package installation commands in the `Dockerfile` must be non-interactive. Ensure you use the appropriate
114+
non-interactive flag for your package manager, for example, `--non-interactive` for Zypper or `--yes` for Advanced
115+
Package Tool (APT). Interactive prompts cause the image build to fail. This guidance applies to all dependencies you
116+
add through the `Dockerfile`.
117+
118+
View the `Dockerfile` to ensure the instruction to install WireGuard is appended correctly.
119+
120+
```bash
121+
cat Dockerfile
122+
```
123+
103124
:::warning
104125

105-
Adding software dependencies in the Dockerfile will cause the size of the Extensible Firmware Interface (EFI) file to
106-
grow. Most hardware has a limit on the size of the EFI that it can boot. Make sure you do not include too many
126+
Adding software dependencies in the `Dockerfile` will cause the size of the Extensible Firmware Interface (EFI) file
127+
to grow. Most hardware has a limit on the size of the EFI that it can boot. Make sure you do not include too many
107128
dependencies that can cause the EFI file to grow larger than the boot limit. For more information, refer to
108129
[Check EFI Boot Limit](./check-efi-limit.md).
109130

110-
Instead of adding software packages through the Dockerfile to the OS layer, you can add compiled static binaries to
131+
Instead of adding software packages through the `Dockerfile` to the OS layer, you can add compiled static binaries to
111132
the persistent partition instead, which does not increase the size of the EFI file. Refer to
112133
[Add Static Binaries to Persistent Partition](./add-extra-content.md) for more information.
113134

0 commit comments

Comments
 (0)