Skip to content

Commit 7abfc05

Browse files
committed
helm/docs: update documentation
Updated Peer-pods documentation Signed-off-by: Pawel Proskurnicki <pawel.proskurnicki@intel.com>
1 parent cebc095 commit 7abfc05

File tree

3 files changed

+33
-12
lines changed

3 files changed

+33
-12
lines changed

QUICKSTART.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,9 @@ helm install coco oci://ghcr.io/confidential-containers/charts/confidential-cont
5252

5353
#### For remote (peer-pods)
5454

55+
> [!NOTE]
56+
> Support for peer-pods requires installation using the [Cloud API Adaptor peer-pods helm charts](https://github.com/confidential-containers/cloud-api-adaptor/tree/main/src/cloud-api-adaptor/install/charts/peerpods) project.
57+
5558
```bash
5659
helm install coco oci://ghcr.io/confidential-containers/charts/confidential-containers \
5760
-f https://raw.githubusercontent.com/confidential-containers/charts/main/values/kata-remote.yaml \

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,10 +96,13 @@ helm install coco oci://ghcr.io/confidential-containers/charts/confidential-cont
9696
--create-namespace
9797
```
9898

99+
> [!NOTE]
100+
> Support for peer-pods requires installation using the [Cloud API Adaptor peer-pods helm charts](https://github.com/confidential-containers/cloud-api-adaptor/tree/main/src/cloud-api-adaptor/install/charts/peerpods) project.
101+
99102
### Detailed Installation Instructions
100103

101-
For complete installation instructions, customization options, and troubleshooting, see **[QUICKSTART.md](QUICKSTART.md)
102-
**, which includes:
104+
For complete installation instructions, customization options, and troubleshooting, see [QUICKSTART.md](QUICKSTART.md),
105+
which includes:
103106

104107
- Installation from OCI registry and local chart
105108
- Common customizations (debug logging, node selectors, image pull policy, private registries, k8s distributions)
@@ -175,6 +178,9 @@ The available RuntimeClasses depend on the architecture:
175178
|---------------|-------------|
176179
| `kata-remote` | Peer-pods |
177180

181+
> [!NOTE]
182+
> Support for peer-pods requires installation using the [Cloud API Adaptor peer-pods helm charts](https://github.com/confidential-containers/cloud-api-adaptor/tree/main/src/cloud-api-adaptor/install/charts/peerpods) project.
183+
178184
### Verification
179185

180186
```bash

values/kata-remote.yaml

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,22 @@ kata-as-coco-runtime:
1010
k8sDistribution: k8s
1111

1212
shims:
13-
qemu-snp:
13+
clh:
1414
enabled: false
1515

16-
qemu-tdx:
16+
cloud-hypervisor:
1717
enabled: false
1818

19-
qemu-se:
19+
dragonball:
2020
enabled: false
2121

22-
qemu-se-runtime-rs:
22+
fc:
23+
enabled: false
24+
25+
qemu:
26+
enabled: false
27+
28+
qemu-cca:
2329
enabled: false
2430

2531
qemu-coco-dev:
@@ -28,20 +34,26 @@ kata-as-coco-runtime:
2834
qemu-coco-dev-runtime-rs:
2935
enabled: false
3036

31-
clh:
37+
qemu-nvidia-gpu:
3238
enabled: false
3339

34-
cloud-hypervisor:
40+
qemu-nvidia-gpu-snp:
3541
enabled: false
3642

37-
dragonball:
43+
qemu-nvidia-gpu-tdx:
3844
enabled: false
3945

40-
fc:
46+
qemu-runtime-rs:
4147
enabled: false
4248

43-
qemu:
49+
qemu-se:
4450
enabled: false
4551

46-
qemu-runtime-rs:
52+
qemu-se-runtime-rs:
53+
enabled: false
54+
55+
qemu-snp:
56+
enabled: false
57+
58+
qemu-tdx:
4759
enabled: false

0 commit comments

Comments
 (0)