Skip to content

Commit

Permalink
Update description of juptyer notebook
Browse files Browse the repository at this point in the history
  • Loading branch information
JMGaljaard committed Sep 4, 2022
1 parent c463a48 commit eac48ff
Showing 1 changed file with 21 additions and 14 deletions.
35 changes: 21 additions & 14 deletions jupyter/terraform_notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -10,30 +10,32 @@
"source": [
"# Pre-requisites\n",
"\n",
"Before we get started, first make sure to install all the required tools. We provide two lists below, one needed for setting up the testbed. And one for developing code to use with the testbed. Feel free to skip the installation of the second list, and return in a later point in time.\n",
"Before we get started, first make sure to install all the required tools. We provide two lists below, one needed for setting up the testbed. And one for developing code to use with the testbed. Feel free to skip the installation of the second list, and return at a later point in time.\n",
"\n",
"\n",
"Make sure to install a recent version of each of the dependencies.\n",
"\n",
" * GCloud SDK\n",
" - Follow the installation instructions [here](https://cloud.google.com/sdk/docs/install)\n",
" - Intialize the SDK with `gcloud init`\n",
" - Initialize the SDK with `gcloud init`\n",
" - ⚠️ Run the command `gcloud auth application-default login`\n",
" - ℹ️ We need to run this command in order to utilize your login credentials programmatically with terraform. This is needed as we will use these to impersonate a service account during the creation and setup of the Kubernetes cluster.\n",
" - ℹ️ We need to run this command to utilize your login credentials programmatically with terraform. This is needed as we will use these to impersonate a service account during the creation and setup of the Kubernetes cluster.\n",
" - ⚠️ Run the command `gcloud components install beta`\n",
" - ℹ️ We need to run this command to list the billing account ID's and enable billing. Currently, these features fall under beta access.\n",
" - ℹ️ We need to run this command to list the billing account IDs and enable billing. Currently, these features fall under beta access.\n",
" * Kubectl\n",
" * Helm\n",
" * Terraform\n",
" * (Windows o\n",
" * Python3.9\n",
" * Jupyter\n",
" ```bash\n",
" pip3 install jupyter\n",
" ```\n",
"```bash\n",
"pip3 install jupyter\n",
"```\n",
" * bash_kernel\n",
" ```bash\n",
" pip3 install bash_kernel\n",
" python3 -m bash_kernel.install\n",
" ```\n",
"```bash\n",
"pip3 install bash_kernel\n",
"python3 -m bash_kernel.install\n",
"```\n",
"\n",
"For development, the following tools are needed/recommended:\n",
"\n",
Expand All @@ -57,7 +59,10 @@
"To make sure we can request resources on Google Cloud Platform (GCP), perform the following;\n",
"\n",
"1. Create a GCP account on [https://cloud.google.com](https://cloud.google.com), using a Google account\n",
"2. Redeem your academic coupon on GCP, see Brightspace for information on obtaining the $\\$50 academic coupon, or use the free $\\$300 credits for new users provided by Google."
"2. Redeem your academic coupon on GCP, see Brightspace for information on obtaining the $\\$$50 academic coupon, or use the free $\\$$300 credits for new users provided by Google.\n",
"\n",
"\n",
"3. (Non unix systems) Make sure to use the `Bash` kernel, not a Python or other kernel. For those on windows machines, make sure to launch the `jupyter notebook` server from a bash-compliant commandline, we recommend Windows Subsystem for Linux.\n"
]
},
{
Expand All @@ -70,9 +75,11 @@
"source": [
"# Deployment\n",
"\n",
"⚠️ This notebook assumes that commands are executed in order. Executing the provided commands multiple times should not result in issues. However, re-running cells with `cd` commands, or altering cells (other than variables as instructed) may result in unexpected behaviour.\n",
"\n",
"## Getting started\n",
"\n",
"First we will set a few variables. If you change any of these, make sure to change the corresponding variables as well in;\n",
"First, we will set a few variables used **throughout** the project. We set them in this notebook for convenience, but they are also set as defaults in configuration files for the project. If you change any of these, make sure to change the corresponding variables as well in;\n",
"\n",
"* [`terraform-gke/variables.tf`](terraform-gke/variables.tf)\n",
"* [`terraform-dependencies/variables.tf`](terraform-dependencies/variables.tf)\n",
Expand All @@ -81,7 +88,7 @@
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 1,
"metadata": {
"pycharm": {
"name": "#%%\n"
Expand Down

0 comments on commit eac48ff

Please sign in to comment.