Skip to content

Commit 9641884

Browse files
Merge pull request #82 from chainguard-demo/jprince-update-readme
Walked through all steps and verified + updated wording.
2 parents df8ef67 + ea1b915 commit 9641884

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

custom-assembly/readme.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
- [Using Custom Assembly with the API](#using-custom-assembly-with-the-api)
99

1010
## Overview
11-
This directory contains examples for using Custom Assembly to customize Chainguard images. This example covers three scenarios:
11+
This directory contains examples for using Custom Assembly to customize Chainguard images. This example covers two scenarios:
1212
1. Using the Console UI to customize images
1313
2. Using chainctl to customize images
1414

@@ -20,7 +20,8 @@ This guide utilizes the cs-ttt-demo.dev registry, it is not necessary to use it
2020

2121

2222
## Pre-requisites
23-
1. chainctl is installed and user has access to the chainguard org. NOTE: The user must have either the editor or ownership role in order to customize images. Chainctl install docs can be found [here](https://edu.chainguard.dev/chainguard/chainctl-usage/how-to-install-chainctl/)
23+
1. chainctl is installed and user has access to the chainguard org. Chainctl install docs can be found [here](https://edu.chainguard.dev/chainguard/chainctl-usage/how-to-install-chainctl/)
24+
> NOTE: The user must have either the Owner role, or a Custom role with the the repo.update (to edit existing images) or repo.create (to create new images) permissions in order to customize images.
2425
2. Docker installed to run images
2526
3. For the chainctl demo below, the mariadb image must be in your registry or the package must exist in your Private APK Repo.
2627

@@ -52,7 +53,8 @@ This is meant to be a straightforward example of CA using the console.
5253
8. Select "Continue"
5354
9. Choose if you would like you create a new image or customize the current image.
5455
55-
If you select `Customize the current image`, the curl package will be included in your "custom-python-ui-demo" image in every tag. Use this option when you know for certain that you would like `curl` to always be included in your image and there will be no need for any other variants. If you add specific versions of a package it may break certain tag builds.
56+
If you select `Customize the current image`, the curl package will be included in your "custom-python-ui-demo" image in every tag. Use this option when you know for certain that you would like `curl` to always be included in your image and there will be no need for any other variants.
57+
> IMPORTANT: If you add specific versions of a package it may break certain tag builds.
5658
5759
If you select `Create a new image`, a duplicate image repo will be created, based on the original, but with the new packaged added. Use this option when users may still need to use the original image without customization, but you are seeking to provide an image that also has additional packages.
5860
@@ -362,4 +364,4 @@ In this example we will walk through converting a Dockerfile which is currently
362364
363365
## Using Custom Assembly with the API
364366
365-
If you are interested in utilizing the API to interact with Custom Assembly the tutorial on the [Chainguard edu site](https://edu.chainguard.dev/chainguard/chainguard-images/features/ca-docs/custom-assembly-api-demo/)
367+
If you are interested in utilizing the API to interact with Custom Assembly the tutorial on the [Chainguard edu site](https://edu.chainguard.dev/chainguard/chainguard-images/features/ca-docs/custom-assembly-api-demo/)

0 commit comments

Comments
 (0)