Skip to content

Commit c7dac0d

Browse files
[version-4-2] docs: DOC-2374 Edit Docker customization step for Edgeforge (#9728) (#9750)
* Backport changes from PR 9728 to version 4.2 * Update palette-canvos.md * Empty commit to trigger security checks
1 parent 8c1796e commit c7dac0d

File tree

1 file changed

+25
-16
lines changed

1 file changed

+25
-16
lines changed

docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -618,29 +618,38 @@ git checkout v4.0.6
618618
619619
:::
620620
621-
11. Use the following command to append the [WireGuard](https://www.wireguard.com/install/) installation instructions to
622-
the Dockerfile. You can install more tools and dependencies and configure the image to meet your needs. Add your
623-
customizations below the line tagged with the `Add any other image customizations here` comment in the Dockerfile.
624-
Do not edit or add any lines before this tagged comment.
621+
11. Customize the `Dockerfile` as needed. You can install tools and dependencies and make other image modifications. Add
622+
your customizations below the line tagged with the `Add any other image customizations here` comment in the
623+
`Dockerfile`. Do not edit or add any lines before this tagged comment.
625624
626-
```bash
627-
echo 'RUN sudo zypper refresh && sudo zypper install --non-interactive wireguard-tools' >> Dockerfile
628-
```
625+
:::warning
629626
630-
View the newly created file to ensure the instruction to install WireGuard is appended correctly.
627+
When customizing the `Dockerfile` to add custom binaries, install them into `/usr/bin`. Do not use `/usr/local`, as
628+
this directory is mounted from the persistent partition at boot and makes files added during image build unavailable
629+
at runtime.
631630
632-
```bash
633-
cat Dockerfile
631+
:::
632+
633+
For example, you can add the following line to the `Dockerfile` to install
634+
[WireGuard](https://www.wireguard.com/install/).
635+
636+
```dockerfile
637+
...
638+
###########################Add any other image customizations here #######################
639+
640+
RUN sudo zypper refresh && sudo zypper install --non-interactive wireguard-tools
634641
```
635642
636-
:::warning
643+
Package installation commands in the `Dockerfile` must be non-interactive. Ensure you use the appropriate
644+
non-interactive flag for your package manager, for example, `--non-interactive` for Zypper or `--yes` for Advanced
645+
Package Tool (APT). Interactive prompts cause the image build to fail. This guidance applies to all dependencies you
646+
add through the `Dockerfile`.
637647
638-
Using the `-y` option with the `sudo zypper install` command is critical to successfully build the images. The
639-
default behavior for package installations is to prompt the user for permission to install the package. A user
640-
prompt will cause the image creation process to fail. This guidance applies to all dependencies you add through the
641-
`Dockerfile`.
648+
View the `Dockerfile` to ensure the instruction to install WireGuard is appended correctly.
642649
643-
:::
650+
```bash
651+
cat Dockerfile
652+
```
644653
645654
12. Issue the command below to save your tenant registration token to a local variable. Replace `[your_token_here]` with
646655
your actual registration token.

0 commit comments

Comments
 (0)