Skip to content

Commit

Permalink
Prepare release 2.0.0rc1
Browse files Browse the repository at this point in the history
  • Loading branch information
lresende committed Mar 26, 2019
1 parent e722427 commit cde2f8e
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ SA:=source activate
ENV:=enterprise-gateway-dev
SHELL:=/bin/bash

VERSION:=2.0.0.dev1
VERSION:=2.0.0rc1

ifeq (dev, $(findstring dev, $(VERSION)))
TAG:=dev
Expand Down
6 changes: 3 additions & 3 deletions docs/source/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ By default, this container will start with enterprise gateway running as a servi

We plan on producing one image per release to the [enterprise-gateway-demo docker repo](https://hub.docker.com/r/elyra/enterprise-gateway-demo/) where the image's tag reflects the corresponding release.

To build a local image, run `make docker-image-enterprise-gateway-demo`. Because this is a development build, the tag for this image will reflect the value of the VERSION variable in the root Makefile (e.g. 2.0.0.dev1).
To build a local image, run `make docker-image-enterprise-gateway-demo`. Because this is a development build, the tag for this image will reflect the value of the VERSION variable in the root Makefile (e.g. 2.0.0rc1).

### elyra/nb2kg

Image [elyra/nb2kg](https://hub.docker.com/r/elyra/nb2kg/) is a simple image built on [jupyterhub/k8s-singleuser-sample](https://hub.docker.com/r/https://hub.docker.com/r/jupyterhub/k8s-singleuser-sample/) along with the latest release of [NB2KG](https://github.com/jupyter/nb2kg). The image also sets some of the new variables that pertain to enterprise gateway (e.g., `KG_REQUEST_TIMEOUT`, `KG_HTTP_USER`, `KERNEL_USERNAME`, etc.).

To build a local image, run `make docker-image-nb2kg`. Because this is a development build, the tag for this image will reflect the value of the VERSION variable in the root Makefile (e.g. 2.0.0.dev1).
To build a local image, run `make docker-image-nb2kg`. Because this is a development build, the tag for this image will reflect the value of the VERSION variable in the root Makefile (e.g. 2.0.0rc1).

## Runtime Images
The following sections describe the docker images used within Kubernetes and Docker Swarm environments - all of which can be pulled from the [Enterprise Gateway organization](https://hub.docker.com/r/elyra/) on dockerhub.
Expand Down Expand Up @@ -199,4 +199,4 @@ cp -r python_kubernetes python_myCustomKernel
```
- If using a whitelist (`EG_KERNEL_WHITELIST`), be sure to update it with the new kernelspec directory name (e.g., `python_myCustomKernel`) and restart/redeploy Enterprise Gateway.
- Launch or refresh your Notebook session and confirm `My Custom Kernel` appears in the _new kernel_ drop-down.
- Create a new notebook using `My Custom Kernel`.
- Create a new notebook using `My Custom Kernel`.
4 changes: 2 additions & 2 deletions docs/source/getting-started-client-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ EG_REMOTE_HOSTS=elyra-node-1.fyre.ibm.com,elyra-node-2.fyre.ibm.com,elyra-node-3
### Configuring Kernels for YARN Client mode

For each supported Jupyter Kernel, we have provided sample kernel configurations and launchers as part of the release
[e.g. jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz](https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0.dev1/jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz).
[e.g. jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz](https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0rc1/jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz).

Considering we would like to enable the IPython Kernel that comes pre-installed with Anaconda to run on
Yarn Client mode, we would have to copy the sample configuration folder **spark_python_yarn_client**
to where the Jupyter kernels are installed (e.g. jupyter kernelspec list)

``` Bash
wget https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0.dev1/jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz
wget https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0rc1/jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz

SCALA_KERNEL_DIR="$(jupyter kernelspec list | grep -w "python3" | awk '{print $2}')"

Expand Down
6 changes: 3 additions & 3 deletions docs/source/getting-started-cluster-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,20 @@ EG_YARN_ENDPOINT=http://${YARN_RESOURCE_MANAGER_FQDN}:8088/ws/v1/cluster #Common

### Configuring Kernels for YARN Cluster mode

For each supported Jupyter Kernel, we have provided sample kernel configurations and launchers as part of the release [e.g. jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz](https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0.dev1/jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz).
For each supported Jupyter Kernel, we have provided sample kernel configurations and launchers as part of the release [e.g. jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz](https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0rc1/jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz).

Considering we would like to enable the IPython Kernel that comes pre-installed with Anaconda to run on Yarn Cluster mode, we would have to copy the sample configuration folder **spark_python_yarn_cluster** to where the Jupyter kernels are installed (e.g. jupyter kernelspec list)

``` Bash
wget https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0.dev1/jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz
wget https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0rc1/jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz

SCALA_KERNEL_DIR="$(jupyter kernelspec list | grep -w "python3" | awk '{print $2}')"

KERNELS_FOLDER="$(dirname "${SCALA_KERNEL_DIR}")"

mkdir $KERNELS_FOLDER/spark_python_yarn_cluster/

tar -zxvf jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz --strip 1 --directory $KERNELS_FOLDER/spark_python_yarn_cluster/ spark_python_yarn_cluster/
tar -zxvf jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz --strip 1 --directory $KERNELS_FOLDER/spark_python_yarn_cluster/ spark_python_yarn_cluster/

```

Expand Down
20 changes: 10 additions & 10 deletions docs/source/getting-started-kernels.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The following kernels have been tested with the Jupyter Enterprise Gateway:
* Scala 2.11/Apache Spark 2.x with Apache Toree kernel
* R/Apache Spark 2.x with IRkernel

We provide sample kernel configuration and launcher tar files as part of [each release](https://github.com/jupyter/enterprise_gateway/releases) (e.g. [jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz](https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0.dev1/jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz)) that can be extracted and modified to fit your configuration.
We provide sample kernel configuration and launcher tar files as part of [each release](https://github.com/jupyter/enterprise_gateway/releases) (e.g. [jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz](https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0rc1/jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz)) that can be extracted and modified to fit your configuration.

Please find below more details on the specific kernels supported by Enterprise Gateway. In each of the sections we set the `KERNELS_FOLDER` to `/usr/local/share/jupyter/kernels` since that's one of the default locations searched by the Jupyter framework. Co-locating kernelspecs hierarchies in the same parent folder is recommended, although not required.

Expand All @@ -24,13 +24,13 @@ Follow the steps below to install/configure the Toree kernel:
Considering we would like to enable the Scala Kernel to run on YARN Cluster and Client mode we would have to copy the sample configuration folder **spark_scala_yarn_client** and **spark_scala_yarn_cluster** to where the Jupyter kernels are installed (e.g. jupyter kernelspec list)

``` Bash
wget https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0.dev1/jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz
wget https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0rc1/jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz

KERNELS_FOLDER=/usr/local/share/jupyter/kernels

tar -zxvf jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz --strip 1 --directory $KERNELS_FOLDER/spark_scala_yarn_cluster/ spark_scala_yarn_cluster/
tar -zxvf jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz --strip 1 --directory $KERNELS_FOLDER/spark_scala_yarn_cluster/ spark_scala_yarn_cluster/

tar -zxvf jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz --strip 1 --directory $KERNELS_FOLDER/spark_scala_yarn_client/ spark_scala_yarn_client/
tar -zxvf jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz --strip 1 --directory $KERNELS_FOLDER/spark_scala_yarn_client/ spark_scala_yarn_client/

```

Expand All @@ -46,13 +46,13 @@ The IPython kernel comes pre-installed with Anaconda and we have tested with its
Considering we would like to enable the IPython kernel to run on YARN Cluster and Client mode we would have to copy the sample configuration folder **spark_python_yarn_client** and **spark_python_yarn_client** to where the Jupyter kernels are installed (e.g. jupyter kernelspec list)

``` Bash
wget https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0.dev1/jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz
wget https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0rc1/jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz

KERNELS_FOLDER=/usr/local/share/jupyter/kernels

tar -zxvf jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz --strip 1 --directory $KERNELS_FOLDER/spark_python_yarn_cluster/ spark_python_yarn_cluster/
tar -zxvf jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz --strip 1 --directory $KERNELS_FOLDER/spark_python_yarn_cluster/ spark_python_yarn_cluster/

tar -zxvf jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz --strip 1 --directory $KERNELS_FOLDER/spark_python_yarn_client/ spark_python_yarn_client/
tar -zxvf jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz --strip 1 --directory $KERNELS_FOLDER/spark_python_yarn_client/ spark_python_yarn_client/
```

For more information about the IPython kernel, please visit the [IPython kernel](http://ipython.readthedocs.io/en/stable/) page.
Expand Down Expand Up @@ -88,13 +88,13 @@ ls $ANACONDA_HOME/lib/R/library
Considering we would like to enable the IRkernel to run on YARN Cluster and Client mode we would have to copy the sample configuration folder **spark_R_yarn_client** and **spark_R_yarn_client** to where the Jupyter kernels are installed (e.g. jupyter kernelspec list)

``` Bash
wget https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0.dev1/jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz
wget https://github.com/jupyter/enterprise_gateway/releases/download/v2.0.0rc1/jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz

KERNELS_FOLDER=/usr/local/share/jupyter/kernels

tar -zxvf jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz --strip 1 --directory $KERNELS_FOLDER/spark_R_yarn_cluster/ spark_R_yarn_cluster/
tar -zxvf jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz --strip 1 --directory $KERNELS_FOLDER/spark_R_yarn_cluster/ spark_R_yarn_cluster/

tar -zxvf jupyter_enterprise_gateway_kernelspecs-2.0.0.dev1.tar.gz --strip 1 --directory $KERNELS_FOLDER/spark_R_yarn_client/ spark_R_yarn_client/
tar -zxvf jupyter_enterprise_gateway_kernelspecs-2.0.0rc1.tar.gz --strip 1 --directory $KERNELS_FOLDER/spark_R_yarn_client/ spark_R_yarn_client/
```

For more information about the iR kernel, please visit the [IRkernel](https://irkernel.github.io/) page.
2 changes: 1 addition & 1 deletion enterprise_gateway/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.

__version__ = '2.0.0.dev1'
__version__ = '2.0.0rc1'
2 changes: 1 addition & 1 deletion etc/kubernetes/enterprise-gateway.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ spec:
value: "['r_kubernetes','python_kubernetes','python_tf_kubernetes','python_tf_gpu_kubernetes','scala_kubernetes','spark_r_kubernetes','spark_python_kubernetes','spark_scala_kubernetes']"

# Ensure the following VERSION tag is updated to the version of Enterprise Gateway you wish to run
image: elyra/enterprise-gateway:dev
image: elyra/enterprise-gateway:2.0.0rc1
# Use IfNotPresent policy so that dev-based systems don't automatically
# update. This provides more control. Since formal tags will be release-specific
# this policy should be sufficient for them as well.
Expand Down

0 comments on commit cde2f8e

Please sign in to comment.