mirror of
https://github.com/jupyter/docker-stacks.git
synced 2025-10-18 15:32:56 +00:00
Warn outdated recipes might be broken (#1954)
This commit is contained in:
@@ -4,7 +4,8 @@ We welcome contributions of [recipes](../using/recipes.md), short examples of us
|
|||||||
Follow the process below to add a new recipe:
|
Follow the process below to add a new recipe:
|
||||||
|
|
||||||
1. Open the `docs/using/recipes.md` source file.
|
1. Open the `docs/using/recipes.md` source file.
|
||||||
2. Add a second-level Markdown heading naming your recipe at the bottom of the file (e.g., `## Add the RISE extension`)
|
2. Add a second-level Markdown heading naming your recipe at the bottom of the file (e.g., `## Slideshows with JupyterLab and RISE`)
|
||||||
3. Write the body of your recipe under the heading, including whatever command line, Dockerfile, links, etc. you need.
|
3. Write the body of your recipe under the heading, including whatever command line, links, etc. you need.
|
||||||
4. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request) (PR) with your changes.
|
4. Please, put your Dockerfile in a `recipe_code` subfolder.
|
||||||
|
5. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request) (PR) with your changes.
|
||||||
Maintainers will respond and work with you to address any formatting or content issues.
|
Maintainers will respond and work with you to address any formatting or content issues.
|
||||||
|
@@ -46,6 +46,10 @@ docker build --rm -t my-custom-image .
|
|||||||
|
|
||||||
## Add a custom conda environment and Jupyter kernel
|
## Add a custom conda environment and Jupyter kernel
|
||||||
|
|
||||||
|
```{warning}
|
||||||
|
This recipe is not tested and might be broken.
|
||||||
|
```
|
||||||
|
|
||||||
The default version of Python that ships with the image may not be the version you want.
|
The default version of Python that ships with the image may not be the version you want.
|
||||||
The instructions below permit adding a conda environment with a different Python version and making it accessible to Jupyter.
|
The instructions below permit adding a conda environment with a different Python version and making it accessible to Jupyter.
|
||||||
|
|
||||||
@@ -106,6 +110,10 @@ docker run -it --rm \
|
|||||||
|
|
||||||
## Let's Encrypt a Server
|
## Let's Encrypt a Server
|
||||||
|
|
||||||
|
```{warning}
|
||||||
|
This recipe is not tested and might be broken.
|
||||||
|
```
|
||||||
|
|
||||||
See the README for a basic automation here
|
See the README for a basic automation here
|
||||||
<https://github.com/jupyter/docker-stacks/tree/main/examples/make-deploy>
|
<https://github.com/jupyter/docker-stacks/tree/main/examples/make-deploy>
|
||||||
which includes steps for requesting and renewing a Let's Encrypt certificate.
|
which includes steps for requesting and renewing a Let's Encrypt certificate.
|
||||||
@@ -133,6 +141,10 @@ You can find the original Jupyter Notebook extenstion [here](https://github.com/
|
|||||||
|
|
||||||
## Running behind an nginx proxy
|
## Running behind an nginx proxy
|
||||||
|
|
||||||
|
```{warning}
|
||||||
|
This recipe is not tested and might be broken.
|
||||||
|
```
|
||||||
|
|
||||||
Sometimes it is helpful to run the Jupyter instance behind an nginx proxy, for example:
|
Sometimes it is helpful to run the Jupyter instance behind an nginx proxy, for example:
|
||||||
|
|
||||||
- you would prefer to access the notebook at a server URL with a path
|
- you would prefer to access the notebook at a server URL with a path
|
||||||
@@ -182,6 +194,10 @@ We also have contributed recipes for using JupyterHub.
|
|||||||
|
|
||||||
### Use JupyterHub's dockerspawner
|
### Use JupyterHub's dockerspawner
|
||||||
|
|
||||||
|
```{warning}
|
||||||
|
This recipe is not tested and might be broken.
|
||||||
|
```
|
||||||
|
|
||||||
In most cases for use with DockerSpawner, given an image that already has a notebook stack set up,
|
In most cases for use with DockerSpawner, given an image that already has a notebook stack set up,
|
||||||
you would only need to add:
|
you would only need to add:
|
||||||
|
|
||||||
@@ -211,6 +227,10 @@ A few suggestions have been made regarding using Docker Stacks with spark.
|
|||||||
|
|
||||||
### Using PySpark with AWS S3
|
### Using PySpark with AWS S3
|
||||||
|
|
||||||
|
```{warning}
|
||||||
|
This recipe is not tested and might be broken.
|
||||||
|
```
|
||||||
|
|
||||||
Using Spark session for Hadoop 2.7.3
|
Using Spark session for Hadoop 2.7.3
|
||||||
|
|
||||||
```python
|
```python
|
||||||
@@ -267,6 +287,10 @@ Ref: <https://github.com/jupyter/docker-stacks/issues/127>
|
|||||||
|
|
||||||
### Using Local Spark JARs
|
### Using Local Spark JARs
|
||||||
|
|
||||||
|
```{warning}
|
||||||
|
This recipe is not tested and might be broken.
|
||||||
|
```
|
||||||
|
|
||||||
```python
|
```python
|
||||||
import os
|
import os
|
||||||
|
|
||||||
@@ -291,6 +315,10 @@ Ref: <https://github.com/jupyter/docker-stacks/issues/154>
|
|||||||
|
|
||||||
### Using spark-packages.org
|
### Using spark-packages.org
|
||||||
|
|
||||||
|
```{warning}
|
||||||
|
This recipe is not tested and might be broken.
|
||||||
|
```
|
||||||
|
|
||||||
If you'd like to use packages from [spark-packages.org](https://spark-packages.org/), see
|
If you'd like to use packages from [spark-packages.org](https://spark-packages.org/), see
|
||||||
[https://gist.github.com/parente/c95fdaba5a9a066efaab](https://gist.github.com/parente/c95fdaba5a9a066efaab)
|
[https://gist.github.com/parente/c95fdaba5a9a066efaab](https://gist.github.com/parente/c95fdaba5a9a066efaab)
|
||||||
for an example of how to specify the package identifier in the environment before creating a
|
for an example of how to specify the package identifier in the environment before creating a
|
||||||
@@ -300,6 +328,10 @@ Ref: <https://github.com/jupyter/docker-stacks/issues/43>
|
|||||||
|
|
||||||
### Use jupyter/all-spark-notebooks with an existing Spark/YARN cluster
|
### Use jupyter/all-spark-notebooks with an existing Spark/YARN cluster
|
||||||
|
|
||||||
|
```{warning}
|
||||||
|
This recipe is not tested and might be broken.
|
||||||
|
```
|
||||||
|
|
||||||
```dockerfile
|
```dockerfile
|
||||||
FROM jupyter/all-spark-notebook
|
FROM jupyter/all-spark-notebook
|
||||||
|
|
||||||
@@ -375,8 +407,6 @@ Credit: [britishbadger](https://github.com/britishbadger) from [docker-stacks/is
|
|||||||
|
|
||||||
## Run Server inside an already secured environment (i.e., with no token)
|
## Run Server inside an already secured environment (i.e., with no token)
|
||||||
|
|
||||||
(Adapted from [issue 728](https://github.com/jupyter/docker-stacks/issues/728))
|
|
||||||
|
|
||||||
The default security is very good.
|
The default security is very good.
|
||||||
There are use cases, encouraged by containers, where the jupyter container and the system it runs within lie inside the security boundary.
|
There are use cases, encouraged by containers, where the jupyter container and the system it runs within lie inside the security boundary.
|
||||||
It is convenient to launch the server without a password or token in these use cases.
|
It is convenient to launch the server without a password or token in these use cases.
|
||||||
@@ -401,6 +431,10 @@ docker run -it --rm \
|
|||||||
|
|
||||||
## Enable nbclassic-extension spellchecker for markdown (or any other nbclassic-extension)
|
## Enable nbclassic-extension spellchecker for markdown (or any other nbclassic-extension)
|
||||||
|
|
||||||
|
```{warning}
|
||||||
|
This recipe is not tested and might be broken.
|
||||||
|
```
|
||||||
|
|
||||||
NB: this works for classic notebooks only
|
NB: this works for classic notebooks only
|
||||||
|
|
||||||
```dockerfile
|
```dockerfile
|
||||||
@@ -420,6 +454,10 @@ Ref: <https://github.com/jupyter/docker-stacks/issues/675>
|
|||||||
|
|
||||||
## Enable Delta Lake in Spark notebooks
|
## Enable Delta Lake in Spark notebooks
|
||||||
|
|
||||||
|
```{warning}
|
||||||
|
This recipe is not tested and might be broken.
|
||||||
|
```
|
||||||
|
|
||||||
Please note that the [Delta Lake](https://delta.io/) packages are only available for Spark version > `3.0`.
|
Please note that the [Delta Lake](https://delta.io/) packages are only available for Spark version > `3.0`.
|
||||||
By adding the properties to `spark-defaults.conf`, the user no longer needs to enable Delta support in each notebook.
|
By adding the properties to `spark-defaults.conf`, the user no longer needs to enable Delta support in each notebook.
|
||||||
|
|
||||||
@@ -448,6 +486,10 @@ RUN echo "from pyspark.sql import SparkSession" > /tmp/init-delta.py && \
|
|||||||
|
|
||||||
## Add Custom Fonts in Scipy notebook
|
## Add Custom Fonts in Scipy notebook
|
||||||
|
|
||||||
|
```{warning}
|
||||||
|
This recipe is not tested and might be broken.
|
||||||
|
```
|
||||||
|
|
||||||
The example below is a Dockerfile to load Source Han Sans with normal weight, usually used for the web.
|
The example below is a Dockerfile to load Source Han Sans with normal weight, usually used for the web.
|
||||||
|
|
||||||
```dockerfile
|
```dockerfile
|
||||||
@@ -465,6 +507,10 @@ RUN PYV=$(ls "${CONDA_DIR}/lib" | grep ^python) && \
|
|||||||
|
|
||||||
## Enable clipboard in pandas on Linux systems
|
## Enable clipboard in pandas on Linux systems
|
||||||
|
|
||||||
|
```{warning}
|
||||||
|
This recipe is not tested and might be broken.
|
||||||
|
```
|
||||||
|
|
||||||
```{admonition} Additional notes
|
```{admonition} Additional notes
|
||||||
This solution works on Linux host systems.
|
This solution works on Linux host systems.
|
||||||
It is not required on Windows and won't work on macOS.
|
It is not required on Windows and won't work on macOS.
|
||||||
@@ -483,6 +529,10 @@ docker run -it --rm \
|
|||||||
|
|
||||||
## Add ijavascript kernel to container
|
## Add ijavascript kernel to container
|
||||||
|
|
||||||
|
```{warning}
|
||||||
|
This recipe is not tested and might be broken.
|
||||||
|
```
|
||||||
|
|
||||||
The example below is a Dockerfile to install the [ijavascript kernel](https://github.com/n-riesco/ijavascript).
|
The example below is a Dockerfile to install the [ijavascript kernel](https://github.com/n-riesco/ijavascript).
|
||||||
|
|
||||||
```dockerfile
|
```dockerfile
|
||||||
|
Reference in New Issue
Block a user