Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
GCP: Update development instructions.
  • Loading branch information
tmiddelkoop committed Oct 18, 2022
1 parent 37961fe commit 715b0ca
Showing 1 changed file with 34 additions and 4 deletions.
38 changes: 34 additions & 4 deletions Build.md
Expand Up @@ -43,14 +43,26 @@ git config user.name
git config user.email
```

## GCP
## Google Cloud

Checkout the project so it is not seen by the students. Run `./scripts/gcp-cloudshell.sh` to open the shell with the agent and ports 8080 and 8081 forwarded and run the following commands (onetime setup). Be sure to check the project and account values.
Google Cloud development is split between the Cloud Shell episodes (04_intro_to_cli and 05_cli_storage) and the VM episodes. Although the Cloud Shell episodes *should* work on the VM the prompt responses are slightly different.

The Jupyter notebook is forwarded to http://localhost:8080 and the preview on http://localhost:8081. Use the links in the output of the script for Jupyter to login with the proper authentication key.

First setup the Google Cloud SDK and login to the account and project that you are going to use for development.

Verify the active project and account with
```bash
gcloud config configurations list
```

### Google Cloud Shell Development

The project is located in a hidden directory (`.essentials`) to hide the output from Jupyter and the students. To start Cloud Shell run `./scripts/gcp-cloudshell.sh` to open the shell with the agent and ports 8081 and 8080 forwarded (Jupyter and preview respectively) and run the following commands to setup the Cloud Shell (this needs to be done only once). Be sure to check the project and account values.

```bash
git clone git@github.internet2.edu:/CLASS/CLASS-Essentials.git .essentials
cd .essentials/
git checkout -b gcp-dev --track origin/gcp-dev
( cd .essentials/ ; git checkout -b gcp-dev --track origin/gcp-dev )

ACCOUNT=learner@class.internet2.edu
PROJECT=essentials-learner
Expand All @@ -66,6 +78,17 @@ Then run the following from your local machine (Make sure to shutdown from the w
```bash
./scripts/gcp-cloudshell-jupyter-lab.sh
```

### Google Virtual Machine Development

If you manually create a with the instructions in the 06_running_analysis episode you must use the `us-west2-c` zone or delete it and let the script create it.

Workflow
* Create and configure a new VM with `./scripts/gcp-create.sh`
* Open Jupiter link shown in the output of the `gcp-create.sh` script.
* Delete the vm when done (don't forget to commit and push!) with `./scripts/gcp-delete.sh`


## AWS

Expect that `aws` is installed locally. A ssh-key named 'learner' is required to access the account.
Expand All @@ -74,6 +97,13 @@ Expect that `aws` is installed locally. A ssh-key named 'learner' is required t

Expect that `az` is installed and configured locally. It will utilize your ~/.ssh/id_rsa.pub key.

## Jupyter Book Tags

You can control the rendering of the book by adding "Tags" to the cells. To access tags select a cell then click the gears box on the top right of the browser tab to open up the properties.

Tags
* To hide a cell add the tag `remove-cell`.

## Bugs and Fixes

The bash kernel and Python do not like the new "bracketed paste" mode of the new bash/readline. To fix you can disable "bracketed paste" mode by doing
Expand Down

0 comments on commit 715b0ca

Please sign in to comment.