Rename teepod to dstack-vmm

Author: kvinwang

Cargo.lock

@@ -16,8 +16,8 @@ members = [
     "iohash",
     "guest-agent",
     "guest-agent/rpc",
-    "teepod",
-    "teepod/rpc",
+    "vmm",
+    "vmm/rpc",
     "gateway",
     "gateway/rpc",
     "certbot",
@@ -45,7 +45,7 @@ ra-tls = { path = "ra-tls" }
 dstack-gateway-rpc = { path = "gateway/rpc" }
 kms-rpc = { path = "kms/rpc" }
 dstack-guest-agent-rpc = { path = "guest-agent/rpc" }
-teepod-rpc = { path = "teepod/rpc" }
+dstack-vmm-rpc = { path = "vmm/rpc" }
 cc-eventlog = { path = "cc-eventlog" }
 supervisor = { path = "supervisor" }
 supervisor-client = { path = "supervisor/client" }

Cargo.toml

@@ -23,7 +23,7 @@ Dstack is community driven. Open sourced and built by [Kevin Wang](https://githu
 
 Components in Dstack:
 
-- `teepod`: A service running in bare TDX host to manage CVMs
+- `dstack-vmm`: A service running in bare TDX host to manage CVMs
 - `dstack-gateway`: A reverse proxy to forward TLS connections to CVMs
 - `dstack-kms`: A KMS server to generate keys for CVMs
 - `dstack-guest-agent`: A service running in CVM to serve containers' key derivation and attestation requests
@@ -39,7 +39,7 @@ dstack/
     kms/                         A prototype KMS server
     guest-agent/                 A service running in CVM to serve containers' key derivation and attestation requests.
     tdxctl/                      A CLI tool getting TDX quote, extending RTMR, generating cert for RA-TLS, etc.
-    teepod/                      A service running in bare TDX host to manage CVMs
+    vmm/                         A service running in bare TDX host to manage CVMs
     gateway/                     A reverse proxy to forward TLS connections to CVMs
     certbot/                     A tool to automatically obtain and renew TLS certificates for dstack-gateway
     ra-rpc/                      RA-TLS support for pRPC
@@ -84,10 +84,10 @@ vim ./build-config.sh
 Now edit the config file. The following configurations values must be changed properly according to your environment:
 
 ```bash
-# The internal port for teepod to listen to requests from you
-TEEPOD_RPC_LISTEN_PORT=9080
-# The start CID for teepod to allocate to CVMs
-TEEPOD_CID_POOL_START=20000
+# The internal port for dstack-vmm to listen to requests from you
+VMM_RPC_LISTEN_PORT=9080
+# The start CID for dstack-vmm to allocate to CVMs
+VMM_CID_POOL_START=20000
 
 # The internal port for kms to listen to requests from CVMs
 KMS_RPC_LISTEN_PORT=9043
@@ -121,19 +121,19 @@ Run build.sh again to build the artifacts.
 
 # If everything is okay, you should see the built artifacts in the `build` directory.
 $ ls
-certs  images  kms  kms.toml  run  teepod  teepod.toml  dstack-gateway  gateway.toml
+certs  images  kms  kms.toml  run  dstack-vmm  vmm.toml  dstack-gateway  gateway.toml
 ```
 
 Now you can open 3 terminals to start the components:
 
 1. Run `./kms`
 2. Run `sudo ./dstack-gateway -c gateway.toml`
-3. Run `./teepod`
+3. Run `./dstack-vmm -c vmm.toml`
 
 ## Deploy an App
-Open the teepod webpage [http://localhost:9080](http://localhost:9080)(change the port according to your configuration) on your local machine to deploy a `docker-compose.yaml` file:
+Open the dstack-vmm webpage [http://localhost:9080](http://localhost:9080)(change the port according to your configuration) on your local machine to deploy a `docker-compose.yaml` file:
 
-![teepod](./docs/assets/teepod.png)
+![vmm](./docs/assets/vmm.png)
 
 After the container deployed, it should need some time to start the CVM and the containers. Time would be vary depending on your workload.
 
@@ -259,7 +259,7 @@ Given the config `GATEWAY_LISTEN_PORT_PASSTHROUGH=9008`, now we can go to [`http
 
 ## Upgrade an App
 
-Got to the teepod webpage, click the [Upgrade] button, select or paste the compose file you want to upgrade to, and click the [Upgrade] button again.
+Got to the dstack-vmm webpage, click the [Upgrade] button, select or paste the compose file you want to upgrade to, and click the [Upgrade] button again.
 Upon successful initiation of the upgrade, you'll see a message prompting you to run the following command in your terminal to authorize the upgrade through KMS:
 
 ```shell
@@ -370,23 +370,23 @@ $ ./ct_monitor -t https://localhost:9010/prpc -d app.kvin.wang
 
 # Troubleshooting
 
-### Error from teepod: qemu-system-x86_64: -device vhost-vsock-pci,guest-cid=<id>: vhost-vsock: unable to set guest cid: Address already in use
+### Error from dstack-vmm: qemu-system-x86_64: -device vhost-vsock-pci,guest-cid=<id>: vhost-vsock: unable to set guest cid: Address already in use
 
-`teepod` may throw this error when creating a new VM if the [Unix Socket CID](https://man7.org/linux/man-pages/man7/vsock.7.html) is occupied. To solve the problem, first, you should list the occupied CID:
+`dstack-vmm` may throw this error when creating a new VM if the [Unix Socket CID](https://man7.org/linux/man-pages/man7/vsock.7.html) is occupied. To solve the problem, first, you should list the occupied CID:
 
 ```bash
 ps aux | grep 'guest-cid='
 ```
 
-Then choose a new range of the CID not conflicting with the CID in use. You can change `build/teepod.toml` file and restart `teepod`. This error should disappear. For example, you may find 33000-34000 free to use:
+Then choose a new range of the CID not conflicting with the CID in use. You can change `build/vmm.toml` file and restart `dstack-vmm`. This error should disappear. For example, you may find 33000-34000 free to use:
 
 ```toml
 [cvm]
 cid_start = 33000
 cid_pool_size = 1000
 ```
 
-When building the dstack from scratch, you should change the CID configs in `build-config.sh` instead, because `teepod.toml` file is generated by `build.sh`. Its content is derived from `build-config.sh`.
+When building the dstack from scratch, you should change the CID configs in `build-config.sh` instead, because `vmm.toml` file is generated by `build.sh`. Its content is derived from `build-config.sh`.
 
 You may encounter this problem when upgrading from an older version of dstack, because CID was introduced in `build-config.sh` in later versions. In such case, please follow the docs to add the missing entries in `build-config.sh` and rebuild dstack.
 

README.md

@@ -12,18 +12,18 @@ It contains steps to deploy dstack-kms and dstack-gateway into CVMs.
 ```bash
 git clone https://github.com/Dstack-TEE/dstack
 ```
-## Compile and Run teepod
+## Compile and Run dstack-vmm
 ```bash
 cd dstack
-cargo build --release -p teepod -p supervisor
-mkdir -p teepod-data
-cp target/release/teepod teepod-data/
-cp target/release/supervisor teepod-data/
-cd teepod-data/
-
-# create teepod.toml. Edit the config as needed.
-cat <<EOF > teepod.toml
-address = "unix:./teepod.sock"
+cargo build --release -p dstack-vmm -p supervisor
+mkdir -p vmm-data
+cp target/release/dstack-vmm vmm-data/
+cp target/release/supervisor vmm-data/
+cd vmm-data/
+
+# create vmm.toml. Edit the config as needed.
+cat <<EOF > vmm.toml
+address = "unix:./vmm.sock"
 reuse = true
 image_path = "./images"
 run_path = "./run/vm"
@@ -52,8 +52,8 @@ mkdir -p images/
 tar -xvf dstack-0.4.1.tar.gz -C images/
 rm -f dstack-0.4.1.tar.gz
 
-# run teepod
-./teepod
+# run dstack-vmm
+./dstack-vmm -c vmm.toml
 ```
 
 ## Deploy the KmsAuth contract
@@ -78,17 +78,17 @@ Transaction hash: 0xd413d01a0640b6193048b0e98afb7c173abe58c74d9cf01f368166bc53f4
 ```
 
 ## Deploy KMS into CVM
-The teepod is running now. Open another terminal and go to the `kms/tapp/` directory and run the following command:
+The dstack-vmm is running now. Open another terminal and go to the `kms/tapp/` directory and run the following command:
 
 ```bash
 cd dstack/kms/tapp/
-./deploy-to-teepod.sh 
+./deploy-to-vmm.sh 
 ```
 It will create a template `.env` file. Edit the `.env` file and set the required variables.
 Especially the `KMS_CONTRACT_ADDR` variable set to the address of the KmsAuth Proxy contract deployed in the previous step.
 ```
 # .env
-TEEPOD_RPC=unix:../../teepod-data/teepod.sock
+VMM_RPC=unix:../../vmm-data/vmm.sock
 KMS_CONTRACT_ADDR=0xFE6C45aE66344CAEF5E5D7e2cbD476286D651875
 KMS_RPC_ADDR=0.0.0.0:9201
 GUEST_AGENT_ADDR=127.0.0.1:9205
@@ -99,19 +99,19 @@ OS_IMAGE=dstack-0.4.0
 
 Then run the script again.
 
-Then it will deploy the KMS CVM to the teepod. Outputs:
+Then it will deploy the KMS CVM to the dstack-vmm. Outputs:
 
 ```
 App compose file created at: .app-compose.json
 Compose hash: ec3d427f62bd60afd520fce0be3b368aba4516434f2ff761f74775f871f5b6e3
-Deploying KMS to Teepod...
+Deploying KMS to dstack-vmm...
 App ID: ec3d427f62bd60afd520fce0be3b368aba451643
 Created VM with ID: f5299298-bf4f-43c0-839c-88c755391f3c
 ```
 
-Go back to the teepod-data directory and check the status of the KMS CVM:
+Go back to the vmm-data directory and check the status of the KMS CVM:
 ```bash
-cd ../../teepod-data/
+cd ../../vmm-data/
 tail -f run/vm/f5299298-bf4f-43c0-839c-88c755391f3c/serial.log
 ```
 
@@ -185,14 +185,14 @@ Registered AppId: 0x31884c4b7775affe4c99735f6c2aff7d7bc6cfcd
 Now go to the `gateway/tapp/` directory and run the following command:
 ```bash
 cd ../../gateway/tapp/
-./deploy-to-teepod.sh 
+./deploy-to-vmm.sh 
 ```
 
 It will create a template .env file. Edit the .env file and set the required variables.
 
 ```
 # .env
-TEEPOD_RPC=unix:../../teepod-data/teepod.sock
+VMM_RPC=unix:../../vmm-data/vmm.sock
 
 # Cloudflare API token for DNS challenge used to get the SSL certificate.
 CF_API_TOKEN=your_cloudflare_api_token
@@ -239,7 +239,7 @@ It should show the prompt to confirm the deployment:
 App compose file created at: .app-compose.json
 Compose hash: 700a50336df7c07c82457b116e144f526c29f6d8f4a0946b3e88065c9beba0f4
 Configuration:
-TEEPOD_RPC: unix:../../build/teepod.sock
+VMM_RPC: unix:../../build/vmm.sock
 SRV_DOMAIN: test5.dstack.phala.network
 PUBLIC_IP: 66.220.6.113
 GATEWAY_APP_ID: 31884c4b7775affe4c99735f6c2aff7d7bc6cfcd
@@ -262,15 +262,15 @@ npx hardhat app:add-hash --network phala --app-id 0x31884c4b7775affe4c99735f6c2a
 
 After the transaction is confirmed, you can press `y` to continue the deployment.
 
-Similar to the KMS deployment, it will deploy the dstack-gateway CVM to the teepod and it will start serving later.
+Similar to the KMS deployment, it will deploy the dstack-gateway CVM to the dstack-vmm and it will start serving later.
 
-## Deploy teepods to serve user workloads
-After the KMS and dstack-gateway are deployed, you can deploy teepods on other TDX hosts to serve user workloads.
+## Deploy dstack-vmm on other TDX hosts to serve user workloads
+After the KMS and dstack-gateway are deployed, you can deploy dstack-vmm on other TDX hosts to serve user workloads.
 
-Edit the teepod.toml file to set the KMS and dstack-gateway URLs.
+Edit the vmm.toml file to set the KMS and dstack-gateway URLs.
 
 ```
-# teepod.toml
+# vmm.toml
 [cvm]
 kms_urls = ["https://kms.test2.dstack.phala.network:9201"]
 gateway_urls = ["https://gateway.test2.dstack.phala.network:9202"]

docs/assets/teepod.png renamed to docs/assets/vmm.png

@@ -41,9 +41,9 @@ Focus on these five fields in the `core.proxy` section:
 
 For example, if your base domain is `gateway.example.com`, app ID is `<app_id>`, listening on `80`, and dstack-gateway is on port 7777, the URL would be `https://<app_id>-80.gateway.example.com:7777`
 
-## Step 5: Adjust Configuration in `teepod.toml`
+## Step 5: Adjust Configuration in `vmm.toml`
 
-Open `teepod.toml` and adjust dstack-gateway configuration in the `gateway` section:
+Open `vmm.toml` and adjust dstack-gateway configuration in the `gateway` section:
 
 - `base_domain`: Same as `base_domain` from `gateway.toml`'s `core.proxy` section
 - `port`: Same as `listen_port` from `gateway.toml`'s `core.proxy` section