Merge pull request #37 from sql-machine-learning/modify_doc

Add publish script

Author: lhw362950217

Vagrantfile

@@ -26,8 +26,8 @@ Vagrant.configure("2") do |config|
                     auto_correct: true
 
   config.vm.provider "virtualbox" do |v|
-    v.memory = 16384
-    v.cpus = 8
+    v.memory = 8192
+    v.cpus = 4
   end
 
   # Bind the host directory ./ into the VM.

dev.md

@@ -39,28 +39,33 @@
 
 The releaser, which, in most cases, is a developer, can export a running VirtualBox VM into a VM image file with extension `.ova`.  An `ova` file is a tarball of a directory, whose content follows the OVF specification.  For the concepts, please refer to this [explanation](https://damiankarlson.com/2010/11/01/ovas-and-ovfs-what-are-they-and-whats-the-difference/).
 
-According to this [tutorial](https://www.techrepublic.com/article/how-to-import-and-export-virtualbox-appliances-from-the-command-line/), releasers can run the following command to list running VMs.
+According to this [tutorial](https://www.techrepublic.com/article/how-to-import-and-export-virtualbox-appliances-from-the-command-line/), releasers can call the VBoxManage command to export a VM. We have written a scrip to do this.  Simply run below script to export our playground.  This script will create a file named `SQLFlowPlayground.ova`, we can import the file through virtual box GUI.
 
 ```bash
-vboxmanage list vms
-```
-
-Then, they can run the following command to export the `.ova` file.
-
-```bash
-vboxmanage export UBUNTUSERVER164 -o ubuntu_server_new.ova
+./publish
 ```
 
 ### For End-users
 
-To run SQLFlow on a desktop computer running Windows, Linux, or macOS, an end-user needs to download
+To run SQLFlow on a desktop computer running Windows, Linux, or macOS, you need to download
 
-1. the `sqlflow` command-line tool released by SQLFlow CI, and
-1. the released `.ova` file.
+1. the released `SQLFlowPlayground.ova`, directly download from [here](http://cdn.sqlflow.tech/latest/SQLFlowPlayground.ova), or use wget:
+    ```bash
+    wget -c http://cdn.sqlflow.tech/latest/SQLFlowPlayground.ova
+    ```
+1. optional, the [sqlflow](https://github.com/sql-machine-learning/sqlflow/blob/develop/doc/run/cli.md) command-line tool released by SQLFlow CI.
 
-If the end-user has VirtualBox installed -- no Vagrant required -- s/he could import the `.ova` file and start an VM.
+If you have VirtualBox installed, you can import the `SQLFlowPlayground.ova` file and start a VM.  After that, you can log in the system through the VirtualBox GUI or through a ssh connection like below.  The default password of `root` is `vagrant`.
+```bash
+ssh -p2222 [email protected]
+[email protected]'s password: vagrant
+```
+Once logged in the VM, you will immediately see a script named `start.bash`, just run the script to start SQLFlow playground.  It will output some hint messages for you, follow those hints, after a while, you will see something like `Access Jupyter NoteBook at: http://127.0.0.1:8888/...`, it means we are all set.  Copy the link to your web browser  and you will see SQLFlow's Jupyter Notebook user interface, Enjoy it!
+```bash
+./start.bash
+```
 
-Or, if s/he has an AWS or Google Cloud account, s/he could upload the `.ova` file to start the VM on the cloud.  AWS users can follow [these steps](https://aws.amazon.com/ec2/vm-import/).
+Or, if you has an AWS or Google Cloud account, you can upload the `.ova` file to start the VM on the cloud.  AWS users can follow [these steps](https://aws.amazon.com/ec2/vm-import/).
 
 Anyway, given a running VM, the end-user can run the following command to connect to it:
 

provision.bash

@@ -64,3 +64,29 @@ else
 fi
 echo "Done."
 
+echo "Copy files ..."
+# In non-develop mode, we want the user see the start.bash
+# immediately after she/he logs on the vm
+cp "$VAGRANT_SHARED_FOLDER/start.bash" "/root/"
+
+read -r -d '\t' files <<EOM
+sqlflow/scripts/travis/export_k8s_vars.sh
+sqlflow/docker/dev/find_fastest_resources.sh
+sqlflow/scripts/travis/start_argo.sh
+sqlflow/doc/run/k8s/install-sqlflow.yaml
+\t
+EOM
+
+mkdir -p "/root/scripts"
+for file in ${files[@]}; do
+    cp "$VAGRANT_SHARED_FOLDER/$file" "/root/scripts/$(basename $file)"
+done
+echo "Done."
+
+echo "Change root password ..."
+echo "root:vagrant" | chpasswd
+sed -i -e 's/^PasswordAuthentication no/PasswordAuthentication yes/g' \
+    -e 's/#PermitRootLogin prohibit-password/PermitRootLogin yes/g' \
+    /etc/ssh/sshd_config
+service ssh restart
+echo "Done."

publish.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+# Copyright 2020 The SQLFlow Authors. All rights reserved.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+echo "Stoping the vm ..."
+vagrant halt
+echo "Done."
+
+echo "Finding playground vm ..."
+vm=$(VBoxManage list vms | grep "playground_default" | head -1)
+if [[ ! "$vm" =~ playground_default* ]]; then
+    echo "No palyground virtual machine found."
+    exit 1
+fi
+vm=$(echo $vm | awk -F"\"" '{print $2}')
+echo "Found $vm ."
+
+echo "Remove shared folder ..."
+VBoxManage sharedfolder remove "$vm" --name home_vagrant_desktop
+VBoxManage sharedfolder remove "$vm" --name vagrant
+echo "Done."
+
+echo "Exporting vm ..."
+VBoxManage export "$vm" -o SQLFlowPlayground.ova
+echo "Done."

start.bash

@@ -25,6 +25,9 @@ if [[ "$(whoami)" != "root" ]]; then
     exit 1
 fi
 
+# script base dir for starting the minikube cluster
+filebase=/root/scripts
+
 echo "Docker pull dependency images, you can comment this if already have them ..."
 # c.f. https://github.com/sql-machine-learning/sqlflow/blob/develop/.travis.yml
 docker pull sqlflow/sqlflow:jupyter
@@ -38,8 +41,8 @@ echo "Done."
 
 # NOTE: According to https://stackoverflow.com/a/16619261/724872,
 # source is very necessary here.
-source $(dirname $0)/sqlflow/scripts/travis/export_k8s_vars.sh
-source $(dirname $0)/sqlflow/docker/dev/find_fastest_resources.sh
+source $filebase/export_k8s_vars.sh
+source $filebase/find_fastest_resources.sh
 
 # (FIXME:lhw) If grep match nothing and return 1, do not exit
 # Find a way that we do not need to use 'set -e'
@@ -109,7 +112,7 @@ argo_server_alive=$(is_pod_ready "argo" "app=argo-server")
 if [[ "$argo_server_alive" == "yes" ]]; then
     echo "Already in running."
 else
-    $(dirname $0)/sqlflow/scripts/travis/start_argo.sh
+    $filebase/start_argo.sh
 fi
 wait_or_exit "argo" "is_pod_ready argo app=argo-server" "yes"
 
@@ -127,7 +130,7 @@ sqlflow_alive=$(is_pod_ready "default" "app=sqlflow-server")
 if [[ "$sqlflow_alive" == "yes" ]]; then
     echo "Already in running."
 else
-    kubectl apply -f sqlflow/doc/run/k8s/install-sqlflow.yaml
+    kubectl apply -f $filebase/install-sqlflow.yaml
 fi
 wait_or_exit "SQLFlow" "is_pod_ready default app=sqlflow-server" "yes"