From 49ec33c185a698c23d0a28e0aebbef21733c4289 Mon Sep 17 00:00:00 2001 From: Alan Chin Date: Mon, 13 Sep 2021 15:23:42 -0700 Subject: [PATCH] Update elyra installation documentation (#2137) Update root readme with instructions to install Elyra with kfp-tekton by default e.g. the [all] option. Fixes #2133 --- README.md | 16 ++++++++++++++-- docs/source/getting_started/installation.md | 4 ++-- etc/docker/README.md | 2 +- 3 files changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3a3526d16..a5d51f70d 100644 --- a/README.md +++ b/README.md @@ -102,12 +102,24 @@ Elyra can be installed from PyPI: * [JupyterLab](https://github.com/jupyterlab/jupyterlab) 3.x is supported on **Elyra 2.0.0 and above** - Install from PyPI: + Install Elyra from PyPI ( Elyra >= 3.1.0 ): + + ```bash + pip3 install --upgrade "elyra[all]>=3.1.0" && jupyter lab build + ``` + + Install fom Conda ( Elyra >= 3.1.0 ): + ```bash + conda install -c conda-forge "elyra[all]>=3.1.0" && jupyter lab build + ``` + + Install Elyra from PyPI ( Elyra < 3.1.0 ): + ```bash pip3 install --upgrade "elyra>=2.0.1" && jupyter lab build ``` - Install fom Conda: + Install fom Conda ( Elyra < 3.1.0 ): ```bash conda install -c conda-forge "elyra>=2.0.1" && jupyter lab build ``` diff --git a/docs/source/getting_started/installation.md b/docs/source/getting_started/installation.md index 7f68dcb56..a128a092a 100644 --- a/docs/source/getting_started/installation.md +++ b/docs/source/getting_started/installation.md @@ -40,7 +40,7 @@ The instructions below are installing the latest release. If you use `pip`, install Elyra with: ```bash -pip3 install --upgrade elyra && jupyter lab build +pip3 install --upgrade elyra[all] && jupyter lab build ``` If desired, you can install these Elyra extensions independently: @@ -74,7 +74,7 @@ If desired, you can install these Elyra extensions independently: If you use `conda`, install Elyra with: ```bash -conda install -c conda-forge elyra && jupyter lab build +conda install -c conda-forge elyra[all] && jupyter lab build ``` or install the Pipeline editor, Code Snippet, or Script editor extensions individually: diff --git a/etc/docker/README.md b/etc/docker/README.md index d9716ff68..13ccb9223 100644 --- a/etc/docker/README.md +++ b/etc/docker/README.md @@ -25,7 +25,7 @@ Builds the Elyra image for use as standalone or with JupyterHub. See [Deploying Elyra on OpenShift is available via Open Data Hub. Elyra Image is available via [quay.io](https://quay.io/repository/thoth-station/s2i-lab-elyra?tab=tags) and supporting image build files via [s2i-lab-elyra](https://github.com/opendatahub-io/s2i-lab-elyra) ### kubeflow (Open Data Hub) -Build the Elyra image for use with Kubeflow's Notebook Server. See [Using Elyra with the Kubeflow Notebook Server](https://elyra.readthedocs.io/en/latest/recipes/using-elyra-with-kubeflow-notebook-server.html) +Build the Elyra image for use with Kubeflow's Notebook Server. This image includes all kfp dependencies (i.e. kfp, kfp-tekton). See [Using Elyra with the Kubeflow Notebook Server](https://elyra.readthedocs.io/en/latest/recipes/using-elyra-with-kubeflow-notebook-server.html) ### tensorflow Builds custom tensorflow v1.15.2 runtime images for use with Elyra, one with GPU libraries and support and one without.