diff --git a/README.md b/README.md index 1f0b392..625f0d7 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ The base docker image is [Jupyter Docker Stacks](https://github.com/jupyter/dock Please review the [licensing terms](https://raw.githubusercontent.com/jupyter/docker-stacks/master/LICENSE.md) of the above mentioned project. -**NOTE: Snowtire is not officially supported by Snowflake, and is provided as-is.** +**NOTE: Icetire is not officially supported by Snowflake, and is provided as-is.** # Prerequisites @@ -25,7 +25,7 @@ Please review the [licensing terms](https://raw.githubusercontent.com/jupyter/do **NOTE FOR WINDOWS** -On Windows, a common issue encountered is the configuration of line endings, which adds default CRLF Windows line endings to the script deploy_snowflake.sh causing the script to fail. You can either configure [```core.autocrlf```](https://docs.github.com/en/free-pro-team@latest/github/using-git/configuring-git-to-handle-line-endings#refreshing-a-repository-after-changing-line-endings) to ```false```, or use an editor like Notepad+++ to open the deploy_snowflake.sh file and save it in UNIX mode which will convert CRLF line endings into LF before you build the snowtire docker image. +On Windows, a common issue encountered is the configuration of line endings, which adds default CRLF Windows line endings to the script deploy_snowflake.sh causing the script to fail. You can either configure [```core.autocrlf```](https://docs.github.com/en/free-pro-team@latest/github/using-git/configuring-git-to-handle-line-endings#refreshing-a-repository-after-changing-line-endings) to ```false```, or use an editor like Notepad+++ to open the deploy_snowflake.sh file and save it in UNIX mode which will convert CRLF line endings into LF before you build the Icetire docker image. # Instructions @@ -41,14 +41,14 @@ git clone https://github.com/Snowflake-Labs/icetire.git cd icetire/ ``` -If you are just updating the repository to the latest version (always recommended before building a docker image). Run the following command from within your local clone (under snowtire directory): +If you are just updating the repository to the latest version (always recommended before building a docker image). Run the following command from within your local clone (under Icetire directory): ``` git pull ``` -## Build Snowtire docker image +## Build Icetire docker image There are two ways to build the image, either with the default levels, or by specifying actual driver levels while building. @@ -73,7 +73,7 @@ docker build --pull -t icetire . \ --build-arg spark_version=2.8.1-spark_2.4 \ --build-arg snowsql_version=1.2.9 \ --build-arg almond_version=0.10.0 \ ---build-arg scala_version=2.12.11 +--build-arg scala_version=2.12.11 ``` **NOTE: SnowSQL CLI has the ability to [auto-upgrade](https://docs.snowflake.net/manuals/user-guide/snowsql-install-config.html#label-understanding-auto-upgrades) to the latest version available. So, you may not need to specify a higher version.** @@ -121,8 +121,8 @@ You should see a message like the following the very first time you bring up thi [I 23:33:43.822 NotebookApp] The Jupyter Notebook is running at: [I 23:33:43.822 NotebookApp] http://(a8e53cbad3a0 or 127.0.0.1):8888/?token=eb2222f1a8cd14046ecc5177d4b1b5965446e3c34b8f42ad [I 23:33:43.822 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation). -[C 23:33:43.826 NotebookApp] - +[C 23:33:43.826 NotebookApp] + To access the notebook, open this file in a browser: file:///home/jovyan/.local/share/jupyter/runtime/nbserver-17-open.html Or copy and paste one of these URLs: @@ -136,19 +136,19 @@ You should see a message like the following the very first time you bring up thi ``` docker logs spare-0 --tail 10 ``` - + - Open a bash session on the docker container - + ``` docker exec -it spare-0 /bin/bash ``` - + Then run the following command: - + ``` jupyter notebook list ``` - + ## Accessing the image Open a web browser on: http://localhost:8888 @@ -157,7 +157,7 @@ It will prompt you for a Password or token. Enter the token you have in the prev ## Working with the image -Snowtire come with 4 different small examples of python notebooks allowing to test various connectors including odbc, jdbc, spark. You will need to customize your Snowflake account name, your credentials (user/password), database name and warehouse. +Icetire come with 4 different small examples of python notebooks allowing to test various connectors including odbc, jdbc, spark. You will need to customize your Snowflake account name, your credentials (user/password), database name and warehouse. You can always upload to the jupyter environment any demo notebook from the main interface. See the Upload button at the top right: @@ -286,7 +286,7 @@ This workaround is also valid with Snowpark. #### Spark Notebook fail when using JDK 11 #### -The May 19 update of Snowtire installs JDK 11, which is incompatible with Spark 2.4. You may see the following stack when trying to run your spark notebooks: +The May 19 update of Icetire installs JDK 11, which is incompatible with Spark 2.4. You may see the following stack when trying to run your spark notebooks: ``` y4JJavaError: An error occurred while calling o84.showString. @@ -331,7 +331,7 @@ In case you have the Python kernel dying while running the notebook, and you wan import logging import os - + for logger_name in ['snowflake','botocore','azure']: logger = logging.getLogger(logger_name) logger.setLevel(logging.DEBUG) @@ -371,4 +371,4 @@ This is caused by Windows CRLF line ending special characters added to the deplo --- #### Known Issues Log #### -Please check [known issues](known_issues.md) log for known issues with Icetire. +Please check [known issues](known_issues.md) log for known issues with Icetire.