Installing Jupyter Notebook Server on Linux

You can install IBM® Cognos® Analytics for Jupyter Notebook Server either on the same computer or on a different computer from where Cognos Analytics is installed.

The Jupyter Notebook Server supports Linux and Windows 10 platforms and requires Docker to be installed.

Note: Docker CE (Community Edition), Docker Engine, and Docker Desktop (CE) are supported at this time.

When you download and run the installer script, you load and start Docker containers. These containers allow Cognos Analytics users to create and edit Jupyter Notebook. By default, Cognos Analytics for Jupyter Server is configured with many of the most common data science/analytic Python packages. In Cognos Analytics on Premises 11.1.2, Jupyter Server includes packages from versions of Anaconda and PixieDust.

Tip: You can later upgrade the Python packages in your existing installation.

Before you begin

Install Docker on Linux before you install Jupyter Notebook Server. For more information, follow the procedures for one of these Linux distributions:

You must be added to the Docker group for any Docker command to run without root privileges.

You must set the fully qualified domain in Cognos Configuration using the following procedure:

In IBM Cognos Configuration, in the Explorer window, click Environment.
Under the Dispatcher URI for external applications set the fully qualified domain name (FQDN) for the IBM Cognos Analytics server.
Under the Gateway URI set the fully qualified domain name (FQDN) for the IBM Cognos Analytics server.
Click File > Save.
Restart the Cognos Analytics service.

About this task

For a demonstration of how to install Jupyter Notebook Server on Linux, watch this video:

Procedure

Download the IBM Cognos Analytics for Jupyter Notebook Server installer and Server repository from Passport Advantage.

Tip: See the Cognos Analytics 11.1.2 Download Document to find out which part number to download. Note that the Jupyter Server installer and Server repository are found only in the Linux eAssemblies.
Double click the installer file.

Follow the directions in the installation wizard to copy and install the files to your computer.

Tip: You can install on top of an older version of Jupyter Server.

The folder jupyter_installation_location/dist folder contains two subfolders:

dist/images

dist/scripts

Tip: The folder dist/scripts/unix contains all the scripts that you need to run.

Script	Purpose
build.sh	Run this to rebuild the images.
config.conf	Edit this configuration file to change Jupyter parameters.
install.sh	Run this to load and start the Docker containers.
prune.sh	Run this to remove old Docker images.
start.sh	Run this to start the Jupyter server.
stop.sh	Run this to stop the Jupyter server.
uninstall.sh	Run this to uninstall Jupyter server.

Ensure that you have execute permissions for each script:

Type chmod -R u+x dist/scripts/unix
Navigate to the dist/scripts/unix directory.
Type ./install.sh

The install script runs.

Results

All of the Jupyter Server Docker images are loaded from the jupyter_installation_location/dist/images directory and the Docker containers are started.

What to do next

After installing IBM Cognos Analytics for Jupyter Notebook Server, the following tasks can be performed:

If you want to change some default settings, you can configure the Jupyter Notebook Server.
The administrator must assign the Notebook capability to the appropriate users.
The administrator must enable IBM Cognos Analytics for Jupyter Notebook.

Uninstalling Jupyter Notebook Server

To uninstall Jupyter Notebook Server, navigate to the dist/scripts/unix directory and then type ./uninstall.sh