Skip to content

Commit

Permalink
doc: Add KinD create steps
Browse files Browse the repository at this point in the history
The KinD type is used for the beginner
Add steps to create KinD cluster
Correct podvm-generic-ubuntu-amd64 latest tag missing

Signed-off-by: Liu Yan Song <[email protected]>
  • Loading branch information
lysliu authored and huoqifeng committed Jan 2, 2025
1 parent 464f734 commit 0f2bc91
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/cloud-api-adaptor/docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,17 @@ The `docker` provider simulates a pod VM inside a docker container.

Ensure you complete the [post install steps](https://docs.docker.com/engine/install/linux-postinstall/) if using non-root user

- Install [yq](https://github.com/mikefarah/yq/releases/download/v4.44.2/yq_linux_amd64), [kubectl](https://storage.googleapis.com/kubernetes-release/release/v1.29.4/bin/linux/amd64/kubectl), [kind](https://kind.sigs.k8s.io/dl/v0.23.0/kind-linux-amd64) manually or using `prereqs.sh` helper script under `src/cloud-api-adaptor/docker`.

- Kubernetes cluster
```
# The default cluster name is peer-pods if CLUSTER_NAME variable not set
export CLUSTER_NAME={your_cluster_name}
```
use below command to create a kind cluster before deploy CAA
```
./kind_cluster.sh create
```

## Build CAA pod-VM image

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@ The easiest way to extract the qcow2 file from the podvm container image is usin
$ cd podvm
$ ./hack/download-image.sh quay.io/confidential-containers/podvm-generic-ubuntu-amd64 . -o podvm.qcow2
```
>Note: images can be checked from https://quay.io/repository/confidential-containers/podvm-generic-ubuntu-amd64?tab=tags, to get available tag e.g. `v0.11.0` if the default tag `latest` is missed.
In case your workload images are pulled from a private registry then you need to provide the authentication file by either [installing along with the cloud-api-adaptor deployment](registries-authentication.md#deploy-authentication-file-along-with-cloud-api-adaptor-deployment) or [statically embedding in the podvm image](registries-authentication.md#statically-embed-authentication-file-in-podvm-image). With the later you will need to build the image from sources, so find detailed instructions in [podvm/README.md](../podvm/README.md).

0 comments on commit 0f2bc91

Please sign in to comment.