Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add warning about silent build failures #1845

Merged
merged 4 commits into from
Nov 27, 2023
Merged

docs: add warning about silent build failures #1845

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
398c1ee
docs: add warning about silent build failures
Nov 27, 2023
bcec086
docs: add wildcard to docker ls command
Nov 27, 2023
f1bbe7f
docs: add example of commenting out a version
Nov 27, 2023
792a156
Apply suggestions from code review
lennessyy Nov 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/docs-content/clusters/edge/site-deployment/deploy-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,12 @@ users:

The CanvOS utility uses [Earthly](https://earthly.dev/) to build the target artifacts. Issue the following command to start the build process.

:::caution
Make sure your machine has enough disk space for the provider images. Each image is about 4 - 5 GB in size, and images are created for all the Palette-supported Kubernetes versions by default. In the **4.1.2** branch of **CanvOS** used in this tutorial, the script builds 14 images. If your machine does not have enough disk space, the build process will fail silently.
lennessyy marked this conversation as resolved.
Show resolved Hide resolved

You can exclude image versions you do not need from the build process by commenting out the lines in the `build-provider-images` parameter in the file **Earthfile** in the **CanvOS** repository. This speeds up build process and reduces the amount of space required for the build process.
:::

```bash
sudo ./earthly.sh +build-all-images
```
Expand Down Expand Up @@ -287,7 +293,7 @@ echo $ISOFILEPATH
List the Docker images to review the created provider images. By default, provider images are created for all the Palette-supported Kubernetes versions. You can identify the provider images by the image tag value you used in the **.arg** file's `CUSTOM_TAG` variable.

```shell
docker images --filter=reference='*/*:*demo'
docker images --filter=reference='*/*:*demo*'
```

```hideClipboard bash {3,4}
Expand Down