Skip to content

Commit

Permalink
#284: Improved User Guide regarding Docker volumes
Browse files Browse the repository at this point in the history
  • Loading branch information
ckunki committed Jun 13, 2024
1 parent 941c0a1 commit 1e92ddb
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
7 changes: 4 additions & 3 deletions doc/changes/changes_2.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,15 @@ Code name: TBD

## Summary

TBD
This release adds support for parameters for SaaS instances of Exasol database to the configuration page, improves documentation and fixes vulnerability `CVE-2024-23342` by updating dependencies.

## AI-Lab-Release

Version: 2.1.0

## Features

* 277 Added the SaaS database parameters to the configuration page.
* 279 Made the notebooks tests running in SaaS as well as in the Docker-DB.
* #277: Added the SaaS database parameters to the configuration page.

## Security

Expand All @@ -26,8 +25,10 @@ n/a
## Documentation

* #249: Added a troubleshooting section to the user guide documenting died kernel for transformers/te_init.ipynb.
* #284: Improved User Guide regarding Docker volumes

## Refactoring

* #267: Switched CodeBuildWaiter to use tenacity
* #276: Started using the new ITDE Manager interface in the notebook-connector 0.2.9
* #279: Made the notebooks tests running in SaaS as well as in the Docker-DB.
2 changes: 2 additions & 0 deletions doc/user_guide/docker/docker-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ AI-Lab also offers a [short introduction](intro.md) to Docker Images and Contain
The Unix shell commands in the following sections will use some environment variables. By this you can adapt the commands to your specific preferences while still being able to execute them literally:
* Variable `VERSION` refers to the version of Exasol AI-Lab Docker Edition you want to use, alternatively you can use `latest`.
* Variable `VOLUME` is expected to contain the name of your Docker volume, see [Managing User Data](managing-user-data.md).
* The related Command line option `--volume` is optional and enables keeping your changes to notebook files or the configuration parameters across separate sessions with the AI-Lab Docker Edition.
* Variable `LISTEN_IP` defines the range of IP-addresses allowed to connect to the forwarded Jupyter port.
* `0.0.0.0` means all IP-addresses are allowed.
* For local setups, we recommend `127.0.0.1`.
Expand Down Expand Up @@ -40,6 +41,7 @@ The following command will
* Download the Docker image for the specified version `$VERSION` of the AI-Lab if the image of the specified version is not yet available in your Docker service
* Run a Docker container using this image
* Mount the volume `$VOLUME` to the directory `/home/jupyter/notebooks` inside the container
* Option `--volume` is optional and enables keeping your changes to notebook files or the configuration parameters across separate sessions with the AI-Lab Docker Edition, see [Managing User Data](managing-user-data.md).
* If the volume does not exist yet, then it will be created automatically.
* Forward port `49494` on the [daemon machine](prerequisites.md) to allow connections from all IP addresses matched by `$LISTEN_IP`

Expand Down
8 changes: 4 additions & 4 deletions doc/user_guide/docker/managing-user-data.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Managing User Data

Exasol AI-Lab comes with a set of Jupyter Notebook Files with file extension `.ipynb` demonstrating AI applications on top of the Exasol database.

Additionally, the demos in the Exasol AI-Lab require some credentials and other configuration strings which are managed in a [Secure Configuration Storage](secure-configuration-storage.md) (SCS).
Exasol AI-Lab comes with a set of Jupyter Notebook Files with file extension `.ipynb` demonstrating AI applications on top of the Exasol database. Additionally, the demos in the Exasol AI-Lab require some credentials and other configuration strings which are managed in a [Secure Configuration Storage](secure-configuration-storage.md) (SCS).

By default, the AI-Lab will instantiate the notebook files with a predefined content. The predefined content may change with each release of the AI-Lab. However, the AI-Lab won't overwrite existing files.

The SCS on the other hand will be populated by the Exasol AI-Lab, including manual input from the user but also entries generated by the Exasol AI-Lab.

The Docker Edition of Exasol AI-Lab allows you to
Command line option `--volume` allows you to
* Keep your data and changes in these files
* Reuse modified files in future sessions
* Backup and restore the files

See [User Guide](docker-usage.md) for the AI-Lab Docker Edition.

## Basics

In order to save your changes persistently, to reuse, backup, and restore them, the AI-Lab
Expand Down

0 comments on commit 1e92ddb

Please sign in to comment.