From b3deb0532e3b83f745c62bd2ca63576571e8e3b5 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Tue, 24 Oct 2023 13:00:09 +0700 Subject: [PATCH 1/4] Remove Cartridge and Cartridge CLI from build scripts --- build_submodules.sh | 44 -------------------------------------------- conf.py | 4 ---- pull_submodules.py | 2 -- 3 files changed, 50 deletions(-) diff --git a/build_submodules.sh b/build_submodules.sh index a083ebfc47..e19e7258a0 100755 --- a/build_submodules.sh +++ b/build_submodules.sh @@ -12,50 +12,6 @@ po_dest="${project_root}/locale/ru/LC_MESSAGES" cp README.rst doc/contributing/docs/_includes/README.rst -# Cartridge -cartridge_root="${project_root}/modules/cartridge" - -# Build Cartridge to extract docs -cd "${cartridge_root}" || exit -CMAKE_DUMMY_WEBUI=true tarantoolctl rocks make - -# Copy Cartridge docs, including diagrams and images -cartridge_rst_src="${cartridge_root}/build.luarocks/build.rst" -cartridge_rst_dest="${project_root}/doc/book/cartridge" -cd "${cartridge_rst_src}" || exit -mkdir -p "${cartridge_rst_dest}" -find . -iregex '.*\.\(rst\|png\|puml\|svg\)$' -exec cp -r --parents {} "${cartridge_rst_dest}" \; - -# Copy translation templates -cartridge_pot_src="${cartridge_root}/build.luarocks/build.rst/locale" -cartridge_pot_dest="${project_root}/locale/book/cartridge" -cd "${cartridge_pot_src}" || exit -mkdir -p "${cartridge_pot_dest}" -find . -name '*.pot' -exec cp -rv --parents {} "${cartridge_pot_dest}" \; - -# Copy translations -cartridge_po_src="${cartridge_root}/build.luarocks/build.rst/locale/ru/LC_MESSAGES" -cartridge_po_dest="${po_dest}/book/cartridge" -cd "${cartridge_po_src}" || exit -mkdir -p "${cartridge_po_dest}" -find . -name '*.po' -exec cp -rv --parents {} "${cartridge_po_dest}" \; - - -# Cartridge CLI -cartridge_cli_root="${project_root}/modules/cartridge-cli/doc" -cartridge_cli_dest="${cartridge_rst_dest}/cartridge_cli" -cartridge_cli_po_dest="${po_dest}/book/cartridge/cartridge_cli" - -# Copy Cartridge CLI docs, including diagrams and images -mkdir -p "${cartridge_cli_dest}" -cd ${cartridge_cli_root} || exit -find . -iregex '.*\.\(rst\|png\|puml\|svg\)$' -exec cp -rv --parents {} "${cartridge_cli_dest}" \; - -# Copy translations -mkdir -p "${cartridge_cli_po_dest}" -cd "${cartridge_cli_root}/locale/ru/LC_MESSAGES/doc/" || exit -find . -name '*.po' -exec cp -rv --parents {} "${cartridge_cli_po_dest}" \; - # Monitoring monitoring_root="${project_root}/modules/metrics/doc/monitoring" monitoring_dest="${project_root}/doc/book" diff --git a/conf.py b/conf.py index 1457e80374..eb3c8c1a92 100644 --- a/conf.py +++ b/conf.py @@ -73,10 +73,6 @@ 'how-to/using_docker.rst', 'reference/configuration/cfg_*', 'images', - 'book/cartridge/cartridge_overview.rst', - 'book/cartridge/CONTRIBUTING.rst', - 'book/cartridge/topics', - 'book/cartridge/cartridge_api/modules/cartridge.test-helpers.rst', 'reference/reference_rock/luatest/README.rst', 'reference/reference_rock/luatest/modules/luatest.rst', '**/_includes/*' diff --git a/pull_submodules.py b/pull_submodules.py index 25c1dfce3e..79a9f27ac4 100755 --- a/pull_submodules.py +++ b/pull_submodules.py @@ -6,8 +6,6 @@ modules_dir = 'modules' modules = { - 'cartridge': 'INPUT_CARTRIDGE', - 'cartridge-cli': 'INPUT_CARTRIDGE_CLI', 'grafana-dashboard': 'INPUT_GRAFANA', 'luatest': 'INPUT_LUATEST', 'metrics': 'INPUT_METRICS', From 2ea63fbaf120a09d904bb22679e6bae7b7e46905 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Tue, 24 Oct 2023 13:01:38 +0700 Subject: [PATCH 2/4] Remove submodules Cartridge and cartridge CLI --- .gitmodules | 6 ------ modules/cartridge | 1 - modules/cartridge-cli | 1 - 3 files changed, 8 deletions(-) delete mode 160000 modules/cartridge delete mode 160000 modules/cartridge-cli diff --git a/.gitmodules b/.gitmodules index cd300b8328..3955ade5ce 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,9 +1,3 @@ -[submodule "modules/cartridge"] - path = modules/cartridge - url = https://github.com/tarantool/cartridge.git -[submodule "modules/cartridge-cli"] - path = modules/cartridge-cli - url = https://github.com/tarantool/cartridge-cli.git [submodule "modules/metrics"] path = modules/metrics url = https://github.com/tarantool/metrics.git diff --git a/modules/cartridge b/modules/cartridge deleted file mode 160000 index 766d24ba5e..0000000000 --- a/modules/cartridge +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 766d24ba5e3bc2d1b575362e7030ea485aac1faf diff --git a/modules/cartridge-cli b/modules/cartridge-cli deleted file mode 160000 index 0624cc0904..0000000000 --- a/modules/cartridge-cli +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 0624cc0904dfa92a4ec31ac2bf80358ea4218d23 From 1db436b9846084663b26fa08cc067f3bb485f845 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Tue, 24 Oct 2023 13:57:16 +0700 Subject: [PATCH 3/4] Remove links to Cartridge and cartridge CLI docs --- doc/book/admin/upgrades/upgrade_cluster.rst | 11 +++++------ doc/book/connectors/java.rst | 2 +- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/doc/book/admin/upgrades/upgrade_cluster.rst b/doc/book/admin/upgrades/upgrade_cluster.rst index 7444cfd63a..3185e60a6d 100644 --- a/doc/book/admin/upgrades/upgrade_cluster.rst +++ b/doc/book/admin/upgrades/upgrade_cluster.rst @@ -98,11 +98,11 @@ Upgrading storages Before upgrading **storage** instances: -* Disable :doc:`Cartridge failover `: run +* Disable Cartridge failover: run .. code-block:: bash - cartridge failover disable + tt cartridge failover disable or use the Cartridge web interface (**Cluster** tab, **Failover: ** button). @@ -112,8 +112,7 @@ Before upgrading **storage** instances: tarantool> vshard.storage.rebalancer_disable() -* Make sure that the Cartridge ``upgrade_schema`` :doc:`option ` - is ``false``. +* Make sure that the Cartridge ``upgrade_schema`` option is ``false``. .. include:: ../_includes/upgrade_storages.rst @@ -130,11 +129,11 @@ Before upgrading **storage** instances: Once you complete the steps, enable failover or rebalancer back: -* Enable :doc:`Cartridge failover `: run +* Enable Cartridge failover: run .. code-block:: bash - cartridge failover set [mode] + tt cartridge failover set [mode] or use the Cartridge web interface (**Cluster** tab, **Failover: Disabled** button). diff --git a/doc/book/connectors/java.rst b/doc/book/connectors/java.rst index 6cb53ee2f4..d13784fb31 100644 --- a/doc/book/connectors/java.rst +++ b/doc/book/connectors/java.rst @@ -8,7 +8,7 @@ There are two Java connectors available: * `cartridge-java `__ supports both single Tarantool nodes and clusters, as well as applications built using the - :doc:`Cartridge framework ` and its modules. + `Cartridge framework `__ and its modules. The Tarantool team actively updates this module with the newest Tarantool features. * `tarantool-java `__ works with early Tarantool versions (1.6 and later) From 702eca145d0c144e67162634242637f9e1c039ff Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Tue, 24 Oct 2023 15:26:52 +0700 Subject: [PATCH 4/4] Remove Cartridge products from contributing.rst --- doc/contributing/contributing.rst | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/doc/contributing/contributing.rst b/doc/contributing/contributing.rst index 5c9dd555d7..76840ff1df 100644 --- a/doc/contributing/contributing.rst +++ b/doc/contributing/contributing.rst @@ -132,8 +132,8 @@ There are several ways to improve the documentation: see how it works. This can be done automatically in Docker. To learn more, check the `README of the tarantool/doc repository `_. -Some projects, like `Tarantool Cartridge `_, -have their documentation in the code repository. +Some Tarantool projects have their documentation in the code repository. +This is typical for modules, for example, `metrics `_. This is done on purpose, so the developers themselves can update it faster. You can find instructions for building such documentation in the code repository. @@ -161,8 +161,6 @@ Here are some of our official modules: the persistent message queue. * `metrics `_: Ready-to-use solution for collecting metrics. -* `cartridge `_: Framework for writing - distributed applications. Official modules are provided in our organization on GitHub. @@ -311,11 +309,8 @@ help with application deployment, or allow working with Kubernetes. Here are some of the tools created by the Tarantool team: -* `ansible-cartridge `_: - an Ansible role to deploy Cartridge applications. -* `cartridge-cli `_: - a CLI utility for creating applications, launching clusters locally on Cartridge, - and solving operation problems. +* `tt `_: + a CLI utility for creating and managing Tarantool applications. * `tarantool-operator `_: a Kubernetes operator for cluster orchestration.