Skip to content

Commit b302ea2

Browse files
author
Natalie Arellano
committed
Clean up buildpack-author concepts and how-to
Signed-off-by: Natalie Arellano <[email protected]>
1 parent e272dda commit b302ea2

File tree

9 files changed

+26
-16
lines changed

9 files changed

+26
-16
lines changed

content/docs/for-buildpack-authors/concepts/buildpack-group.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
+++
2-
title="Buildpack Group"
3-
weight=3
4-
summary="A buildpack group is a list of specific buildpacks composed together in an order such that the list is suitable for building an application. Because buildpacks are modular and reusable, a buildpack group is what allows you to connect multiple modular buildpacks together."
2+
title="What is a buildpack group?"
3+
weight=2
54
+++
65

7-
## What is a buildpack group?
6+
A buildpack group is a list of individual buildpacks that are designged to work together to build an application.
87

9-
{{< param "summary" >}}
8+
<!--more-->
9+
10+
Buildpack groups allow you to connect multiple modular buildpacks together, making buildpacks modular and re-usable.
1011

1112
For example, you might have a buildpack that installs Java and a buildpack that uses Maven to build your application. These two buildpacks can be combined into a group to implement higher-level functionality, specifically that the first one will install Java and the second will use Java to run Maven, which is a Java build tool.
1213

content/docs/for-buildpack-authors/concepts/caching-strategies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
+++
2-
title="Caching strategies"
3-
weight=1
2+
title="What caching strategies are available to buildpacks?"
3+
weight=4
44
summary="Learn strategies for caching layers at build-time for future re-use."
55
+++
66

content/docs/for-buildpack-authors/concepts/lifecycle-phases.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
+++
2-
title="Lifecycle phases"
3-
weight=2
2+
title="What is the lifecycle?"
3+
weight=1
44
+++
55

6-
There are five phases to a buildpacks build.
6+
The lifecycle is a binary responsible for orchestrating buildpacks.
77

88
<!--more-->
99

10+
There are five phases to a buildpacks build.
11+
1012
We work through a full example of building a "hello world" NodeJs web application.
1113

1214
In the example we run `pack` on the NodeJS application to produce an application image. We assume that we have a NodeJS buildpack, `registry.fake/buildpacks/nodejs:latest`, that is decomposed into buildpacks that help with the build. We expand each of the buildpacks phases to explain the process. Throughout the example we take a production-level view of their operation. For example, our assumed NodeJS buildpack will be described to create different build, cache and launch layers in a manner similar to how a real NodeJS buildpack would operate.

content/docs/for-buildpack-authors/concepts/targets.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
+++
2-
title="Targets"
3-
weight=4
2+
title="What are targets?"
3+
weight=3
44
+++
55

6-
The concept of "targets" is used to identify compatibility between buildpacks and base images.
6+
The concept of `targets` is used to identify compatibility between buildpacks and base images.
7+
8+
<!--more-->
79

810
Target data includes:
911
* Operating system name (e.g., "linux")
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
+++
22
title="Write buildpacks"
33
weight=1
4-
54
include_summaries=true
65
+++

content/docs/for-buildpack-authors/how-to/write-buildpacks/add-sbom.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
+++
2-
title="Adding Bill-of-Materials"
2+
title="Provide a Software Bill-of-Materials"
33
weight=409
44
+++
55

66
Buildpacks can provide a [Software `Bill-of-Materials`](https://en.wikipedia.org/wiki/Software_bill_of_materials) (SBOM)
77
to describe the dependencies that they provide.
88

9+
<!--more-->
10+
911
There are three supported ways to report SBOM data.
1012
You'll need to choose to use one or more of [CycloneDX](https://cyclonedx.org/), [SPDX](https://spdx.dev/) or [Syft](https://github.com/anchore/syft).
1113
The SBOM format you choose to use is likely to be the format accepted by the SBOM scanner (eg: [`syft cli`](https://github.com/anchore/syft)) you might choose to use.

content/docs/for-buildpack-authors/how-to/write-buildpacks/specify-launch-processes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ weight=406
55

66
One of the benefits of buildpacks is that they are multi-process - an image can have multiple entrypoints for each operational mode.
77

8+
<!--more-->
9+
810
Let's see how this works. We will specify a process type that allows a debugger to attach to our application.
911

1012
To enable running the debug process, we'll need to have our buildpack define a "process type" for the worker.
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
+++
22
title="Write extensions"
33
weight=2
4-
54
include_summaries=true
65
+++

content/docs/for-buildpack-authors/how-to/write-extensions/guidance.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title="Guidance for extension authors"
33
weight=1
44
+++
55

6+
If you haven't already, check out our [tutorial](/docs/for-buildpack-authors/tutorials/basic-extension) on extensions,
7+
then come here for the finer points.
8+
69
<!--more-->
710

811
## During detect

0 commit comments

Comments
 (0)