Skip to content

Commit 006ced8

Browse files
committed
docs: update README
Signed-off-by: Snir Sheriber <[email protected]>
1 parent b3b33c6 commit 006ced8

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

config/peerpods/podvm/bootc/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Image Mode (bootc) PodVM Builds
22

33
Image Mode podVM builds enable OSC users to create PodVM images based
4-
on a RHEL bootc container image. The resulting artifact can be either
4+
on a RHEL/Fedora bootc container image. The resulting artifact can be either
55
a podVM bootc container image or a podVM disk generated from that image.
66
OSC includes updates to the Image Creation mechanism, supporting the
77
conversion and upload of podVM images derived from pre-created bootc
@@ -15,11 +15,13 @@ for image creation.
1515

1616
Use Podman to build a podVM bootc image locally (push it to
1717
a container registry of your choice if needed).
18-
**NOTE:** setting CLOUD_PROVIDER & RHEL Subscription credentials are required only for Azure
18+
**NOTE:** setting CLOUD_PROVIDER & RHEL Subscription credentials are essential only for Azure on RHEL
1919
```
2020
IMG=quay.io/example/podvm-bootc
2121
AUTHFILE=/path/to/pull-secret
22-
podman build --authfile ${AUTHFILE} --build-arg CLOUD_PROVIDER=azure --build-arg ORG_ID=<org-id> --build-arg ACTIVATION_KEY=<key> -f Containerfile.rhel -t ${IMG}
22+
# OPTIONALS=" --build-arg CLOUD_PROVIDER=azure --build-arg ORG_ID=<org-id> --build-arg ACTIVATION_KEY=<key> "
23+
OS_VARIANT=<rhel|fedora>
24+
podman build --authfile ${AUTHFILE} ${OPTIONALS} -f Containerfile.${OS_VARIANT} -t ${IMG}
2325
#podman push ${IMG}
2426
```
2527

@@ -43,7 +45,7 @@ Use [Bootc Image Builder](https://github.com/osbuild/bootc-image-builder)
4345
to convert the created podVM bootc container image to a podVM disk file
4446
**config.toml:** Use it to set custom bootc build configuration: https://osbuild.org/docs/bootc/#-build-config
4547
```
46-
# podman pull ${IMG} # optional
48+
# podman pull ${IMG} # if the image is not already available locally
4749
mkdir output
4850
sudo podman run \
4951
-it --rm \
@@ -80,7 +82,6 @@ Once you have OSC operator installed and before applying KataConfig,
8082
ensure your `<cloud-provider>-podvm-image-cm` values are configured
8183
correctly:
8284
```
83-
IMAGE_TYPE: pre-built
8485
PODVM_IMAGE_URI: ${IMG_URI}
8586
# Custom bootc build configuration: https://osbuild.org/docs/bootc/#-build-config
8687
# default is used if not set
@@ -102,7 +103,7 @@ BOOTC_BUILD_CONFIG: | # Optional, custom bootc build configuration: https://osb
102103

103104
#### AWS specifics
104105

105-
In order to convert image to AMI (Amazon Machine Image) in-cluster you'll need:
106+
In order to convert image to AMI (Amazon Machine Image) in-cluster (**only needed if peer-pods-secret is manually set**) you'll need:
106107
* An existing s3 bucket in the region of your cluster
107108
* Your cluster's AWS credntials needs to have the following [permissions](https://docs.aws.amazon.com/vm-import/latest/userguide/required-permissions.html#iam-permissions-image)
108109
* [vmimport service role](https://docs.aws.amazon.com/vm-import/latest/userguide/required-permissions.html#vmimport-role) set

0 commit comments

Comments
 (0)