Skip to content

Commit

Permalink
remove build-tools section from edu (#1684)
Browse files Browse the repository at this point in the history
## Type of change

Content removal.

### What should this PR do?

Remove this section and the `apko` and `melange` subsections:
https://edu.chainguard.dev/open-source/build-tools/

### Why are we making this change?

These docs can be moved to the respective GH repos, where they can get
updated as changes are made to these tools.

### What are the acceptance criteria? 

No broken links, no broken update automation.

### How should this PR be tested?

Check the preview that I removed things right, and removed enough.

I'm not sure how to test how this affects update automation though.

---------

Signed-off-by: Jason Hall <[email protected]>
Signed-off-by: Erika Heidi <[email protected]>
Co-authored-by: Erika Heidi <[email protected]>
  • Loading branch information
imjasonh and erikaheidi authored Jul 10, 2024
1 parent f778cef commit e927473
Show file tree
Hide file tree
Showing 54 changed files with 41 additions and 2,394 deletions.
16 changes: 2 additions & 14 deletions config/_default/menus/menus.en.toml
Original file line number Diff line number Diff line change
Expand Up @@ -64,23 +64,11 @@
parent = "menu-oss"
weight = 15

[[main]]
name = "apko"
url = "/open-source/apko/"
parent = "menu-oss"
weight = 20

[[main]]
name = "melange"
url = "/open-source/melange/"
parent = "menu-oss"
weight = 30

[[main]]
name = "Open Containers"
url = "/open-source/oci/"
parent = "menu-oss"
weight = 35
weight = 35

[[main]]
name = "SBOMs"
Expand Down Expand Up @@ -116,7 +104,7 @@
url = "/software-security/what-is-software-supply-chain-security/"
parent = "menu-security"
weight = 20

[[main]]
name = "How to Select a Secure Base Image"
url = "/software-security/selecting-a-base-image/"
Expand Down
2 changes: 1 addition & 1 deletion content/chainguard/chainguard-images/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Chainguard Images are based on [Wolfi](/open-source/wolfi/), a Linux _undistro_
We do have some images with Alpine-based variants in order to support musl or unusual architectures.

## How do Chainguard Images relate to the Google Distroless Images?
The [Google distroless](https://github.com/GoogleContainerTools/distroless) images follow a similar philosophy to many of our images: they are minimal images that don't include package managers or shells. The main difference is in the implementation. The Google distroless images are built with [Bazel](https://bazel.build) and based on the Debian distribution, whereas Chainguard Images are built with [apko](/open-source/apko) based on the [Wolfi](/open-source/wolfi) distribution. Wolfi is a community Linux [undistro](/open-source/wolfi/overview/#why-undistro). We believe our approach is more maintainable and extensible.
The [Google distroless](https://github.com/GoogleContainerTools/distroless) images follow a similar philosophy to many of our images: they are minimal images that don't include package managers or shells. The main difference is in the implementation. The Google distroless images are built with [Bazel](https://bazel.build) and based on the Debian distribution, whereas Chainguard Images are built with [apko](https://github.com/chainguard-dev/apko) based on the [Wolfi](/open-source/wolfi) distribution. Wolfi is a community Linux [undistro](/open-source/wolfi/overview/#why-undistro). We believe our approach is more maintainable and extensible.

## What is an "undistro"?
We call Wolfi an undistro because unlike a typical Linux distribution, Wolfi is a stripped-down distribution designed for the cloud-native era. Most notably, we don’t include a Linux kernel, instead relying on the environment (such as the container runtime) to provide this.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ It often happens that you want a [distroless](/chainguard/chainguard-images/gett

1. Compile the dependency from source and use a multi-stage Dockerfile to create a new base image. This works, but may require considerable effort to get the dependency compiling and to keep it up to date. This process quickly becomes untenable if you require several dependencies.
2. Use the `wolfi-base` image that includes apk tools to install the package in the traditional Dockerfile manner. This works but sacrifices a lot of the advantages of the “distroless” philosophy.
3. Use Chainguard’s [melange and apko tooling to create a custom base image](/open-source/melange/tutorials/getting-started-with-melange/). This keeps the image as minimal as possible without sacrificing maintainability.
3. Use Chainguard’s [melange](https://github.com/chainguard-dev/melange) and [apko](https://github.com/chainguard-dev/apko) tooling to create a custom base image. This keeps the image as minimal as possible without sacrificing maintainability.

### Using the wolfi-base Image
The `wolfi-base` image is a good starting point to try out Chainguard Images. Unlike most of the other images, which are strictly distroless, `wolfi-base` includes the `apk` package manager, which facilitates composing additional software into it. Just keep in mind that the resulting image will be a little larger due to the extra software and won't have a comprehensive SBOM that covers all your dependencies, since the new software will be added as a layer on top of `wolfi-base`.
Expand Down
12 changes: 0 additions & 12 deletions content/open-source/build-tools/_index.md

This file was deleted.

12 changes: 0 additions & 12 deletions content/open-source/build-tools/apko/_index.md

This file was deleted.

252 changes: 0 additions & 252 deletions content/open-source/build-tools/apko/bazel-rules.md

This file was deleted.

37 changes: 0 additions & 37 deletions content/open-source/build-tools/apko/faq.md

This file was deleted.

Loading

0 comments on commit e927473

Please sign in to comment.