Skip to content

Commit 23616f9

Browse files
committed
Update README for podvm image creation
Signed-off-by: Pradipta Banerjee <[email protected]>
1 parent 60d5805 commit 23616f9

File tree

1 file changed

+16
-26
lines changed

1 file changed

+16
-26
lines changed

config/peerpods/podvm/README.md

+16-26
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,36 @@
11
# Introduction
22

3-
This is a brief readme explaining the usage of the podvm-builder scripts and related files
3+
This is a brief readme explaining the usage of the podvm-builder scripts and
4+
related files. The scripts and related manifest files are primarily used by
5+
the operator to generate a pod VM image.
46

5-
## Create PodVM image generation configuration
7+
## PodVM image generation configuration
68

79
The configuration used for the podvm image generation is available in the following configmaps:
810

911
- Azure: `azure-podvm-image-cm`
1012
- AWS: `aws-podvm-image-cm`
1113

12-
Depending on the cloud provider (eg. aws or azure) create the respective
13-
configmaps. Please review and modify the settings in the configMap as required.
14+
If you want to change the default configuration, then depending on the cloud
15+
provider (eg. aws or azure) you'll need to pre-create the respective
16+
configmaps. Please review and modify the settings in the configMap as
17+
required. For example, if you need to add NVIDIA GPU drivers in the podvm
18+
image then set `ENABLE_NVIDIA_GPU: yes`. Likewise if you want to create image
19+
for confidential containers then set `CONFIDENTIAL_COMPUTE_ENABLED: yes`.
1420

15-
For AWS
21+
Use the following command to create the configMap for AWS:
1622

1723
```sh
1824
kubectl apply -f aws-podvm-image-cm.yaml
1925
```
2026

21-
For Azure
27+
Use the following command to create the configMap for Azure:
2228

2329
```sh
2430
kubectl apply -f azure-podvm-image-cm.yaml
2531
```
2632

27-
## Create podvm image
28-
29-
The podvm image is created in a Kubernetes job. To create the job run the following command
30-
31-
```sh
32-
kubectl apply -f osc-podvm-create-job.yaml
33-
```
34-
35-
On successful image creation, the podvm image details will be updated as an annotation in the `peer-pods-cm`
36-
under `openshift-sandboxed-containers-operator` namespace.
37-
38-
The annotation key for AWS is `LATEST_AMI_ID` and for Azure it's `LATEST_IMAGE_ID`
39-
40-
## Delete podvm image
41-
42-
Update the IMAGE_ID for Azure or AMI_ID for AWS that you want to delete and then run the following command
43-
44-
```sh
45-
kubectl delete -f osc-podvm-delete-job.yaml
46-
```
33+
Now when you create a KataConfig with `enablePeerPods: true` with empty
34+
`AZURE_IMAGE_ID` or `AWS_AMI_ID` in `peer-pods-cm`, then depending on the cloud
35+
provider configured, the operator will create the pod VM image based on the
36+
provided config.

0 commit comments

Comments
 (0)