Permalink
Browse files

Udpate walkthrough for deployment

  • Loading branch information...
1 parent 00642a8 commit 9bc9b386bb757dc591e0ba1a813ea06a39295013 @yunshengb yunshengb committed Nov 29, 2016
Showing with 42 additions and 17 deletions.
  1. +42 −17 tools/deploy/instructions.ipynb
@@ -10,7 +10,7 @@
},
"source": [
"# Lucida Installation Instructions\n",
- "## November 28, 2016"
+ "## November 29, 2016"
]
},
{
@@ -23,7 +23,7 @@
"source": [
"### Overview\n",
"\n",
- "In this tutorial, you will deploy **Lucida** on your Mac. \n",
+ "In this tutorial, you will deploy **Lucida** on your Mac. Once it is deployed, follow [tutorial.pdf](../../tutorial.pdf) for demo. The entire process may take several hours.\n",
"\n",
"As bonus, you will learn:\n",
"\n",
@@ -55,7 +55,7 @@
"source": [
"### Steps\n",
"\n",
- "Please follow the steps below carefully."
+ "**Important**: Please copy and paste the `command line instructions` rather than manually type."
]
},
{
@@ -67,7 +67,7 @@
},
"source": [
"### 1\n",
- "Download the Ubuntu 14.04 iso image from [`http://releases.ubuntu.com/14.04/`](http://releases.ubuntu.com/14.04/)\n",
+ "Download the Ubuntu 14.04 **64-bit** iso image from [`http://releases.ubuntu.com/14.04/`](http://releases.ubuntu.com/14.04/). Docker does not work on a 32-bit OS, so please choose a 64-bit version. Simply download to your file system without extracting/unzipping. It may take a while\n",
"![](img/1.jpg)"
]
},
@@ -81,7 +81,6 @@
"source": [
"### 2\n",
"Install Parallel Desktop 11 for Mac from [`http://www.parallels.com/products/desktop/download/`](http://www.parallels.com/products/desktop/download/) and open it\n",
- "\n",
"![](img/2.jpg)"
]
},
@@ -107,7 +106,7 @@
},
"source": [
"### 4\n",
- "Click the middle button\n",
+ "Click the middle button \"Install Windows or another OS from a DVD or image file\". We are installing Ubuntu from the image file you downloaded in step 1\n",
"![](img/4.jpg)"
]
},
@@ -120,7 +119,7 @@
},
"source": [
"### 5\n",
- "Locate the Ubuntu 14.04 iso image, then click `Continue`\n",
+ "Locate the Ubuntu 14.04 64-bit iso image, then click `Continue`\n",
"![](img/5.jpg)"
]
},
@@ -146,7 +145,7 @@
},
"source": [
"### 7\n",
- "Locate `Hardware`, click the lock button to make changes, and then set memory to 8192 MB (or near the maximum amount in the green range)\n",
+ "Locate `Hardware`, click the lock button to make changes, and then set memory to near the maximum amount in the green range (for example, 8 GB in the below case). Usually, anywhere between 4 GB and 8 GB is fine\n",
"![](img/7.jpg)"
]
},
@@ -159,7 +158,7 @@
},
"source": [
"### 8\n",
- "Close the window, click `Continue`, and wait until Ubuntu 14.04 is set up\n",
+ "Close the window, click `Continue`, and wait until Ubuntu 14.04 is set up. It may take a while\n",
"![](img/8.jpg)"
]
},
@@ -185,7 +184,7 @@
},
"source": [
"### 10\n",
- "Type `wget https://github.com/claritylab/lucida/archive/master.zip` to download Lucida Github repo\n",
+ "Run `wget https://github.com/claritylab/lucida/archive/master.zip` to download Lucida Github repo\n",
"![](img/10.jpg)"
]
},
@@ -198,7 +197,7 @@
},
"source": [
"### 11\n",
- "Type `unzip master.zip` followed by `ls` to see a directory `lucida-master/`\n",
+ "Run `unzip master.zip` followed by `ls` to see a directory `lucida-master/`\n",
"![](img/11.jpg)"
]
},
@@ -211,7 +210,7 @@
},
"source": [
"### 12\n",
- "Type `wget -qO- https://get.docker.com/ | sh` followed by `sudo usermod -aG docker $(whoami)` to install Docker. After that, log out and back in for this to take effect\n",
+ "Run `wget -qO- https://get.docker.com/ | sh` followed by `sudo usermod -aG docker $(whoami)` to install Docker. After that, log out and back in for this to take effect\n",
"![](img/12.jpg)"
]
},
@@ -224,7 +223,7 @@
},
"source": [
"### 13\n",
- "Open the terminal again, and type `sudo start docker`\n",
+ "Open the terminal again, and run `sudo start docker`\n",
"![](img/13.jpg)"
]
},
@@ -237,7 +236,7 @@
},
"source": [
"### 14\n",
- "Type `cd lucida-master/tools/deploy/` followed by `sudo ./cluster_up_linux.sh` to start a Kubernetes cluster\n",
+ "Run `cd lucida-master/tools/deploy/` followed by `sudo ./cluster_up_linux.sh` to start a Kubernetes cluster\n",
"![](img/14.jpg)"
]
},
@@ -250,7 +249,7 @@
},
"source": [
"### 15\n",
- "Type `sudo chown -R $(whoami) /home/$(whoami)/.kube/config` to give yourself permission to a Kubernetes-related directory\n",
+ "Run `sudo chown -R $(whoami) /home/$(whoami)/.kube/config` to give yourself permission to a Kubernetes-related directory\n",
"![](img/15.jpg)"
]
},
@@ -263,7 +262,7 @@
},
"source": [
"### 16\n",
- "Type `sudo ./start_services.sh` followed by `kubectl get pod` to start all the services and monitor the status. Kubernetes starts downloading the images, so please wait until the status of every pod becomes `running`\n",
+ "Run `sudo ./start_services.sh` followed by `kubectl get pod` to start all the services and monitor the status. Kubernetes starts downloading the images, so please wait until the status of every pod becomes `running`. It may take a while\n",
"![](img/16.jpg)"
]
},
@@ -276,7 +275,7 @@
},
"source": [
"### 17\n",
- "Visit `localhost:30000` in your browser\n",
+ "*Inside Ubuntu*, visit `localhost:30000` in your browser. If you want to access Lucida from OS X, please set up port forwarding\n",
"![](img/17.jpg)"
]
},
@@ -292,6 +291,32 @@
"It's done. Lucida is runnin in your virtual machine.\n",
"Follow [tutorial.pdf](../../tutorial.pdf) for demo."
]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {
+ "slideshow": {
+ "slide_type": "slide"
+ }
+ },
+ "source": [
+ "### How to uninstall?\n",
+ "\n",
+ "- If you want to remove Lucida along with Ubuntu, simply go back to the control panel of Parallel Desktop, right click the virtual machine, and select \"Remove\"\n",
+ "\n",
+ "- If you want to remove Lucida but keep using Ubuntu, run the following commands **twice** to stop and remove all the Docker containers currently running in the virtual machine:\n",
+ "\n",
+ "```\n",
+ "dockerlist=$(docker ps -a -q)\n",
+ "if [ \"${dockerlist}\" != \"\" ]; then\n",
+ " for d in ${dockerlist}; do\n",
+ " echo \"***** ${d}\"\n",
+ " docker stop ${d} 2>&1 > /dev/null\n",
+ " docker rm ${d} 2>&1 > /dev/null\n",
+ " done\n",
+ " fi\n",
+ "```"
+ ]
}
],
"metadata": {

0 comments on commit 9bc9b38

Please sign in to comment.