From 8daf6f3d4ad54c0f124e5b20a6d84ad72c698aa5 Mon Sep 17 00:00:00 2001 From: Juan Pardo Date: Thu, 5 Nov 2026 11:28:16 +0100 Subject: [PATCH 1/5] Main cratedb-ee docs files --- cratedb-ee-docs/make.bat | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 cratedb-ee-docs/make.bat diff --git a/cratedb-ee-docs/make.bat b/cratedb-ee-docs/make.bat new file mode 100644 index 0000000..32bb245 --- /dev/null +++ b/cratedb-ee-docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd From 5fedbc799591fb45da668694e8e1de0b8dea7efe Mon Sep 17 00:00:00 2001 From: Juan Pardo Date: Thu, 5 Nov 2026 11:28:30 +0100 Subject: [PATCH 2/5] cratedb-ee-docs readthedocs.yaml --- cratedb-ee-docs/.readthedocs.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 cratedb-ee-docs/.readthedocs.yml diff --git a/cratedb-ee-docs/.readthedocs.yml b/cratedb-ee-docs/.readthedocs.yml new file mode 100644 index 0000000..f39c639 --- /dev/null +++ b/cratedb-ee-docs/.readthedocs.yml @@ -0,0 +1,15 @@ +build: + os: "ubuntu-22.04" + tools: + python: "3.11" + +sphinx: + builder: html + configuration: ./conf.py + fail_on_warning: true + +python: + install: + - requirements: ./requirements.txt + +version: 2 From ca2f0d02e04981a07990fd2632774c1217cd0033 Mon Sep 17 00:00:00 2001 From: Juan Pardo Date: Thu, 5 Nov 2026 14:52:25 +0100 Subject: [PATCH 3/5] Readthedocs rename --- cratedb-ee-docs/.readthedocs.yml | 15 --------------- 1 file changed, 15 deletions(-) delete mode 100644 cratedb-ee-docs/.readthedocs.yml diff --git a/cratedb-ee-docs/.readthedocs.yml b/cratedb-ee-docs/.readthedocs.yml deleted file mode 100644 index f39c639..0000000 --- a/cratedb-ee-docs/.readthedocs.yml +++ /dev/null @@ -1,15 +0,0 @@ -build: - os: "ubuntu-22.04" - tools: - python: "3.11" - -sphinx: - builder: html - configuration: ./conf.py - fail_on_warning: true - -python: - install: - - requirements: ./requirements.txt - -version: 2 From 85a36a5adcc0dab2fcca8c2b29bc27d6b586e5a5 Mon Sep 17 00:00:00 2001 From: Juan Pardo Date: Fri, 6 Nov 2026 11:21:22 +0100 Subject: [PATCH 4/5] Applied internal feedback to the CrateDB EE installation --- cratedb-ee-docs/install/prerequisites.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/cratedb-ee-docs/install/prerequisites.rst b/cratedb-ee-docs/install/prerequisites.rst index 35e78ad..932416d 100644 --- a/cratedb-ee-docs/install/prerequisites.rst +++ b/cratedb-ee-docs/install/prerequisites.rst @@ -13,6 +13,8 @@ CrateDB EE console has the following requirements: - The machine where the CrateDB EE console is to be installed must be able to reach the Internet to download the package. - Requires being able to modify the configuration of all CrateDB nodes. - Requires restarting all CrateDB nodes. +- If a truststore is not already present in the CrateDB cluster, files must be copied to all CrateDB nodes. +- Please note the use of CrateDB Cloud clusters is not supported. Preparing the CrateDB cluster for the installation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -20,7 +22,7 @@ Preparing the CrateDB cluster for the installation The installation requires a CrateDB user that can authenticate from the machine where the installation will take place. -That user needs the privilege ``AL`` because it will create new users. +That user needs the privilege ``AL`` to create new users and ``DQL`` to perform several checks. For more information about privileges you can read the `CrateDB privileges documentation `_. You will need to create a user if none is available yet. @@ -30,7 +32,7 @@ This can be done with the following SQL statement: .. code-block:: sql CREATE USER WITH (password = ''); - GRANT AL TO ; + GRANT AL, DQL TO ; If your CrateDB configuration already has host based authentication you may need to add a new configuration entry to be able to authenticate with the user from the target machine. From 5736ce08ad2ea305d0c6894f3fdfa1b4e8f95aae Mon Sep 17 00:00:00 2001 From: Juan Pardo Date: Fri, 13 Nov 2026 12:04:06 +0100 Subject: [PATCH 5/5] fixup! Applied internal feedback to the CrateDB EE installation --- cratedb-ee-docs/make.bat | 35 ----------------------------------- 1 file changed, 35 deletions(-) delete mode 100644 cratedb-ee-docs/make.bat diff --git a/cratedb-ee-docs/make.bat b/cratedb-ee-docs/make.bat deleted file mode 100644 index 32bb245..0000000 --- a/cratedb-ee-docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=. -set BUILDDIR=_build - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.https://www.sphinx-doc.org/ - exit /b 1 -) - -if "%1" == "" goto help - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd