#277 Added SaaS configuration UI #278
+84
−44
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,20 +36,22 @@ | |
| "source": [ | ||
|
There was a problem hiding this comment. Line #246. header_lbl.value = ITDEStatus.disconnected.value Shouldn't be? header_lbl.value = ITDEStatus.running.value Reply via ReviewNB There was a problem hiding this comment. The names of the Enums are a bit confusing, I agree. The meaning of this state is that the Docker Container is running, but not connected to the network. In the notebook-connector (a helper module, where much of the Python code of the AI-Lab is moved) there are two flags - RUNNING and VISIBLE. In this state their values are respectively True and False. In the front-end this state is called DISCONNECTED because that's how it is displayed. Not ideal, but I can't think of a good fix. |
||
| "from typing import List\n", | ||
| "import os\n", | ||
| "\n", | ||
| "import ipywidgets as widgets\n", | ||
| "\n", | ||
| "from exasol.nb_connector.secret_store import Secrets\n", | ||
| "from exasol.nb_connector.ai_lab_config import AILabConfig as CKey, StorageBackend\n", | ||
| "from exasol.nb_connector.itde_manager import (bring_itde_up, get_itde_status, restart_itde, take_itde_down, ItdeContainerStatus)\n", | ||
| "from exasol.nb_connector.connections import get_backend\n", | ||
| "\n", | ||
| "\n", | ||
| "class ITDEStatus(Enum):\n", | ||
| " \"\"\"\n", | ||
| " Display status of the Exasol Docker-DB\n", | ||
| " \"\"\"\n", | ||
| " ready = 'Exasol Docker-DB is READY'\n", | ||
| " stopped = 'Exasol Docker-DB is STOPPED'\n", | ||
| " disconnected = 'Exasol Docker-DB is NOT CONNECTED'\n", | ||
| " missing = 'Exasol Docker-DB is NOT CREATED'\n", | ||
| " inaccessible = 'Exasol Docker-DB is INACCESSIBLE'\n", | ||
| "\n", | ||
|
|
@@ -61,16 +63,26 @@ | |
| "\n", | ||
| " ui_look = get_config_styles()\n", | ||
| "\n", | ||
| " db_options = ['Exasol Docker-DB', 'Exasol On-Prem Database', 'Exasol SaaS Database']\n", | ||
| " storage_backend = get_backend(conf)\n", | ||
| " if storage_backend == StorageBackend.saas:\n", | ||
| " db_choice = 2\n", | ||
| " elif conf.get(CKey.use_itde, 'True') == 'True':\n", | ||
| " db_choice = 0\n", | ||
| " else:\n", | ||
| " db_choice = 1\n", | ||
| " db_selector = widgets.RadioButtons(options=db_options, value=db_options[db_choice], \n", | ||
| " layout=ui_look.input_layout, style=ui_look.input_style)\n", | ||
| " select_btn = widgets.Button(description='Select', style=ui_look.button_style, layout=ui_look.button_layout)\n", | ||
| " header_lbl = widgets.Label(value='Exasol Database Choice', style=ui_look.header_style, layout=ui_look.header_layout)\n", | ||
| "\n", | ||
| "\n", | ||
| " def select_database(btn):\n", | ||
| " if db_selector.value == db_options[2]:\n", | ||
| " conf.save(CKey.storage_backend, StorageBackend.saas.name)\n", | ||
| " else:\n", | ||
| " conf.save(CKey.storage_backend, StorageBackend.onprem.name)\n", | ||
| " conf.save(CKey.use_itde, str(db_selector.value == db_options[0]))\n", | ||
| " btn.icon = 'check'\n", | ||
| "\n", | ||
| " def on_value_change(change):\n", | ||
|
|
@@ -85,7 +97,7 @@ | |
| " return ui\n", | ||
| "\n", | ||
| "\n", | ||
| "def get_onprem_db_config_ui(conf: Secrets) -> widgets.Widget:\n", | ||
| " \"\"\"\n", | ||
| " Creates a UI form for editing an external Exasol Database configuration.\n", | ||
| " \"\"\"\n", | ||
|
|
@@ -124,6 +136,32 @@ | |
| " return get_generic_config_ui(conf, inputs, group_names)\n", | ||
| "\n", | ||
| "\n", | ||
| "def get_saas_db_config_ui(conf: Secrets) -> widgets.Widget:\n", | ||
| " \"\"\"\n", | ||
| " Creates a UI form for editing the Exasol SaaS database configuration.\n", | ||
| " \"\"\"\n", | ||
| "\n", | ||
| " inputs = [\n", | ||
| " [\n", | ||
| " ('Service URL', widgets.Text(value=conf.get(CKey.saas_url, 'https://cloud.exasol.com')), CKey.saas_url),\n", | ||
| " ('Account ID', widgets.Password(value=conf.get(CKey.saas_account_id)), CKey.saas_account_id),\n", | ||
| " ('Database ID', widgets.Text(value=conf.get(CKey.saas_database_id)), CKey.saas_database_id),\n", | ||
| " ('Database Name', widgets.Text(value=conf.get(CKey.saas_database_name)), CKey.saas_database_name),\n", | ||
| " ('Personal Access Token', widgets.Password(value=conf.get(CKey.saas_token)), CKey.saas_token),\n", | ||
| " ('Default Schema', widgets.Text(value=conf.get(CKey.db_schema, 'AI_LAB')), CKey.db_schema)\n", | ||
| " ],\n", | ||
| " [\n", | ||
| " ('Validate Certificate', widgets.Checkbox(value=conf.get(CKey.cert_vld, 'True') == 'True', indent=False),\n", | ||
| " CKey.cert_vld),\n", | ||
| " ('Trusted CA File/Dir', widgets.Text(value=conf.get(CKey.trusted_ca)), CKey.trusted_ca)\n", | ||
| " ]\n", | ||
| " ]\n", | ||
| "\n", | ||
| " group_names = ['SaaS DB Configuration', 'TLS/SSL Configuration']\n", | ||
| "\n", | ||
| " return get_generic_config_ui(conf, inputs, group_names)\n", | ||
| "\n", | ||
| "\n", | ||
| "def get_docker_db_config_ui(conf: Secrets) -> widgets.Widget:\n", | ||
| " \"\"\"\n", | ||
| " Creates a UI form for editing the Exasol Docker-DB configuration.\n", | ||
|
|
@@ -147,18 +185,20 @@ | |
| " \"\"\"\n", | ||
| " Creates a db configuration UI, depending on the choice of the database.\n", | ||
| " \"\"\"\n", | ||
| " storage_backend = get_backend(conf)\n", | ||
| " if storage_backend == StorageBackend.saas:\n", | ||
| " return get_saas_db_config_ui(conf)\n", | ||
| " elif conf.get(CKey.use_itde, 'True') == 'True':\n", | ||
| " return get_docker_db_config_ui(conf)\n", | ||
| " else:\n", | ||
| " return get_onprem_db_config_ui(conf)\n", | ||
| "\n", | ||
| "\n", | ||
| "def _get_docker_db_action_buttons(conf: Secrets, itde_exists: bool, itde_ready: bool, \n", | ||
| " display_status: widgets.Widget) -> List[widgets.Button]:\n", | ||
| " \"\"\"\n", | ||
| " Creates one or two action buttons with the correspondent on_click functions for managing the\n", | ||
| " Exasol Docker-DB. Depending on the current status (idte_exists, itde_ready) of the docker\n", | ||
| " container, the \"Start\", \"Restart\" or both buttons are created.\n", | ||
| " When the action is completed successfully, the running status is displayed in the provided\n", | ||
| " widget (display_status).\n", | ||
|
|
@@ -168,14 +208,14 @@ | |
| " try:\n", | ||
| " # Need to check if the Exasol Docker-DB still exists and not running because\n", | ||
| " # the situation might have changed while the the widgets were hanging around.\n", | ||
| " itde_status_now = get_itde_status(conf)\n", | ||
| " if itde_status_now != ItdeContainerStatus.READY:\n", | ||
| " if itde_status_now == ItdeContainerStatus.ABSENT:\n", | ||
| " bring_itde_up(conf)\n", | ||
| " else:\n", | ||
| " restart_itde(conf)\n", | ||
| " # Indicate the successful completion.\n", | ||
| " display_status.value = ITDEStatus.ready.value\n", | ||
| " btn.icon = 'check'\n", | ||
| " except Exception as e:\n", | ||
| " popup_message('Failed to start the Exasol Docker-DB:' + str(e))\n", | ||
|
|
@@ -184,17 +224,17 @@ | |
| " try:\n", | ||
| " # Need to check again if the Exasol Docker-DB exists or not because\n", | ||
| " # the situation might have changed while the widgets were hanging around.\n", | ||
| " itde_status_now = get_itde_status(conf)\n", | ||
| " if itde_status_now != ItdeContainerStatus.ABSENT:\n", | ||
| " take_itde_down(conf)\n", | ||
| " bring_itde_up(conf)\n", | ||
| " # Indicate the successful completion.\n", | ||
| " display_status.value = ITDEStatus.ready.value\n", | ||
| " btn.icon = 'check'\n", | ||
| " except Exception as e:\n", | ||
| " popup_message('Failed to restart the Exasol Docker-DB:' + str(e))\n", | ||
| "\n", | ||
| " if itde_ready:\n", | ||
| " btn_restart = widgets.Button(description='Recreate and Start')\n", | ||
| " btn_restart.on_click(restart_docker_db)\n", | ||
| " return [btn_restart]\n", | ||
|
|
@@ -230,40 +270,39 @@ | |
| " # Check if the docker-socket has been mounted\n", | ||
| " socket_mounted = os.path.exists('/var/run/docker.sock')\n", | ||
| "\n", | ||
| " header_lbl = widgets.Label(style=ui_look.header_style, layout=ui_look.header_layout)\n", | ||
| " group_items = [header_lbl]\n", | ||
| " \n", | ||
| " if socket_mounted:\n", | ||
| " # Get and display the current status of the Exasol Docker-DB.\n", | ||
| " itde_status = get_itde_status(conf)\n", | ||
| " if itde_status == ItdeContainerStatus.READY:\n", | ||
| " header_lbl.value = ITDEStatus.ready.value\n", | ||
| " elif itde_status == ItdeContainerStatus.RUNNING:\n", | ||
| " header_lbl.value = ITDEStatus.disconnected.value\n", | ||
| " elif itde_status == ItdeContainerStatus.STOPPED:\n", | ||
| " header_lbl.value = ITDEStatus.stopped.value\n", | ||
| " else:\n", | ||
| " header_lbl.value = ITDEStatus.missing.value\n", | ||
| "\n", | ||
| " # Add a warning message about recreating an existing Exasol Docker-DB.\n", | ||
| " itde_exists = itde_status != ItdeContainerStatus.ABSENT\n", | ||
| " itde_ready = itde_status == ItdeContainerStatus.READY\n", | ||
| " if itde_exists:\n", | ||
| " warning_text = 'Please note that recreating the Exasol Docker-DB will result in the loss of all data stored in the ' \\\n", | ||
| " f'{\"running\" if itde_ready else \"existing\"} instance of the database!'\n", | ||
| " warning_html = _create_warning(warning_text)\n", | ||
| " group_items.append(widgets.Box([warning_html], layout=ui_look.row_layout))\n", | ||
| " \n", | ||
| " # Create action buttons.\n", | ||
| " action_buttons = _get_docker_db_action_buttons(conf, itde_exists, itde_ready, header_lbl)\n", | ||
| " for btn in action_buttons:\n", | ||
| " btn.style = ui_look.button_style\n", | ||
| " btn.layout = ui_look.button_layout\n", | ||
| " else:\n", | ||
| " from utils.useful_urls import UsefulURLs\n", | ||
| "\n", | ||
| " header_lbl.value = ITDEStatus.inaccessible.value\n", | ||
| " warning_text = f'The docker socket is not mounted. Please consult the ' \\\n", | ||
| " f'<a href=\"{UsefulURLs.user_manual_docker_db.value}\" target=\"_blank\">documentation</a> ' \\\n", | ||
| " 'on how to start the AI-Lab that will use the Integrated Exasol Docker-DB.'\n", | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copy & Paste error?
Reply via ReviewNB
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well spotted! Thanks.