Skip to content

Commit

Permalink
Document experimental VM access for Climsim Testing (#160)
Browse files Browse the repository at this point in the history
* Initial Testing for VM access

* expand permissions needed

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
jbusecke and pre-commit-ci[bot] authored Aug 20, 2024
1 parent bfb4d9b commit 8a3df71
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 0 deletions.
1 change: 1 addition & 0 deletions book/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ parts:
- file: guides/bootcamp
- file: guides/team_docs
- file: guides/faq
- file: guides/vm_access
- caption: Policies
chapters:
- file: policies/code_policy
Expand Down
33 changes: 33 additions & 0 deletions book/guides/vm_access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# (Experimental) Getting access to bare Cloud VMs

```{admonition} Important
---
class: important
---
This documentation should be considered highly experimental and permissions to follow these instructions are only given to a small subset of testers at the moment.
```

## Why?

We want to test e.g. containerized workflows that run climate simulations (for online testing of ML parametrizations). For that we need a 'bare' VM, and not the JupyterLab interface.

## Admin considerations

To fully separate this testing from the Hub etc we have created a separate project in Gcloud (same billing account and Org). To keep an eye on (e.g. accidental) cost overrun, I added a budget alert (in the linked billing account) that applies to all resources for this new project, and set a 500\$ alert with notifications at various thresholds. New users need the following IAM permissions:

- "Compute Admin"
- "Service Account User"

## How to get access

Send your email (private gmail preferred) to Julius Busecke

## Log into google cloud console and start a small test VM

- Use the email you sent above to sign into https://console.cloud.google.com
- Make sure to chose the project "ClimSimTesting" ![](../images/vm_access_project.png)
- Now navigate to "Compute Engine" and click on "Create New Instance". Chose a recognizable name (e.g. `climsim_<your_name>_test` and leave everything else on default for now and click "Create" at the bottom.
- After a short spin up you should see your VM instance with a green checkmark.
- Try to SSH into it via the cloud console (click on SSH on the far right).
- Let me know on slack that you were able to create an instance
- **Very Important**: Delete your instance after the test. **You should do this everytime you are done using the VM to avoid large costs**. Click on the triple dots on the right, and chose "Delete". ![](../images/vm_access_delete.png)
Binary file added book/images/vm_access_delete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/images/vm_access_project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8a3df71

Please sign in to comment.