Skip to content

Commit 8377d13

Browse files
authored
fix(docs): add minor addition in the onboarding guide (#575)
2 parents 37f44a3 + 49f80f1 commit 8377d13

File tree

1 file changed

+74
-16
lines changed

1 file changed

+74
-16
lines changed

docs/hackathon/0-onboarding.mdx

Lines changed: 74 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,24 @@ This comprehensive guide will walk you through setting up your development envir
3636
- Use an existing Google account or create a new one
3737
- This account will be your primary access point for all hackathon resources
3838
- Submit your Google account email during the hackathon registration process
39-
- You'll receive access to the `google-hackathon-project` when approved
39+
- You'll receive access to the `verifiable-ai-hackathon` when approved
4040

4141
### Setting up Gemini API access
4242

4343
1. Log into your registered Google account after you receive the approval
44-
1. Visit the [Get a Gemini API key](https://aistudio.google.com/app/apikey) page
45-
1. Click on **Create API key**
46-
1. Select `google-hackathon-project` from the dropdown
47-
1. Click **Create API key in existing project**
48-
1. Store your API key securely
44+
2. Visit the [Get a Gemini API key](https://aistudio.google.com/app/apikey) page
45+
3. Click on **Create API key**
46+
4. Select `verifiable-ai-hackathon` from the dropdown
47+
5. Click **Create API key in existing project**
48+
6. Store your API key securely
49+
50+
:::tip[Common API Key Issues]
51+
If you get an error when creating the API key:
52+
53+
- Clear browser cache and try again
54+
- Ensure you're logged into the correct Google account
55+
- Wait a few minutes after project approval before attempting
56+
:::
4957

5058
:::tip[Adding Hackathon API keys to your environment]
5159

@@ -81,6 +89,12 @@ Follow these steps to set up a GCP instance using Confidential Space with Cloud
8189

8290
Follow the [gcloud CLI installation guide](https://cloud.google.com/sdk/docs/install) steps for your OS
8391

92+
Verify installation:
93+
94+
```bash
95+
gcloud version
96+
```
97+
8498
2. **Authenticate your CLI**
8599

86100
Use the same account used for hackathon registration
@@ -89,6 +103,12 @@ Follow these steps to set up a GCP instance using Confidential Space with Cloud
89103
gcloud auth login
90104
```
91105

106+
Verify project access:
107+
108+
```bash
109+
gcloud projects list # Should show verifiable-ai-hackathon
110+
```
111+
92112
#### Create VM Instance
93113

94114
:::warning[Number of VM instances]
@@ -103,7 +123,7 @@ Use the following command template, replacing the highlighted placeholder variab
103123
```bash
104124
# highlight-next-line
105125
gcloud compute instances create <INSTANCE_NAME> \
106-
--project=google-hackathon-project \
126+
--project=verifiable-ai-hackathon \
107127
--zone=us-central1-c \
108128
--machine-type=n2d-standard-2 \
109129
--network-interface=network-tier=PREMIUM,nic-type=GVNIC,stack-type=IPV4_ONLY,subnet=default \
@@ -127,6 +147,12 @@ gcloud compute instances create <INSTANCE_NAME> \
127147
--confidential-compute-type=SEV
128148
```
129149

150+
Key parameters explained:
151+
152+
- `--zone=us-central1-c`: Required zone for hackathon resources
153+
- `--machine-type=n2d-standard-2`: Optimized for AI workloads
154+
- `--min-cpu-platform="AMD Milan"`: Required for confidential computing
155+
130156
**Required Variables:**
131157

132158
- `<INSTANCE_NAME>`: Your instance name in the format `<project-name>-<team-name>`, e.g. `agent-gemini-team1`
@@ -141,7 +167,7 @@ Follow these steps to create your VM instance through the Google Cloud Console i
141167
1. **Initial Setup**
142168

143169
- Navigate to the [GCP Console](https://console.cloud.google.com/)
144-
- Make sure **google-hackathon-project** is selected
170+
- Make sure **verifiable-ai-hackathon** is selected
145171
- Click **Compute Engine → VM instances → Create Instance**
146172

147173
<div align="center">
@@ -237,15 +263,43 @@ Follow these steps to create your VM instance through the Google Cloud Console i
237263
- Monitor system logs through Serial Port console
238264
- Verify container logs in Cloud Logging
239265

240-
{" "}
266+
### Quick Start Steps After VM Creation
241267

242-
<div align="center">
243-
<img
244-
src={FinalStep}
245-
alt="Final Step Configuration"
246-
style={{ maxWidth: "30%", margin: "20px 0" }}
247-
/>
248-
</div>
268+
1. Test your VM connection:
269+
```bash
270+
gcloud compute ssh <INSTANCE_NAME>
271+
```
272+
2. Verify container is running:
273+
```bash
274+
docker ps
275+
```
276+
3. Check application logs:
277+
```bash
278+
docker logs <CONTAINER_ID>
279+
```
280+
281+
### Development Workflow
282+
283+
- Use `gcloud compute scp` to transfer files to/from VM
284+
- Set up port forwarding for local development
285+
- Use VS Code Remote SSH extension for easier development
286+
287+
### Resource Monitoring
288+
289+
Monitor your VM resources through:
290+
291+
- Google Cloud Console Dashboard
292+
- `top` command in VM
293+
- Container metrics via `docker stats`
294+
295+
:::tip[Accessing Container Logs]
296+
View container logs in multiple ways:
297+
298+
- Cloud Logging interface in Google Cloud Console
299+
- Serial console output
300+
- Docker logs in the VM
301+
- Cloud Logging API for programmatic access
302+
:::
249303

250304
## Track Templates
251305

@@ -268,13 +322,17 @@ When reaching out clearly mention the VM instance name.
268322
:::
269323

270324
- **VM Creation Fails**
325+
271326
- Verify project permissions
272327
- Check quota limits
273328
- Ensure correct service account access
329+
274330
- **API Key Issues**
331+
275332
- Confirm project selection
276333
- Verify key format
277334
- Check access restrictions
335+
278336
- **Container Startup Problems**
279337
- Review metadata configuration
280338
- Check image URL validity

0 commit comments

Comments
 (0)