Skip to content

Commit

Permalink
Cartridge deprecation: remove Cartridge and Cartridge CLI modules (#3786
Browse files Browse the repository at this point in the history
)

Resolves #3546
  • Loading branch information
p7nov authored and andreyaksenov committed Nov 3, 2023
1 parent bc71e3b commit e160f44
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 74 deletions.
6 changes: 0 additions & 6 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -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
Expand Down
44 changes: 0 additions & 44 deletions build_submodules.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 0 additions & 4 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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/*'
Expand Down
11 changes: 5 additions & 6 deletions doc/book/admin/upgrades/upgrade_cluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,11 @@ Upgrading storages

Before upgrading **storage** instances:

* Disable :doc:`Cartridge failover </book/cartridge/cartridge_cli/commands/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: <Mode>** button).

Expand All @@ -112,8 +112,7 @@ Before upgrading **storage** instances:
tarantool> vshard.storage.rebalancer_disable()
* Make sure that the Cartridge ``upgrade_schema`` :doc:`option </book/cartridge/cartridge_api/modules/cartridge>`
is ``false``.
* Make sure that the Cartridge ``upgrade_schema`` option is ``false``.

.. include:: ../_includes/upgrade_storages.rst

Expand All @@ -130,11 +129,11 @@ Before upgrading **storage** instances:

Once you complete the steps, enable failover or rebalancer back:

* Enable :doc:`Cartridge failover </book/cartridge/cartridge_cli/commands/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).

Expand Down
2 changes: 1 addition & 1 deletion doc/book/connectors/java.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ There are two Java connectors available:
* `cartridge-java <http://github.com/tarantool/cartridge-java/>`__
supports both single Tarantool nodes and clusters,
as well as applications built using the
:doc:`Cartridge framework </book/cartridge/index>` and its modules.
`Cartridge framework <https://github.com/tarantool/cartridge>`__ and its modules.
The Tarantool team actively updates this module with the newest Tarantool features.
* `tarantool-java <http://github.com/tarantool/tarantool-java/>`__
works with early Tarantool versions (1.6 and later)
Expand Down
13 changes: 4 additions & 9 deletions doc/contributing/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/tarantool/doc>`_.

Some projects, like `Tarantool Cartridge <https://github.com/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 <https://github.com/tarantool/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.

Expand Down Expand Up @@ -161,8 +161,6 @@ Here are some of our official modules:
the persistent message queue.
* `metrics <https://github.com/tarantool/metrics>`_: Ready-to-use solution for
collecting metrics.
* `cartridge <https://github.com/tarantool/cartridge>`_: Framework for writing
distributed applications.

Official modules are provided in our organization on GitHub.

Expand Down Expand Up @@ -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 <https://github.com/tarantool/ansible-cartridge>`_:
an Ansible role to deploy Cartridge applications.
* `cartridge-cli <https://github.com/tarantool/cartridge-cli>`_:
a CLI utility for creating applications, launching clusters locally on Cartridge,
and solving operation problems.
* `tt <https://github.com/tarantool/tt>`_:
a CLI utility for creating and managing Tarantool applications.
* `tarantool-operator <https://github.com/tarantool/tarantool-operator>`_:
a Kubernetes operator for cluster orchestration.

Expand Down
1 change: 0 additions & 1 deletion modules/cartridge
Submodule cartridge deleted from 766d24
1 change: 0 additions & 1 deletion modules/cartridge-cli
Submodule cartridge-cli deleted from 0624cc
2 changes: 0 additions & 2 deletions pull_submodules.py
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down

0 comments on commit e160f44

Please sign in to comment.