Skip to content

Commit

Permalink
now with consume extension notes
Browse files Browse the repository at this point in the history
Signed-off-by: Joe Kimmel <jkimmel@vmware.com>
  • Loading branch information
joe-kimmel-vmw committed May 6, 2023
1 parent 7366ebe commit 54a521c
Show file tree
Hide file tree
Showing 4 changed files with 72 additions and 1 deletion.
2 changes: 1 addition & 1 deletion content/docs/extension-guide/_index.md
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
Expand Down
32 changes: 32 additions & 0 deletions content/docs/extension-guide/consume-extension/_index.md
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 content/docs/extension-guide/consume-extension/from-cli.md
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 content/docs/extension-guide/consume-extension/in-builder.md
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
```


0 comments on commit 54a521c

Please sign in to comment.