Skip to content

Commit f68d03a

Browse files
docs: DOC-2374 Edit Docker customization step for Edgeforge (#9728) (#9746)
* Add Docker customization warning to EdgeForge * ci: auto-formatting prettier issues * Update palette-canvos.md * ci: auto-formatting prettier issues * Update palette-canvos.md * Update palette-canvos.md * ci: auto-formatting prettier issues * Update palette-canvos.md * ci: auto-formatting prettier issues * Update palette-canvos.md * ci: auto-formatting prettier issues * Empty commit to trigger security checks --------- (cherry picked from commit 51160a2) Co-authored-by: svetlana-efimova <svetlana.efimova@spectrocloud.com> Co-authored-by: svetlana-efimova <205686560+svetlana-efimova@users.noreply.github.com>
1 parent 3d32afe commit f68d03a

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/palette-canvos.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -495,29 +495,38 @@ required Edge artifacts.
495495

496496
:::
497497

498-
9. Use the following command to append the [WireGuard](https://www.wireguard.com/install/) installation instructions to
499-
the `Dockerfile`. You can install more tools and dependencies and configure the image to meet your needs. Add your
500-
customizations below the line tagged with the `Add any other image customizations here` comment in the `Dockerfile`.
501-
Do not edit or add any lines before this tagged comment.
498+
9. Customize the `Dockerfile` as needed. You can install tools and dependencies and make other image modifications. Add
499+
your customizations below the line tagged with the `Add any other image customizations here` comment in the
500+
`Dockerfile`. Do not edit or add any lines before this tagged comment.
502501

503-
```bash
504-
echo 'RUN sudo zypper refresh && sudo zypper install --non-interactive wireguard-tools' >> Dockerfile
505-
```
502+
:::warning
506503

507-
View the newly created file to ensure the instruction to install WireGuard is appended correctly.
504+
When customizing the `Dockerfile` to add custom binaries, install them into `/usr/bin`. Do not use `/usr/local`, as
505+
this directory is mounted from the persistent partition at boot and makes files added during image build unavailable
506+
at runtime.
508507

509-
```bash
510-
cat Dockerfile
508+
:::
509+
510+
For example, you can add the following line to the `Dockerfile` to install
511+
[WireGuard](https://www.wireguard.com/install/).
512+
513+
```dockerfile
514+
...
515+
###########################Add any other image customizations here #######################
516+
517+
RUN sudo zypper refresh && sudo zypper install --non-interactive wireguard-tools
511518
```
512519

513-
:::warning
520+
Package installation commands in the `Dockerfile` must be non-interactive. Ensure you use the appropriate
521+
non-interactive flag for your package manager, for example, `--non-interactive` for Zypper or `--yes` for Advanced
522+
Package Tool (APT). Interactive prompts cause the image build to fail. This guidance applies to all dependencies you
523+
add through the `Dockerfile`.
514524

515-
Using the `-y` option with the `sudo zypper install` command is critical to successfully build the images. The
516-
default behavior for package installations is to prompt the user for permission to install the package. A user prompt
517-
will cause the image creation process to fail. This guidance applies to all dependencies you add through the
518-
`Dockerfile`.
525+
View the `Dockerfile` to ensure the instruction to install WireGuard is appended correctly.
519526

520-
:::
527+
```bash
528+
cat Dockerfile
529+
```
521530

522531
10. <PartialsComponent category="palette-edge-canvos-version" name="canvos-edge-user-data" />
523532

0 commit comments

Comments
 (0)