Skip to content

Commit 389505d

Browse files
author
Natalie Arellano
committed
Clean up app-dev how-to
Signed-off-by: Natalie Arellano <[email protected]>
1 parent 25a1178 commit 389505d

File tree

10 files changed

+27
-43
lines changed

10 files changed

+27
-43
lines changed
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
+++
22
title="Configure build inputs"
33
weight=1
4-
54
include_summaries=true
65
+++

content/docs/for-app-developers/how-to/build-inputs/build-time-environment.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
+++
2-
title="Configure build-time environment variables"
2+
title="Customize buildpack behavior with build-time environment variables"
33
weight=2
4-
summary="Customize buildpack behavior through the build-time environment."
54
+++
6-
<!--+- `
7-
# Environment variables
8-
`+-->
5+
96
Environment variables are a common way to configure various buildpacks at build-time.
107

11-
Below are a few ways you can do so. All of them will use our [samples][samples] repo for simplicity.
8+
<!--more-->
9+
10+
Below are a few ways you can do so. All of them will use our [samples] repo for simplicity.
1211

1312
### Using CLI arguments (`--env`)
1413

content/docs/for-app-developers/how-to/build-inputs/buildpacks.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ weight=1
44
summary="No builder author can be truly omniscient, and whoever created yours surely was no exception!"
55
+++
66

7-
<!--+- `
8-
# Specify buildpacks
9-
`+-->
10-
117
You may specify exactly what buildpacks are used during the build process by referencing them with a URI in any of the following formats.
128

139
| Type | Format |
@@ -21,7 +17,8 @@ You may specify exactly what buildpacks are used during the build process by ref
2117

2218
##### Fallback Behavior
2319

24-
When a string does not include a scheme prefix (ex. `docker://`) and also does not match a path on the filesystem, a platform may attempt to resolve it to a URI in the following order:
20+
When a string does not include a scheme prefix (ex. `docker://`) and also does not match a path on the filesystem,
21+
a platform may attempt to resolve it to a URI in the following order:
2522
- If it matches a buildpack ID in the builder, it will be treated as a `urn:cnb:builder` URI
2623
- If it looks like a Docker ref, it will be treated as a `docker://` URI
2724
- If it looks like a Buildpack Registry ID, it will be treated as a `urn:cnb:registry` URI
@@ -111,4 +108,4 @@ A buildpack located in a CNB Registry
111108
<small><sup></sup> Version may be omitted if there is only one buildpack in the builder matching the `id`.</small>
112109

113110
[project-toml]: /docs/for-app-developers/how-to/build-inputs/project-toml/
114-
[samples]: https://github.com/buildpacks/samples
111+
[samples]: https://github.com/buildpacks/samples

content/docs/for-app-developers/how-to/build-inputs/cache-images.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,8 @@ title="Use a cache image"
33
weight=6
44
summary="Share layers between builds with a cache image."
55
+++
6-
<!--+- `
7-
# Cache Images
8-
`+-->
96

10-
Cache Images are a way to preserve build optimizing layers across different host machines.
7+
Cache images are a way to preserve build-optimizing layers across different host machines.
118
These images can improve performance when using `pack` in ephemeral environments such as CI/CD pipelines.
129

1310
## Using Cache Images (`--cache-image`)

content/docs/for-app-developers/how-to/build-inputs/volume-mounts.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,6 @@ title="Mount volumes at build-time"
33
weight=3
44
summary="Supply and persist data from build containers with arbitrary volume mounts."
55
+++
6-
<!--+if false+-->
7-
{{< param "summary" >}}
8-
<!--+end+-->
9-
<!--+- `
10-
# Mounting Volumes
11-
12-
Volumes are a mechanism for both supplying and persisting data generated by build containers.
13-
`+-->
146

157
## Mounting Volumes (`--volume`)
168

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
+++
22
title="Understand build outputs"
33
weight=2
4-
54
include_summaries=true
65
+++

content/docs/for-app-developers/how-to/build-outputs/download-sbom.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
+++
22
title="Download a Software Bill-of-Materials (SBOM)"
33
summary="An SBOM can give you a layer-by-layer view of what's inside your application image."
4-
weight=2
4+
weight=3
55
+++
66

77
## Summary
88

9-
A **Software-Bill-of-Materials** (`SBoM`) lists all the software components included in an image. Cloud Native Buildpacks provides all the transparency you need to have confidence in your image supply chain. Software-Bill-of-Materials in [CycloneDX](https://cyclonedx.org/), [Syft](https://github.com/anchore/syft) and [Spdx](https://spdx.dev/) formats are supported.
9+
A **Software-Bill-of-Materials** (`SBOM`) lists all the software components included in an image. Cloud Native Buildpacks provides all the transparency you need to have confidence in your image supply chain. Software-Bill-of-Materials in [CycloneDX](https://cyclonedx.org/), [Syft](https://github.com/anchore/syft) and [Spdx](https://spdx.dev/) formats are supported.
1010

11-
1. Buildpacks can populate `SBoM` information about the dependencies they have provided.
11+
1. Buildpacks can populate `SBOM` information about the dependencies they have provided.
1212

1313
## Viewing Bill of Materials
1414

15-
You can use the `sbom download` command to inspect your app for its Software-Bill-of-Materials. The following command will download the application layer containing the `SBoM` files to `./layers/sbom/...` on your local filesystem.
15+
You can use the `sbom download` command to inspect your app for its Software-Bill-of-Materials. The following command will download the application layer containing the `SBOM` files to `./layers/sbom/...` on your local filesystem.
1616

1717
```bash
1818
pack sbom download your-image-name
1919
```
2020

21-
You can also choose to download the `SBoM` from an image hosted in a remote registry, as opposed to an image hosted in a Docker daemon. You use the `--remote` flag to do so.
21+
You can also choose to download the `SBOM` from an image hosted in a remote registry, as opposed to an image hosted in a Docker daemon. You use the `--remote` flag to do so.
2222

2323
```bash
2424
pack sbom download your-image-name --remote
2525
```
2626

27-
The following example demonstrates running `pack sbom download ...` on an image containing an `SBoM` in `syft` format. Running `pack sbom download ...` creates a `layers/sbom` directory and populates that directory with `sbom.syft.json` files. The combined metadata from all of the `sbom.syft.json` files is the image `SBoM`. Where an image generates CycloneDX `SBoM` metadata, the files are named `sbom.cdx.json`. Similarly, Spdx files are named `sbom.spdx.json`.
27+
The following example demonstrates running `pack sbom download ...` on an image containing an `SBOM` in `syft` format. Running `pack sbom download ...` creates a `layers/sbom` directory and populates that directory with `sbom.syft.json` files. The combined metadata from all of the `sbom.syft.json` files is the image `SBOM`. Where an image generates CycloneDX `SBOM` metadata, the files are named `sbom.cdx.json`. Similarly, Spdx files are named `sbom.spdx.json`.
2828

2929
```bash
3030
layers

content/docs/for-app-developers/how-to/build-outputs/inspect-app.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
+++
22
title="Inspect your application image"
3-
weight=1
3+
weight=2
44
+++
55

6-
One of the benefits of buildpacks is they can also populate the app image with metadata from the build process,
7-
allowing you to audit the app image for information like:
6+
Buildpacks-built images contain metadata that allow you to audit both the image itself and the build process.
7+
8+
<!--more-->
9+
10+
Information includes:
811
* The process types that are available and the commands associated with them
912
* The run-image the app image was based on
1013
* The buildpacks were used to create the app image
@@ -30,4 +33,6 @@ Processes:
3033
web (default) bash node-js app.js /workspace
3134
```
3235

33-
Apart from the above standard metadata, buildpacks can also populate information about the dependencies they have provided in form of a `Software Bill-of-Materials` or `SBOM`.
36+
Apart from the above standard metadata, buildpacks can also populate information about the dependencies they have provided in form of a `Software Bill-of-Materials` or [SBOM].
37+
38+
[SBOM]: /docs/for-app-developers/how-to/build-outputs/download-sbom

content/docs/for-app-developers/how-to/build-outputs/specify-launch-process.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
+++
2-
title="Run the app"
3-
weight=2
2+
title="Run the application"
3+
weight=1
44
summary="Learn how to specify the launch process for an app."
55
+++
66

7-
<!--+- `
8-
# Specify launch process
9-
10-
Learn how to specify the launch process for an app.
11-
`+-->
7+
Buildpacks-built images can contain multiple process types.
128

139
### Build a multi-process app
1410

0 commit comments

Comments
 (0)