Skip to content

Commit 1b52246

Browse files
docs: DOC-2374 Edit Docker customization step for Trusted boot (#9729) (#9743)
* Edit Docker customization step for Trusted boot * ci: auto-formatting prettier issues * Update build-trusted-iso.md --------- Co-authored-by: svetlana-efimova <205686560+svetlana-efimova@users.noreply.github.com>
1 parent 664f48c commit 1b52246

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
@@ -101,10 +101,20 @@ This document guides you through the process of producing Edge Installer ISOs th
101101

102102
:::
103103

104-
7. Customize the **Dockerfile**. You can install tools and dependencies and configure the image to meet your needs. Add
104+
7. Customize the `Dockerfile` as needed. You can install tools and dependencies and make other image modifications. Add
105105
your customizations below the line tagged with the `Add any other image customizations here` comment in the
106-
Dockerfile. Do not edit or add any lines before this tagged comment. For example, you can add the following line to
107-
the **Dockerfile** to install WireGuard.
106+
`Dockerfile`. Do not edit or add any lines before this tagged comment.
107+
108+
:::warning
109+
110+
When customizing the `Dockerfile` to add custom binaries, install them into `/usr/bin`. Do not use `/usr/local`, as
111+
this directory is mounted from the persistent partition at boot and makes files added during image build unavailable
112+
at runtime.
113+
114+
:::
115+
116+
For example, you can add the following line to the `Dockerfile` to install
117+
[WireGuard](https://www.wireguard.com/install/).
108118

109119
```dockerfile
110120
...
@@ -113,14 +123,25 @@ This document guides you through the process of producing Edge Installer ISOs th
113123
RUN sudo zypper refresh && sudo zypper install --non-interactive wireguard-tools
114124
```
115125

126+
Package installation commands in the `Dockerfile` must be non-interactive. Ensure you use the appropriate
127+
non-interactive flag for your package manager, for example, `--non-interactive` for Zypper or `--yes` for Advanced
128+
Package Tool (APT). Interactive prompts cause the image build to fail. This guidance applies to all dependencies you
129+
add through the `Dockerfile`.
130+
131+
View the `Dockerfile` to ensure the instruction to install WireGuard is appended correctly.
132+
133+
```bash
134+
cat Dockerfile
135+
```
136+
116137
:::warning
117138

118-
Adding software dependencies in the Dockerfile will cause the size of the Extensible Firmware Interface (EFI) file to
119-
grow. Most hardware has a limit on the size of the EFI that it can boot. Make sure you do not include too many
139+
Adding software dependencies in the `Dockerfile` will cause the size of the Extensible Firmware Interface (EFI) file
140+
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
120141
dependencies that can cause the EFI file to grow larger than the boot limit. For more information, refer to
121142
[Check EFI Boot Limit](./check-efi-limit.md).
122143

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

0 commit comments

Comments
 (0)