From 3c1df5d2025b3f76951e134f9fe40742ff111ccd Mon Sep 17 00:00:00 2001 From: Brian Munkholm Date: Wed, 19 Nov 2025 14:23:42 +0100 Subject: [PATCH 1/3] Clarify CrateDB Admin UI documentation Updated the description of the CrateDB Admin UI for clarity and added details about its accessibility and intended use. --- docs/index.rst | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 96cca334..06804938 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,15 +4,22 @@ The CrateDB Admin UI ==================== -CrateDB ships with a web administration user interface (or *Admin UI*). +CrateDB ships with a web administration user interface (aka *Admin UI*) +that you can use to inspect and interact with any CrateDB cluster. -The CrateDB Admin UI runs on every CrateDB node. You can use it to inspect -and interact with the whole CrateDB cluster in a number of ways. +.. NOTE:: + +The tool is primarily intended for self-hosted clusters and +mirrors the relevant features of the CreateDB Cloud Console. Cloud +users can also benefit from the Admin UI by using it to view +:ref:`shards ` or to provide console access to users +without full admin access to the Cloud Console. Connecting ========== -You can access the Admin UI via HTTP on port ``4200``:: +The Admin UI runs on every CrateDB node and can be accessed on port +``4200``:: http://HOSTNAME:4200/ From e0be5a7d855062795cd8fcee1bd097d4bf1bccdf Mon Sep 17 00:00:00 2001 From: Brian Munkholm Date: Wed, 19 Nov 2025 14:34:31 +0100 Subject: [PATCH 2/3] Fix formatting in docs/index.rst --- docs/index.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 06804938..a1bdcbcc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,7 +8,6 @@ CrateDB ships with a web administration user interface (aka *Admin UI*) that you can use to inspect and interact with any CrateDB cluster. .. NOTE:: - The tool is primarily intended for self-hosted clusters and mirrors the relevant features of the CreateDB Cloud Console. Cloud users can also benefit from the Admin UI by using it to view From 97cb7902fc7dc58d305301586a329c495490af3d Mon Sep 17 00:00:00 2001 From: Brian Munkholm Date: Wed, 19 Nov 2025 14:49:35 +0100 Subject: [PATCH 3/3] Fix NOTE format --- docs/index.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index a1bdcbcc..ff64de17 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,11 +8,12 @@ CrateDB ships with a web administration user interface (aka *Admin UI*) that you can use to inspect and interact with any CrateDB cluster. .. NOTE:: -The tool is primarily intended for self-hosted clusters and -mirrors the relevant features of the CreateDB Cloud Console. Cloud -users can also benefit from the Admin UI by using it to view -:ref:`shards ` or to provide console access to users -without full admin access to the Cloud Console. + + The tool is primarily intended for self-hosted clusters and + mirrors the relevant features of the CreateDB Cloud Console. Cloud + users can also benefit from the Admin UI by using it to view + :ref:`shards ` or to provide console access to users + without full admin access to the Cloud Console. Connecting ==========