Skip to content

Commit 917bad7

Browse files
p7novandreyaksenov
authored andcommitted
Cartridge deprecation: remove Cartridge and Cartridge CLI modules (#3786)
Resolves #3546
1 parent 28f00ea commit 917bad7

File tree

9 files changed

+10
-74
lines changed

9 files changed

+10
-74
lines changed

.gitmodules

-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
[submodule "modules/cartridge"]
2-
path = modules/cartridge
3-
url = https://github.com/tarantool/cartridge.git
4-
[submodule "modules/cartridge-cli"]
5-
path = modules/cartridge-cli
6-
url = https://github.com/tarantool/cartridge-cli.git
71
[submodule "modules/metrics"]
82
path = modules/metrics
93
url = https://github.com/tarantool/metrics.git

build_submodules.sh

-44
Original file line numberDiff line numberDiff line change
@@ -12,50 +12,6 @@ po_dest="${project_root}/locale/ru/LC_MESSAGES"
1212
cp README.rst doc/contributing/docs/_includes/README.rst
1313

1414

15-
# Cartridge
16-
cartridge_root="${project_root}/modules/cartridge"
17-
18-
# Build Cartridge to extract docs
19-
cd "${cartridge_root}" || exit
20-
CMAKE_DUMMY_WEBUI=true tarantoolctl rocks make
21-
22-
# Copy Cartridge docs, including diagrams and images
23-
cartridge_rst_src="${cartridge_root}/build.luarocks/build.rst"
24-
cartridge_rst_dest="${project_root}/doc/book/cartridge"
25-
cd "${cartridge_rst_src}" || exit
26-
mkdir -p "${cartridge_rst_dest}"
27-
find . -iregex '.*\.\(rst\|png\|puml\|svg\)$' -exec cp -r --parents {} "${cartridge_rst_dest}" \;
28-
29-
# Copy translation templates
30-
cartridge_pot_src="${cartridge_root}/build.luarocks/build.rst/locale"
31-
cartridge_pot_dest="${project_root}/locale/book/cartridge"
32-
cd "${cartridge_pot_src}" || exit
33-
mkdir -p "${cartridge_pot_dest}"
34-
find . -name '*.pot' -exec cp -rv --parents {} "${cartridge_pot_dest}" \;
35-
36-
# Copy translations
37-
cartridge_po_src="${cartridge_root}/build.luarocks/build.rst/locale/ru/LC_MESSAGES"
38-
cartridge_po_dest="${po_dest}/book/cartridge"
39-
cd "${cartridge_po_src}" || exit
40-
mkdir -p "${cartridge_po_dest}"
41-
find . -name '*.po' -exec cp -rv --parents {} "${cartridge_po_dest}" \;
42-
43-
44-
# Cartridge CLI
45-
cartridge_cli_root="${project_root}/modules/cartridge-cli/doc"
46-
cartridge_cli_dest="${cartridge_rst_dest}/cartridge_cli"
47-
cartridge_cli_po_dest="${po_dest}/book/cartridge/cartridge_cli"
48-
49-
# Copy Cartridge CLI docs, including diagrams and images
50-
mkdir -p "${cartridge_cli_dest}"
51-
cd ${cartridge_cli_root} || exit
52-
find . -iregex '.*\.\(rst\|png\|puml\|svg\)$' -exec cp -rv --parents {} "${cartridge_cli_dest}" \;
53-
54-
# Copy translations
55-
mkdir -p "${cartridge_cli_po_dest}"
56-
cd "${cartridge_cli_root}/locale/ru/LC_MESSAGES/doc/" || exit
57-
find . -name '*.po' -exec cp -rv --parents {} "${cartridge_cli_po_dest}" \;
58-
5915
# Monitoring
6016
monitoring_root="${project_root}/modules/metrics/doc/monitoring"
6117
monitoring_dest="${project_root}/doc/book"

conf.py

-4
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,6 @@
7373
'how-to/using_docker.rst',
7474
'reference/configuration/cfg_*',
7575
'images',
76-
'book/cartridge/cartridge_overview.rst',
77-
'book/cartridge/CONTRIBUTING.rst',
78-
'book/cartridge/topics',
79-
'book/cartridge/cartridge_api/modules/cartridge.test-helpers.rst',
8076
'reference/reference_rock/luatest/README.rst',
8177
'reference/reference_rock/luatest/modules/luatest.rst',
8278
'**/_includes/*'

doc/book/admin/upgrades/upgrade_cluster.rst

+5-6
Original file line numberDiff line numberDiff line change
@@ -98,11 +98,11 @@ Upgrading storages
9898

9999
Before upgrading **storage** instances:
100100

101-
* Disable :doc:`Cartridge failover </book/cartridge/cartridge_cli/commands/failover/>`: run
101+
* Disable Cartridge failover: run
102102

103103
.. code-block:: bash
104104
105-
cartridge failover disable
105+
tt cartridge failover disable
106106
107107
or use the Cartridge web interface (**Cluster** tab, **Failover: <Mode>** button).
108108

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

118117
.. include:: ../_includes/upgrade_storages.rst
119118

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

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

133-
* Enable :doc:`Cartridge failover </book/cartridge/cartridge_cli/commands/failover/>`: run
132+
* Enable Cartridge failover: run
134133

135134
.. code-block:: bash
136135
137-
cartridge failover set [mode]
136+
tt cartridge failover set [mode]
138137
139138
or use the Cartridge web interface (**Cluster** tab, **Failover: Disabled** button).
140139

doc/book/connectors/java.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ There are two Java connectors available:
88
* `cartridge-java <http://github.com/tarantool/cartridge-java/>`__
99
supports both single Tarantool nodes and clusters,
1010
as well as applications built using the
11-
:doc:`Cartridge framework </book/cartridge/index>` and its modules.
11+
`Cartridge framework <https://github.com/tarantool/cartridge>`__ and its modules.
1212
The Tarantool team actively updates this module with the newest Tarantool features.
1313
* `tarantool-java <http://github.com/tarantool/tarantool-java/>`__
1414
works with early Tarantool versions (1.6 and later)

doc/contributing/contributing.rst

+4-9
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,8 @@ There are several ways to improve the documentation:
132132
see how it works. This can be done automatically in Docker.
133133
To learn more, check the `README of the tarantool/doc repository <https://github.com/tarantool/doc>`_.
134134

135-
Some projects, like `Tarantool Cartridge <https://github.com/tarantool/cartridge/>`_,
136-
have their documentation in the code repository.
135+
Some Tarantool projects have their documentation in the code repository.
136+
This is typical for modules, for example, `metrics <https://github.com/tarantool/metrics/>`_.
137137
This is done on purpose, so the developers themselves can update it faster.
138138
You can find instructions for building such documentation in the code repository.
139139

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

167165
Official modules are provided in our organization on GitHub.
168166

@@ -311,11 +309,8 @@ help with application deployment, or allow working with Kubernetes.
311309

312310
Here are some of the tools created by the Tarantool team:
313311

314-
* `ansible-cartridge <https://github.com/tarantool/ansible-cartridge>`_:
315-
an Ansible role to deploy Cartridge applications.
316-
* `cartridge-cli <https://github.com/tarantool/cartridge-cli>`_:
317-
a CLI utility for creating applications, launching clusters locally on Cartridge,
318-
and solving operation problems.
312+
* `tt <https://github.com/tarantool/tt>`_:
313+
a CLI utility for creating and managing Tarantool applications.
319314
* `tarantool-operator <https://github.com/tarantool/tarantool-operator>`_:
320315
a Kubernetes operator for cluster orchestration.
321316

modules/cartridge

-1
This file was deleted.

modules/cartridge-cli

-1
This file was deleted.

pull_submodules.py

-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
modules_dir = 'modules'
88
modules = {
9-
'cartridge': 'INPUT_CARTRIDGE',
10-
'cartridge-cli': 'INPUT_CARTRIDGE_CLI',
119
'grafana-dashboard': 'INPUT_GRAFANA',
1210
'luatest': 'INPUT_LUATEST',
1311
'metrics': 'INPUT_METRICS',

0 commit comments

Comments
 (0)