Skip to content

Commit 618780d

Browse files
committed
feat(ui): make AMD and Intel as a tab in cookbook
1 parent 675659b commit 618780d

File tree

1 file changed

+31
-13
lines changed

1 file changed

+31
-13
lines changed

docs/hackathon/1-cookbook.mdx

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ description: Cookbook commands for managing Confidential VMs.
66
keywords: [flare, ai, confidential-compute, hackathon, google-cloud, onboarding]
77
---
88

9+
import Tabs from "@theme/Tabs";
10+
import TabItem from "@theme/TabItem";
11+
912
Reference for commands you will encounter when interacting with Confidential VMs.
1013

1114
## Restarting VMs
@@ -46,11 +49,17 @@ You can also view logs in the Google Cloud Console by navigating to the Logging
4649

4750
:::
4851

49-
## Deploying AMD SEV Confidential VMs
52+
## Deploying Confidential VMs
53+
54+
This guide shows commands for deploying Confidential VMs using either AMD SEV or Intel TDX.
55+
Select the appropriate tab for your configuration, and click "Show breakdown" to see more details.
56+
57+
<Tabs>
58+
<TabItem value="amd-sev" label="AMD SEV">
59+
60+
### Deploying AMD SEV Confidential VMs
5061

51-
This command creates a Confidential Computing VM instance using AMD SEV ([Secure Encrypted Virtualization](https://www.amd.com/content/dam/amd/en/documents/epyc-business-docs/white-papers/memory-encryption-white-paper.pdf)), with a specific image, network configuration, and security settings.
52-
The metadata section is critical for configuring the Trusted Execution Environment (TEE).
53-
The command is broken down in the following sections.
62+
This command creates a Confidential Computing VM instance using AMD SEV ([Secure Encrypted Virtualization](https://www.amd.com/content/dam/amd/en/documents/epyc-business-docs/white-papers/memory-encryption-white-paper.pdf)) with specific image, network, and security settings. The metadata section is critical for configuring the Trusted Execution Environment (TEE).
5463

5564
```bash
5665
# highlight-next-line
@@ -84,7 +93,10 @@ gcloud compute instances create $INSTANCE_NAME \
8493
--confidential-compute-type=SEV
8594
```
8695

87-
### Core command & instance name
96+
<details>
97+
<summary>Show breakdown of command sections</summary>
98+
99+
#### Core command & instance name
88100

89101
```bash
90102
gcloud compute instances create $INSTANCE_NAME \
@@ -93,7 +105,7 @@ gcloud compute instances create $INSTANCE_NAME \
93105
- `gcloud compute instances create`: This is the base command for creating a new Compute Engine virtual machine (VM) instance.
94106
- `$INSTANCE_NAME`: You need to replace this with the desired name for your VM instance.
95107

96-
### Project and zone
108+
#### Project and zone
97109

98110
```bash
99111
--project=verifiable-ai-hackathon \
@@ -103,7 +115,7 @@ gcloud compute instances create $INSTANCE_NAME \
103115
- `--project=verifiable-ai-hackathon`: Specifies the Google Cloud project where the VM will be created.
104116
- `--zone=us-central1-c`: Defines the zone within the `us-central1` region where the instance will reside. Choosing a zone is important for latency and resource availability.
105117

106-
### Machine type & network configuration
118+
#### Machine type & network configuration
107119

108120
```bash
109121
--machine-type=n2d-standard-2 \
@@ -117,7 +129,7 @@ gcloud compute instances create $INSTANCE_NAME \
117129
- `stack-type=IPV4_ONLY`: Specifies that the instance will use IPv4 only.
118130
- `subnet=default`: Attaches the instance to the default subnet in the specified zone's VPC network.
119131

120-
### Metadata (crucial for Confidential Computing)
132+
#### Metadata (crucial for Confidential Computing)
121133

122134
```bash
123135
--metadata=tee-image-reference=$TEE_IMAGE_REFERENCE,tee-container-log-redirect=true,tee-env-<ENV_VAR_NAME1>=<ENV_VAR_VALUE1>,tee-env-<ENV_VAR_NAME2>=<ENV_VAR_VALUE2>\
@@ -128,7 +140,7 @@ gcloud compute instances create $INSTANCE_NAME \
128140
- `tee-container-log-redirect=true`: Enables redirecting container logs to both Cloud Logging and serial logging, which can be helpful for debugging.
129141
- `tee-env-<ENV_VAR_NAME1>=<ENV_VAR_VALUE1>,tee-env-<ENV_VAR_NAME2>=<ENV_VAR_VALUE2>`: Sets environment variables within the TEE environment. Replace `<ENV_VAR_NAME1>`, `<ENV_VAR_VALUE1>`, `<ENV_VAR_NAME2>`, and `<ENV_VAR_VALUE2>` with your desired environment variable names and values. This is how you would pass secrets or other configuration data to the application running inside the TEE.
130142

131-
### Other instance settings
143+
#### Other instance settings
132144

133145
```bash
134146
--maintenance-policy=MIGRATE \
@@ -146,7 +158,7 @@ gcloud compute instances create $INSTANCE_NAME \
146158
- `--min-cpu-platform="AMD Milan"`: Ensures that the VM runs on a host with an AMD Milan CPU, which is required for Confidential Computing with SEV.
147159
- `--tags=flare-ai-core,http-server,https-server`: Applies network tags to the VM, which can be used for firewall rules and network routing.
148160

149-
### Boot disk configuration
161+
#### Boot disk configuration
150162

151163
```bash
152164
--create-disk=auto-delete=yes,boot=yes,\
@@ -163,7 +175,7 @@ gcloud compute instances create $INSTANCE_NAME \
163175
- `size=11`: The disk size is 11 GB.
164176
- `type=pd-standard`: Uses a standard persistent disk.
165177

166-
### Shielded VM options
178+
#### Shielded VM options
167179

168180
```bash
169181
--shielded-secure-boot \
@@ -176,7 +188,7 @@ gcloud compute instances create $INSTANCE_NAME \
176188
- `--shielded-vtpm`: Enables virtual Trusted Platform Module (vTPM).
177189
- `--shielded-integrity-monitoring`: Enables integrity monitoring.
178190

179-
### Labels, reservation affinity, and confidential compute
191+
#### Labels, reservation affinity, and confidential compute
180192

181193
```bash
182194
--labels=goog-ec-src=vm_add-gcloud \
@@ -188,7 +200,10 @@ gcloud compute instances create $INSTANCE_NAME \
188200
- `--reservation-affinity=any`: If you have reservations, this allows the VM to use any available reservation.
189201
- `--confidential-compute-type=SEV`: Enables AMD SEV (Secure Encrypted Virtualization) Confidential Computing. This is the core flag that makes this instance a confidential VM.
190202

191-
## Deploying Intel TDX Confidential VMs
203+
</details>
204+
</TabItem> <TabItem value="intel-tdx" label="Intel TDX">
205+
206+
### Deploying Intel TDX Confidential VMs
192207

193208
This command creates a Confidential Computing VM instance using Intel TDX ([Trust Domain Extensions](https://www.intel.com/content/www/us/en/developer/tools/trust-domain-extensions/documentation.html)), with a specific image, network configuration, and security settings.
194209
The command instructions differing from [Deploying AMD SEV Confidential VMs](#deploying-amd-sev-confidential-vms) are highlighted.
@@ -226,6 +241,9 @@ type=pd-balanced \
226241
--confidential-compute-type=TDX
227242
```
228243

244+
</TabItem>
245+
</Tabs>
246+
229247
**Differences:**
230248

231249
- Use the `c3-standard-*` series of machines running on Intel Sapphire Rapids

0 commit comments

Comments
 (0)