-
Notifications
You must be signed in to change notification settings - Fork 161
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Joe Kimmel <jkimmel@vmware.com>
- Loading branch information
1 parent
7366ebe
commit 54a521c
Showing
4 changed files
with
72 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
+++ | ||
title="Extension Author Guide" | ||
title="Extension Guide" | ||
weight=4 | ||
include_summaries=true | ||
expand=true | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
+++ | ||
title="Consume an extension" | ||
weight=4 | ||
summary="A few notes to help you consume extensions" | ||
aliases = [ | ||
"/docs/extension-author-guide/create-extension" | ||
] | ||
+++ | ||
|
||
<!--+if false+--> | ||
## Prerequisites | ||
|
||
Before we get started, make sure you've got the following installed: | ||
|
||
{{< download-button href="https://store.docker.com/search?type=edition&offering=community" color="blue" >}} Install Docker {{</>}} | ||
{{< download-button href="/docs/install-pack" color="pink" >}} Install pack {{</>}} | ||
|
||
You may also need to [create an extension](/docs/extension-guide/create-extension) so that you can consume it. | ||
|
||
## Overview | ||
<!--+end+--> | ||
|
||
This is a few notes for using CNB image extensions. | ||
|
||
- [consume in your builder](/docs/extension-guide/consume-extension/in-builder) | ||
- [consume via pack build](/docs/extension-guide/consume-extension/from-cli) | ||
|
||
<!--+if false+--> | ||
--- | ||
|
||
<a href="/docs/extension-guide/consume-extension/in-builder" class="button bg-pink">Start Tutorial</a> | ||
<!--+end+--> |
14 changes: 14 additions & 0 deletions
14
content/docs/extension-guide/consume-extension/from-cli.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
+++ | ||
title="Specifying an Image Extension at Build Time" | ||
weight=405 | ||
+++ | ||
|
||
<!-- test:suite=dockerfiles;weight=5 --> | ||
|
||
### Specifying an Image Extension at Build Time | ||
|
||
No builder can be truly omniscient, and whoever did yours surely was no exception! You need to add a little extra spice to the mix with this late-breaking extension, by doing something like: | ||
|
||
`pack build [...] --extension=foo [...]` | ||
|
||
|
25 changes: 25 additions & 0 deletions
25
content/docs/extension-guide/consume-extension/in-builder.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
+++ | ||
title="Specifying an Image Extension in the Builder" | ||
weight=405 | ||
+++ | ||
|
||
<!-- test:suite=dockerfiles;weight=5 --> | ||
|
||
### Specifying an Image Extension in the Builder | ||
|
||
You're pretty sharp, and you know what your buildpack users will need. | ||
That's why you're going to add something similar to the following lines directly to `builder.toml`: | ||
|
||
``` | ||
[[order-extensions]] | ||
[[order-extensions.group]] | ||
id = "foo" | ||
version = "0.0.1" | ||
[[extensions]] | ||
id = "foo" | ||
version = "0.0.1" | ||
uri = "/local/path/to/extension/foo" # can be relative or absolute | ||
``` | ||
|
||
|