diff --git a/.gitignore b/.gitignore index 006e72cd83..e6c272a827 100644 --- a/.gitignore +++ b/.gitignore @@ -78,4 +78,4 @@ locale/* /doc/how-to/getting_started_cxx.rst /doc/how-to/_includes -/doc/book/connectors/cxx/ +/doc/connectors/connectors/cxx/ diff --git a/doc/enterprise/flight_recorder.rst b/doc/book/admin/flight_recorder.rst similarity index 100% rename from doc/enterprise/flight_recorder.rst rename to doc/book/admin/flight_recorder.rst diff --git a/doc/book/admin/index.rst b/doc/book/admin/index.rst index 0396a88f28..bcc247f5c7 100644 --- a/doc/book/admin/index.rst +++ b/doc/book/admin/index.rst @@ -22,16 +22,12 @@ utilities: This chapter includes the following sections: .. toctree:: - :maxdepth: 2 - :numbered: 0 + :maxdepth: 1 - instance_config - start_stop_instance modules logs security access_control - vshard_admin replication/index server_introspection daemon_supervision @@ -41,4 +37,5 @@ This chapter includes the following sections: os_notes bug_reports troubleshoot + flight_recorder ../monitoring/index diff --git a/doc/book/admin/security.rst b/doc/book/admin/security.rst index f6141afe76..585e20e6e4 100644 --- a/doc/book/admin/security.rst +++ b/doc/book/admin/security.rst @@ -1,7 +1,7 @@ .. _admin-security: ================================================================================ -Security +Administrative console ================================================================================ Tarantool allows for two types of connections: diff --git a/doc/concepts/configuration/configuration_migrating.rst b/doc/concepts/configuration/configuration_migrating.rst deleted file mode 100644 index c557d741ae..0000000000 --- a/doc/concepts/configuration/configuration_migrating.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. _configuration_migrating_declarative: - -Migrating to declarative configuration -====================================== - -.. TODO - https://github.com/tarantool/doc/issues/3661 - 1) Configuration applying idempotence: how the config's 'target state' approach differs from the 'state changes' box.cfg() approach. - 2) How non-dynamic box.cfg() options are applied (no error, wait for restart). diff --git a/doc/concepts/data_model/index.rst b/doc/concepts/data_model/index.rst deleted file mode 100644 index 470bdfe35d..0000000000 --- a/doc/concepts/data_model/index.rst +++ /dev/null @@ -1,41 +0,0 @@ -.. _box_data_model: - -Data model -========== - -If you tried to create a database as suggested in our -:ref:`basic tutorial `, -then your test database now looks like this: - -.. image:: data_model.png - -Tarantool stores data in :ref:`spaces `, which can be thought of as tables in a relational database. -Every record or row in a space is called a :ref:`tuple `. -A tuple may have any number of fields, and the fields may be of different :ref:`types `. - -String data in fields are compared based on the specified :ref:`collation ` rules. -The user can provide hard limits for data values through :ref:`constraints ` -and link related spaces with :ref:`foreign keys `. - -Tarantool supports highly customizable :ref:`indexes ` of various types. -In particular, indexes can be defined with generators like :ref:`sequences `. - -There are six basic :ref:`data operations ` in Tarantool: -SELECT, INSERT, UPDATE, UPSERT, REPLACE, and DELETE. A number of :ref:`complexity factors ` -affects the resource usage of each function. - -Tarantool allows :ref:`describing the data schema ` but does not require it. -The user can :ref:`migrate a schema ` without migrating the data. - -To ensure :ref:`data persistence ` and recover quickly in case of failure, -Tarantool uses mechanisms like the write-ahead log (WAL) and snapshots. - -.. toctree:: - :maxdepth: 2 - - value_store - indexes - operations - schema_desc - persistence - migrations diff --git a/doc/concepts/data_model/persistence.rst b/doc/concepts/data_model/persistence.rst deleted file mode 100644 index dce7443f67..0000000000 --- a/doc/concepts/data_model/persistence.rst +++ /dev/null @@ -1,43 +0,0 @@ -.. _concepts-data_model-persistence: -.. _index-box_persistence: - -Persistence -=========== - -To ensure data persistence, Tarantool records updates to the database in the so-called -:ref:`write-ahead log (WAL) ` files. -When a power outage occurs or the Tarantool instance is killed incidentally, -the in-memory database is lost. -In such case, Tarantool restores the data from WAL files -by reading them and redoing the requests. -This is called the "recovery process". -You can change the timing of the WAL writer or turn it off by setting -the :ref:`wal.mode `. - -Tarantool also maintains a set of :ref:`snapshot files `. -These files contain an on-disk copy of the entire data set for a given moment. -Instead of reading every WAL file since the databases were created, the recovery -process can load the latest snapshot file and then read the WAL files, -produced after the snapshot file was made. -After creating a new snapshot, the earlier WAL files can be removed to free up space. - -To force immediate creation of a snapshot file, use the -:doc:`box.snapshot() ` function. -To enable the automatic creation of snapshot files, use Tarantool's -:ref:`checkpoint daemon `. -The checkpoint daemon sets intervals for forced snapshots. It makes sure that the states -of both memtx and vinyl storage engines are synchronized and saved to disk, -and automatically removes earlier WAL files. - -Snapshot files can be created even if there is no WAL file. - -.. NOTE:: - - The memtx engine takes only regular snapshots with the interval set in - the checkpoint daemon configuration. - - The vinyl engine runs checkpointing in the background at all times. - -See the :ref:`Internals ` section for more details -about the WAL writer and the recovery process. -To learn more about the configuration of the checkpoint daemon and WAL, check the :ref:`Persistence ` page. \ No newline at end of file diff --git a/doc/concepts/index.rst b/doc/concepts/index.rst deleted file mode 100644 index 46bcfe065a..0000000000 --- a/doc/concepts/index.rst +++ /dev/null @@ -1,122 +0,0 @@ -:fullwidth: - -.. _concepts: - -Concepts -======== - -Data model ----------- - -Tarantool is a NoSQL database. It stores data in :ref:`spaces `, -which can be thought of as tables in a relational database, and :ref:`tuples `, -which are analogous to rows. There are six basic :ref:`data operations ` in Tarantool. - -The platform allows :ref:`describing the data schema ` but does not require it. - -Tarantool supports highly customizable :ref:`indexes ` of various types. - -To ensure :ref:`data persistence ` and recover quickly in case of failure, -Tarantool uses mechanisms like the write-ahead log (WAL) and snapshots. - -For details, check the :ref:`Data model ` page. - -Fibers and cooperative multitasking ------------------------------------ - -Tarantool executes code in :ref:`fibers ` that are managed via -:ref:`cooperative multitasking `. -Learn more about Tarantool's :ref:`thread model `. - -For details, check the page :ref:`Fibers, yields, and cooperative multitasking `. - -Transactions ------------- - -Tarantool's ACID-compliant :ref:`transaction model ` lets the user choose -between two modes of transactions. - -The :ref:`default mode ` allows for fast monopolistic atomic transactions. -It doesn't support interactive transactions, and in case of an error, all transaction changes are rolled back. - -The :ref:`MVCC mode ` relies on a multi-version concurrency control engine -that allows yielding within a longer transaction. -This mode only works with the default in-memory :ref:`memtx ` storage engine. - -For details, check the :ref:`Transactions ` page. - -.. _concepts-application_server: - -Application server ------------------- - -Using Tarantool as an application server, you can write -applications in Lua, C, or C++. You can also create reusable :ref:`modules `. - -To increase the speed of code execution, Tarantool has a Lua Just-In-Time compiler (LuaJIT) on board. -LuaJIT compiles hot paths in the code -- paths that are used many times -- -thus making the application work faster. -To enable developers to work with LuaJIT, Tarantool provides tools like the :ref:`memory profiler ` -and the :ref:`getmetrics ` module. - -For details on Tarantool's modular structure, check the :ref:`Modules ` page. - -To learn how to use Tarantool as an application server, refer to the :ref:`guides ` in the How-to section. - -Sharding --------- - -Tarantool implements database sharding via the ``vshard`` module. -For details, go to the :ref:`Sharding ` page. - -Triggers --------- - -Tarantool allows specifying callback functions that run upon certain database events. -They can be useful for resolving replication conflicts. -For details, go to the :ref:`Triggers ` page. - -Replication ------------ - -Replication allows keeping the data in copies of the same database for better reliability. - -Several Tarantool instances can be organized in a replica set. -They communicate and transfer data via the :ref:`iproto ` binary protocol. -Learn more about Tarantool's :ref:`replication architecture `. - -By default, replication in Tarantool is asynchronous. -A transaction committed locally on the master node -may not get replicated onto other instances before the client receives a success response. -Thus, if the master reports success and then dies, the client might not see the result of the transaction. - -With :ref:`synchronous replication `, transactions on the master node are not considered committed -or successful before they are replicated onto a number of instances. This is slower, but more reliable. -Synchronous replication in Tarantool is based on an :ref:`implementation of the RAFT algorithm `. - -For details, check the :ref:`Replication ` section. - -Storage engines ---------------- - -A storage engine is a set of low-level routines that store and -retrieve values. Tarantool offers a choice of two storage engines: - -* :ref:`memtx ` is the in-memory storage engine used by default. -* :ref:`vinyl ` is the on-disk storage engine. - -For details, check the :ref:`Storage engines ` section. - - -.. toctree:: - :hidden: - - configuration - data_model/index - coop_multitasking - atomic - modules - sharding/index - replication/index - triggers - engines/index diff --git a/doc/book/connectors/c.rst b/doc/connectors/c.rst similarity index 100% rename from doc/book/connectors/c.rst rename to doc/connectors/c.rst diff --git a/doc/book/connectors/community.rst b/doc/connectors/community.rst similarity index 100% rename from doc/book/connectors/community.rst rename to doc/connectors/community.rst diff --git a/doc/book/connectors/csharp.rst b/doc/connectors/csharp.rst similarity index 100% rename from doc/book/connectors/csharp.rst rename to doc/connectors/csharp.rst diff --git a/doc/how-to/getting_started_go.rst b/doc/connectors/getting_started/getting_started_go.rst similarity index 100% rename from doc/how-to/getting_started_go.rst rename to doc/connectors/getting_started/getting_started_go.rst diff --git a/doc/how-to/getting_started_net_box.rst b/doc/connectors/getting_started/getting_started_net_box.rst similarity index 100% rename from doc/how-to/getting_started_net_box.rst rename to doc/connectors/getting_started/getting_started_net_box.rst diff --git a/doc/how-to/getting_started_php.rst b/doc/connectors/getting_started/getting_started_php.rst similarity index 100% rename from doc/how-to/getting_started_php.rst rename to doc/connectors/getting_started/getting_started_php.rst diff --git a/doc/how-to/getting_started_python.rst b/doc/connectors/getting_started/getting_started_python.rst similarity index 100% rename from doc/how-to/getting_started_python.rst rename to doc/connectors/getting_started/getting_started_python.rst diff --git a/doc/how-to/getting_started_connectors.rst b/doc/connectors/getting_started_connectors.rst similarity index 79% rename from doc/how-to/getting_started_connectors.rst rename to doc/connectors/getting_started_connectors.rst index 5609575267..221c2c33b2 100644 --- a/doc/how-to/getting_started_connectors.rst +++ b/doc/connectors/getting_started_connectors.rst @@ -15,7 +15,7 @@ and so on). :maxdepth: 2 :numbered: 0 - getting_started_python - getting_started_php - getting_started_go - getting_started_cxx + getting_started/getting_started_python + getting_started/getting_started_php + getting_started/getting_started_go + getting_started/getting_started_cxx diff --git a/doc/book/connectors/go.rst b/doc/connectors/go.rst similarity index 100% rename from doc/book/connectors/go.rst rename to doc/connectors/go.rst diff --git a/doc/book/connectors.rst b/doc/connectors/index.rst similarity index 98% rename from doc/book/connectors.rst rename to doc/connectors/index.rst index c17bd6fb83..20f0160e41 100644 --- a/doc/book/connectors.rst +++ b/doc/connectors/index.rst @@ -17,11 +17,12 @@ This chapter documents APIs for various programming languages: .. toctree:: :maxdepth: 1 - connectors/c - connectors/go - connectors/java - connectors/python - connectors/community + c + go + java + python + getting_started_connectors + community Protocol -------- diff --git a/doc/book/connectors/java.rst b/doc/connectors/java.rst similarity index 100% rename from doc/book/connectors/java.rst rename to doc/connectors/java.rst diff --git a/doc/book/connectors/nodejs.rst b/doc/connectors/nodejs.rst similarity index 100% rename from doc/book/connectors/nodejs.rst rename to doc/connectors/nodejs.rst diff --git a/doc/book/connectors/perl.rst b/doc/connectors/perl.rst similarity index 100% rename from doc/book/connectors/perl.rst rename to doc/connectors/perl.rst diff --git a/doc/book/connectors/php.rst b/doc/connectors/php.rst similarity index 100% rename from doc/book/connectors/php.rst rename to doc/connectors/php.rst diff --git a/doc/book/connectors/python.rst b/doc/connectors/python.rst similarity index 100% rename from doc/book/connectors/python.rst rename to doc/connectors/python.rst diff --git a/doc/enterprise/deprecated.rst b/doc/enterprise/deprecated.rst deleted file mode 100644 index 248a0fd3cc..0000000000 --- a/doc/enterprise/deprecated.rst +++ /dev/null @@ -1,88 +0,0 @@ -.. _enterprise_deprecated_features: - -Deprecated features -=================== - -The ZooKeeper along with ``orchestrator`` are no longer supported. However, they -still can be used, if necessary. - -The following sections describe the corresponding functionality. - -.. _manage-sharding-api: - -Controlling the cluster via API -------------------------------- - -To control the cluster, use the ``orchestrator`` included in the delivery package. -The ``orchestrator`` uses ZooKeeper to store and distribute the configuration. -The ``orchestrator`` provides the REST API for controlling the cluster. -Configurations in the ZooKeeper are changed as a result of calling the ``orchestrator``'s -API-functions, which in turn leads to changes in configurations of the Tarantool -nodes. - -We recommend using a **curl** command line interface to call the API-functions -of the ``orchestrator``. - -The following example shows how to register a new availability zone (DC): - -.. code-block:: kconfig - - $ curl -X POST http://HOST:PORT/api/v1/zone \ - -d '{ - "name": "Caucasian Boulevard" - }' - -To check whether the DC registration was successful, try the following instruction. -It retrieves the list of all registered nodes in the JSON format: - -.. code-block:: console - - $ curl http://HOST:PORT/api/v1/zone| python -m json.tool - -To apply the new configuration directly on the Tarantool nodes, increase the -configuration version number after calling the API function. To do this, use the -POST request to ``/api/v1/version``: - -.. code-block:: console - - $ curl -X POST http://HOST:PORT/api/v1/version - -Altogether, to update the cluster configuration: - -1. Call the ``POST/PUT`` method of the ``orchestrator``. - As a result, the ZooKeeper nodes are updated, and a subsequent update of the - Tarantool nodes is initiated. -2. Update the configuration version using the ``POST`` request to ``/api/v1/version``. - As a result, the configuration is applied to the Tarantool nodes. - -See the :ref:`Orchestrator API reference ` for the detailed orchestrator API. - -.. _geo-redundancy-setup: - -Setting up geo redundancy -------------------------- - -Logically, cluster nodes can belong to some availability zone. Physically, an -availability zone is a separate DC, or a rack inside a DC. You can specify a matrix -of weights (distances) for the availability zones. - -New zones are added by calling a corresponding API method of the orchestrator. - -By default, the matrix of weights (distances) for the zones is not configured, -and geo-redundancy for such configurations works as follows: - -* Data is always written to the master. -* If the master is available, then it is used for reading. -* If the master is unavailable, then any available replica is used for reading. - -When you define a matrix of weights (distances) by calling ``/api/v1/zones/weights``, -the automatic scale-out system of the Tarantool DBMS finds a replica which is the -closest to the specified router in terms of weights, and starts using this replica -for reading. If this replica is not available, then the next nearest replica is -selected, taking into account the distances specified in the configuration. - - -.. toctree:: - :hidden: - - deprecated/orchestrator_api diff --git a/doc/enterprise/deprecated/orchestrator_api.rst b/doc/enterprise/deprecated/orchestrator_api.rst deleted file mode 100644 index 78d34c3c6d..0000000000 --- a/doc/enterprise/deprecated/orchestrator_api.rst +++ /dev/null @@ -1,954 +0,0 @@ -.. _enterprise_orchestrator_api: - -Orchestrator API reference -========================== - -.. _orchestrator-configure-zones: - -Configuring the zones ---------------------- - -* :ref:`POST /api/v1/zone ` -* :ref:`GET /api/v1/zone/ ` -* :ref:`PUT /api/v1/zone/ ` -* :ref:`DELETE /api/v1/zone/ ` - -.. _orchestrator_api-post_zone: - -.. function:: POST /api/v1/zone - - Create a new zone. - - **Request** - - .. code-block:: kconfig - - { - "name": "zone 1" - } - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": { - "id": 2, - "name": "zone 2" - }, - "status": true - } - - **Potential errors** - - * ``zone_exists`` - the specified zone already exists - -.. _orchestrator_api-get_zone: - -.. function:: GET /api/v1/zone/{zone_id: optional} - - Return information on the specified zone or on all the zones. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": [ - { - "id": 1, - "name": "zone 11" - }, - { - "id": 2, - "name": "zone 2" - } - ], - "status": true - } - - **Potential errors** - - * ``zone_not_found`` - the specified zone is not found - -.. _orchestrator_api-put_zone: - -.. function:: PUT /api/v1/zone/{zone_id} - - Update information on the zone. - - **Body** - - .. code-block:: kconfig - - { - "name": "zone 22" - } - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": {}, - "status": true - } - - **Potential errors** - - * ``zone_not_found`` - the specified zone is not found - -.. _orchestrator_api-delete_zone: - -.. function:: DELETE /api/v1/zone/{zone_id} - - Delete a zone if it doesn’t store any nodes. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": {}, - "status": true - } - - **Potential errors** - - * ``zone_not_found`` - the specified zone is not found - * ``zone_in_use`` - the specified zone stores at least one node - -.. _orchestrator-configure-zone-weights: - -Configuring the zone weights ----------------------------- - -* :ref:`GET /api/v1/zones/weights ` -* :ref:`POST /api/v1/zones/weights ` - -.. _orchestrator_api-post_weights: - -.. function:: POST /api/v1/zones/weights - - Set the zone weights configuration. - - **Body** - - .. code-block:: kconfig - - { - "weights": { - "1": { - "2": 10, - "3": 11 - }, - "2": { - "1": 10, - "3": 12 - }, - "3": { - "1": 11, - "2": 12 - } - } - } - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": {}, - "status": true - } - - **Potential errors** - - * ``zones_weights_error`` - configuration error - -.. _orchestrator_api-get_weights: - -.. function:: GET /api/v1/zones/weights - - Return the zone weights configuration. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": { - "1": { - "2": 10, - "3": 11 - }, - "2": { - "1": 10, - "3": 12 - }, - "3": { - "1": 11, - "2": 12 - } - }, - "status": true - } - - **Potential errors** - - * ``zone_not_found`` - the specified zone is not found - -.. _orchestrator-configure-registry: - -Configuring registry --------------------- - -* :ref:`GET /api/v1/registry/nodes/new ` -* :ref:`POST /api/v1/registry/node ` -* :ref:`PUT /api/v1/registry/node/ ` -* :ref:`GET /api/v1/registry/node/ ` -* :ref:`DELETE /api/v1/registry/node/ ` - -.. _orchestrator_api-get_new: - -.. function:: GET /api/v1/registry/nodes/new - - Return all the detected nodes. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": [ - { - "uuid": "uuid-2", - "hostname": "tnt2.public.i", - "name": "tnt2" - } - ], - "status": true - } - -.. _orchestrator_api-post_registry_node: - -.. function:: POST /api/v1/registry/node - - Register the detected node. - - **Body** - - .. code-block:: kconfig - - { - "zone_id": 1, - "uuid": "uuid-2", - "uri": "tnt2.public.i:3301", - "user": "user1:pass1", - "repl_user": "repl_user1:repl_pass1", - "cfg": { - "listen": "0.0.0.0:3301" - } - } - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": {}, - "status": true - } - - **Potential errors** - - * ``node_already_registered`` - the specified node is already registered - * ``zone_not_found`` - the specified zone is not found - * ``node_not_discovered`` - the specified node is not detected - -.. _orchestrator_api-put_node: - -.. function:: PUT /api/v1/registry/node/{node_uuid} - - Update the registered node parameters. - - **Body** - - Pass only those parameters that need to be updated. - - .. code-block:: kconfig - - { - "zone_id": 1, - "repl_user": "repl_user2:repl_pass2", - "cfg": { - "listen": "0.0.0.0:3301", - "memtx_memory": 100000 - } - } - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": {}, - "status": true - } - - **Potential errors** - - * ``node_not_registered`` - the specified node is not registered - -.. _orchestrator_api-get_node: - -.. function:: GET /api/v1/registry/node/{node_uuid: optional} - - Return information on the nodes in a cluster. If ``node_uuid`` is passed, - information on this node only is returned. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": { - "uuid-1": { - "user": "user1:pass1", - "hostname": "tnt1.public.i", - "repl_user": "repl_user2:repl_pass2", - "uri": "tnt1.public.i:3301", - "zone_id": 1, - "name": "tnt1", - "cfg": { - "listen": "0.0.0.0:3301", - "memtx_memory": 100000 - }, - "zone": 1 - }, - "uuid-2": { - "user": "user1:pass1", - "hostname": "tnt2.public.i", - "name": "tnt2", - "uri": "tnt2.public.i:3301", - "repl_user": "repl_user1:repl_pass1", - "cfg": { - "listen": "0.0.0.0:3301" - }, - "zone": 1 - } - }, - "status": true - } - - **Potential errors** - - * ``node_not_registered`` - the specified node is not registered - -.. _orchestrator_api-delete_node: - -.. function:: DELETE /api/v1/registry/node/{node_uuid} - - Delete the node if it doesn’t belong to any replica set. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": {}, - "status": true - } - - **Potential errors** - - * ``node_not_registered`` - the specified node is not registered - * ``node_in_use`` - the specified node is in use by a replica set - -.. _orchestrator-router-api: - -Routers API ------------ - -* :ref:`GET /api/v1/routers ` -* :ref:`POST /api/v1/routers ` -* :ref:`DELETE /api/v1/routers/{uuid} ` - -.. _orchestrator_api-get_routers: - -.. function:: GET /api/v1/routers - - Return the list of all nodes that constitute the router. - - **Response** - - .. code-block:: kconfig - - { - "data": [ - "uuid-1" - ], - "status": true, - "error": { - "code": 0, - "message": "ok" - } - } - -.. _orchestrator_api-post_routers: - -.. function:: POST /api/v1/routers - - Assign the router role to the node. - - **Body** - - .. code-block:: kconfig - - { - "uuid": "uuid-1" - } - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": {}, - "status": true - } - - **Potential errors** - - * ``node_not_registered`` - the specified node is not registered - -.. _orchestrator_api-delete_routers: - -.. function:: DELETE /api/v1/routers/{uuid} - - Release the router role from the node. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": {}, - "status": true - } - -.. _orchestrator_api-replica_set_cfg: - -Configuring replica sets ------------------------- - -* :ref:`POST /api/v1/replicaset ` -* :ref:`PUT /api/v1/replicaset/ ` -* :ref:`GET /api/v1/replicaset/ ` -* :ref:`DELETE /api/v1/replicaset/ ` -* :ref:`POST /api/v1/replicaset/{replicaset_uuid}/master ` -* :ref:`POST /api/v1/replicaset/{replicaset_uuid}/node ` -* :ref:`DELETE /api/v1/zone/ ` - -.. _orchestrator_api-post_replicaset: - -.. function:: POST /api/v1/replicaset - - Create a replica set containing all the registered nodes. - - **Body** - - .. code-block:: kconfig - - { - "uuid": "optional-uuid", - "replicaset": [ - { - "uuid": "uuid-1", - "master": true - } - ] - } - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": { - "replicaset_uuid": "cc6568a2-63ca-413d-8e39-704b20adb7ae" - }, - "status": true - } - - **Potential errors** - - * ``replicaset_exists`` – the specified replica set already exists - * ``replicaset_empty`` – the specified replica set doesn’t contain any nodes - * ``node_not_registered`` – the specified node is not registered - * ``node_in_use`` – the specified node is in use by another replica set - -.. _orchestrator_api-put_replicaset: - -.. function:: PUT /api/v1/replicaset/{replicaset_uuid} - - Update the replica set parameters. - - **Body** - - .. code-block:: kconfig - - { - "replicaset": [ - { - "uuid": "uuid-1", - "master": true - }, - { - "uuid": "uuid-2", - "master": false, - "off": true - } - ] - } - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": {}, - "status": true - } - - **Potential errors** - - * ``replicaset_empty`` – the specified replica set doesn’t contain any nodes - * ``replicaset_not_found`` – the specified replica set is not found - * ``node_not_registered`` – the specified node is not registered - * ``node_in_use`` – the specified node is in use by another replica set - -.. _orchestrator_api-get_replicaset: - -.. function:: GET /api/v1/replicaset/{replicaset_uuid: optional} - - Return information on all the cluster components. If ``replicaset_uuid`` is - passed, information on this replica set only is returned. - - **Body** - - .. code-block:: kconfig - - { - "name": "zone 22" - } - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": { - "cc6568a2-63ca-413d-8e39-704b20adb7ae": { - "uuid-1": { - "hostname": "tnt1.public.i", - "off": false, - "repl_user": "repl_user2:repl_pass2", - "uri": "tnt1.public.i:3301", - "master": true, - "name": "tnt1", - "user": "user1:pass1", - "zone_id": 1, - "zone": 1 - }, - "uuid-2": { - "hostname": "tnt2.public.i", - "off": true, - "repl_user": "repl_user1:repl_pass1", - "uri": "tnt2.public.i:3301", - "master": false, - "name": "tnt2", - "user": "user1:pass1", - "zone": 1 - } - } - }, - "status": true - } - - **Potential errors** - - * ``replicaset_not_found`` – the specified replica set is not found - -.. _orchestrator_api-delete_replicaset: - -.. function:: DELETE /api/v1/replicaset/{replicaset_uuid} - - Delete a replica set. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": {}, - "status": true - } - - **Potential errors** - - * ``replicaset_not_found`` - the specified replica set is not found - -.. _orchestrator_api-post_master: - -.. function:: POST /api/v1/replicaset/{replicaset_uuid}/master - - Switch the master in the replica set. - - **Body** - - .. code-block:: kconfig - - { - "instance_uuid": "uuid-1", - "hostname_name": "hostname:instance_name" - } - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": {}, - "status": true - } - - **Potential errors** - - * ``replicaset_not_found`` – the specified replica set is not found - * ``node_not_registered`` – the specified node is not registered - * ``node_not_in_replicaset`` – the specified node is not in the specified replica set - -.. _orchestrator_api-post_replicaset_node: - -.. function:: POST /api/v1/replicaset/{replicaset_uuid}/node - - Add a node to the replica set. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": {}, - "status": true - } - - **Body** - - .. code-block:: kconfig - - { - "instance_uuid": "uuid-1", - "hostname_name": "hostname:instance_name", - "master": false, - "off": false - } - - **Potential errors** - -* ``replicaset_not_found`` – the specified replica set is not found -* ``node_not_registered`` – the specified node is not registered -* ``node_in_use`` – the specified node is in use by another replica set - -.. _orchestrator_api-get_status: - -.. function:: GET /api/v1/replicaset/status - - Return statistics on the cluster. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "data": { - "cluster": { - "routers": [ - { - "zone": 1, - "name": "tnt1", - "repl_user": "repl_user1:repl_pass1", - "hostname": "tnt1.public.i", - "status": null, - "uri": "tnt1.public.i:3301", - "user": "user1:pass1", - "uuid": "uuid-1", - "total_rps": null - } - ], - "storages": [ - { - "hostname": "tnt1.public.i", - "repl_user": "repl_user2:repl_pass2", - "uri": "tnt1.public.i:3301", - "name": "tnt1", - "total_rps": null, - "status": 'online', - "replicas": [ - { - "user": "user1:pass1", - "hostname": "tnt2.public.i", - "replication_info": null, - "repl_user": "repl_user1:repl_pass1", - "uri": "tnt2.public.i:3301", - "uuid": "uuid-2", - "status": 'online', - "name": "tnt2", - "total_rps": null, - "zone": 1 - } - ], - "user": "user1:pass1", - "zone_id": 1, - "uuid": "uuid-1", - "replicaset_uuid": "cc6568a2-63ca-413d-8e39-704b20adb7ae", - "zone": 1 - } - ] - } - }, - "status": true - } - - **Potential errors** - - * ``zone_not_found`` - the specified zone is not found - * ``zone_in_use`` - the specified zone stores at least one node - -.. _orchestrator-setup-config-versions: - -Setting up configuration versions ---------------------------------- - -* :ref:`POST /api/v1/version ` -* :ref:`GET /api/v1/version ` - -.. _orchestrator_api-post_version: - -.. function:: POST /api/v1/version - - Set the configuration version. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "status": true, - "data": { - "version": 2 - } - } - - **Potential errors** - - * ``cfg_error`` - configuration error - -.. _orchestrator_api-get_version: - -.. function:: GET /api/v1/version - - Return the configuration version. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "status": true, - "data": { - "version": 2 - } - } - -.. _orchestrator-config-shards: - -Configuring sharding --------------------- - -* :ref:`POST /api/v1/sharding/cfg ` -* :ref:`GET /api/v1/sharding/cfg ` - -.. _orchestrator_api-post_cfg: - -.. function:: POST /api/v1/sharding/cfg - - Add a new sharding configuration. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "status": true, - "data": {} - } - -.. _orchestrator_api-get_cfg: - -.. function:: GET /api/v1/sharding/cfg - - Return the current sharding configuration. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "status": true, - "data": {} - } - -.. _orchestrator-reset-cluster-config: - -Resetting cluster configuration -------------------------------- - -* :ref:`POST /api/v1/clean/cfg ` -* :ref:`POST /api/v1/clean/all ` - -.. _orchestrator_api-post_clean_cfg: - -.. function:: POST /api/v1/clean/cfg - - Reset the cluster configuration. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "status": true, - "data": {} - } - -.. _orchestrator_api-post_clean_all: - -.. function:: POST /api/v1/clean/all - - Reset the cluster configuration and delete information on the cluster nodes - from the ZooKeeper catalogues. - - **Response** - - .. code-block:: kconfig - - { - "error": { - "code": 0, - "message": "ok" - }, - "status": true, - "data": {} - } diff --git a/doc/enterprise/images/ddl-state.png b/doc/enterprise/images/ddl-state.png deleted file mode 100644 index d9714238a4..0000000000 Binary files a/doc/enterprise/images/ddl-state.png and /dev/null differ diff --git a/doc/enterprise/images/hidden_spaces.png b/doc/enterprise/images/hidden_spaces.png deleted file mode 100644 index 587244358a..0000000000 Binary files a/doc/enterprise/images/hidden_spaces.png and /dev/null differ diff --git a/doc/enterprise/images/space_contents.png b/doc/enterprise/images/space_contents.png deleted file mode 100644 index b086377f26..0000000000 Binary files a/doc/enterprise/images/space_contents.png and /dev/null differ diff --git a/doc/enterprise/images/space_explr_tab.png b/doc/enterprise/images/space_explr_tab.png deleted file mode 100644 index dadcf14200..0000000000 Binary files a/doc/enterprise/images/space_explr_tab.png and /dev/null differ diff --git a/doc/enterprise/images/space_search.png b/doc/enterprise/images/space_search.png deleted file mode 100644 index a6c719572b..0000000000 Binary files a/doc/enterprise/images/space_search.png and /dev/null differ diff --git a/doc/enterprise/images/spaces_with_data.png b/doc/enterprise/images/spaces_with_data.png deleted file mode 100644 index 22f836070c..0000000000 Binary files a/doc/enterprise/images/spaces_with_data.png and /dev/null differ diff --git a/doc/enterprise/index.rst b/doc/enterprise/index.rst index de86e1f809..bd883f914c 100644 --- a/doc/enterprise/index.rst +++ b/doc/enterprise/index.rst @@ -63,15 +63,4 @@ Tarantool Enterprise Edition .. toctree:: :hidden: - setup - security - audit - tuple_compression - wal_extensions - read_views - flight_recorder - audit_log space_upgrade - system_metrics - deprecated - rocksref diff --git a/doc/how-to/getting_started_db.rst b/doc/getting_started/getting_started_db.rst similarity index 100% rename from doc/how-to/getting_started_db.rst rename to doc/getting_started/getting_started_db.rst diff --git a/doc/how-to/getting_started_tcm.rst b/doc/getting_started/getting_started_tcm.rst similarity index 100% rename from doc/how-to/getting_started_tcm.rst rename to doc/getting_started/getting_started_tcm.rst diff --git a/doc/getting_started/index.rst b/doc/getting_started/index.rst index ca4215227a..8d675b57b6 100644 --- a/doc/getting_started/index.rst +++ b/doc/getting_started/index.rst @@ -15,3 +15,11 @@ You'll get an understanding of the technology and learn about the basic terms an To continue exploring Tarantool and its ecosystem, you might want to check out Tarantool :doc:`tutorials and guides <../how-to/index>`. + +.. toctree:: + :maxdepth: 1 + + installation + getting_started_db + vshard_quick + getting_started_tcm diff --git a/doc/enterprise/setup.rst b/doc/getting_started/installation.rst similarity index 83% rename from doc/enterprise/setup.rst rename to doc/getting_started/installation.rst index e31dbae202..ba9d1fc7b8 100644 --- a/doc/enterprise/setup.rst +++ b/doc/getting_started/installation.rst @@ -1,26 +1,29 @@ -.. _enterprise-setup: +.. _tarantool_installation: -=============================================================================== -Setup -=============================================================================== +Installing Tarantool +==================== -This chapter explains how to download and set up Tarantool Enterprise Edition and run +This section explains how to download and set up Tarantool Enterprise Edition and run a sample application provided with it. +To learn how to download and install Tarantool Community Edition, see the `Download `_ page. + +.. NOTE:: + + For developers: :ref:`tt-install`. + .. _enterprise-prereqs: -------------------------------------------------------------------------------- System requirements -------------------------------------------------------------------------------- +------------------- The recommended system requirements for running Tarantool Enterprise are as follows. .. _enterprise-prereqs-hardware: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Hardware requirements -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~ To fully ensure the fault tolerance of a distributed data storage system, at least **three** physical computers or virtual servers are required. @@ -30,9 +33,8 @@ of servers; however, it is not recommended to use such configurations for produc .. _enterprise-prereqs-software: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Software requirements -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~ #. As host operating systems, Tarantool Enterprise Edition supports **Red Hat Enterprise Linux** and **CentOS** versions 7.5 and higher. @@ -53,9 +55,8 @@ Software requirements .. _enterprise-prereqs-network: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Network requirements -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~ Hereinafter, **"storage servers"** or **"Tarantool servers"** are the computers used to store and process data, and **"administration server"** is the computer @@ -109,9 +110,8 @@ section of the RHEL7 user documentation. .. _enterprise-package-contents: -------------------------------------------------------------------------------- Package contents -------------------------------------------------------------------------------- +---------------- The latest release packages of Tarantool Enterprise are available in the `customer zone `_ @@ -164,9 +164,8 @@ Archive contents: .. _archive-unpack: .. _enterprise-install: -------------------------------------------------------------------------------- Installation -------------------------------------------------------------------------------- +------------ The delivered ``tar + gzip`` archive should be uploaded to a server and unpacked: diff --git a/doc/how-to/vshard_quick.rst b/doc/getting_started/vshard_quick.rst similarity index 100% rename from doc/how-to/vshard_quick.rst rename to doc/getting_started/vshard_quick.rst diff --git a/doc/how-to/db/index.rst b/doc/how-to/db/index.rst deleted file mode 100644 index 184a2cf2a1..0000000000 --- a/doc/how-to/db/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -Defining and manipulating data -============================== - -This section contains guides on performing data operations in Tarantool. - -.. toctree:: - :maxdepth: 1 - - crud - indexes - sequences diff --git a/doc/how-to/index.rst b/doc/how-to/index.rst deleted file mode 100644 index 43a76fa933..0000000000 --- a/doc/how-to/index.rst +++ /dev/null @@ -1,28 +0,0 @@ -:noindex: -:fullwidth: - -.. _tutorials: -.. _how-to: - -How-to guides -============= - -This chapter contains practical examples as well as -tutorials for those who would like to dig deeper into Tarantool usage. - -If you are new to Tarantool, please see our -:ref:`Getting Started guides ` first. - -.. toctree:: - :maxdepth: 2 - - Creating Tarantool database - db/index - replication/index - vshard_quick - getting_started_tcm - getting_started_net_box - getting_started_connectors - app/index - sql/index - other/index diff --git a/doc/how-to/other/index.rst b/doc/how-to/other/index.rst deleted file mode 100644 index 6e597e4256..0000000000 --- a/doc/how-to/other/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -More guides -=========== - -.. toctree:: - :maxdepth: 1 - - iproto - libslave \ No newline at end of file diff --git a/doc/reference/index.rst b/doc/reference/index.rst index ae8a1cfce6..34c6ef2178 100644 --- a/doc/reference/index.rst +++ b/doc/reference/index.rst @@ -12,11 +12,10 @@ Reference configuration/configuration_reference configuration/index - tooling/index - reference_sql/index + CRUD operations reference_lua/index reference_rock/index + reference_sql/index ../dev_guide/reference_capi/index ../dev_guide/internals/index ../book/box/limitations - lua_tips diff --git a/doc/reference/reference_lua/index.rst b/doc/reference/reference_lua/index.rst index 2002f75e4f..1a4a8cb054 100644 --- a/doc/reference/reference_lua/index.rst +++ b/doc/reference/reference_lua/index.rst @@ -2,7 +2,7 @@ :fullwidth: ================================================================================ -Built-in modules reference +Built-in modules Lua API reference ================================================================================ .. _built_in_modules: diff --git a/doc/reference/reference_rock/index.rst b/doc/reference/reference_rock/index.rst index 3e19e710b3..364872600e 100644 --- a/doc/reference/reference_rock/index.rst +++ b/doc/reference/reference_rock/index.rst @@ -1,8 +1,8 @@ :noindex: :fullwidth: -Rocks reference -=============== +Third-party modules Lua API reference +===================================== This reference covers third-party Lua modules for Tarantool. diff --git a/doc/concepts/configuration.rst b/doc/tarantool_cluster/cluster_configuration/configuration.rst similarity index 98% rename from doc/concepts/configuration.rst rename to doc/tarantool_cluster/cluster_configuration/configuration.rst index a895e31e32..d7503638a5 100644 --- a/doc/concepts/configuration.rst +++ b/doc/tarantool_cluster/cluster_configuration/configuration.rst @@ -483,11 +483,5 @@ If the same option is defined in two or more locations, the option with the high .. toctree:: :hidden: - configuration/configuration_etcd - configuration/configuration_code - configuration/configuration_memtx - configuration/configuration_persistence - configuration/configuration_connections - configuration/configuration_credentials - configuration/configuration_authentication - .. configuration/configuration_migrating + configuration_etcd + configuration_code diff --git a/doc/concepts/configuration/configuration_code.rst b/doc/tarantool_cluster/cluster_configuration/configuration_code.rst similarity index 100% rename from doc/concepts/configuration/configuration_code.rst rename to doc/tarantool_cluster/cluster_configuration/configuration_code.rst diff --git a/doc/concepts/configuration/configuration_etcd.rst b/doc/tarantool_cluster/cluster_configuration/configuration_etcd.rst similarity index 100% rename from doc/concepts/configuration/configuration_etcd.rst rename to doc/tarantool_cluster/cluster_configuration/configuration_etcd.rst diff --git a/doc/concepts/configuration/tarantool_config_centralized.png b/doc/tarantool_cluster/cluster_configuration/tarantool_config_centralized.png similarity index 100% rename from doc/concepts/configuration/tarantool_config_centralized.png rename to doc/tarantool_cluster/cluster_configuration/tarantool_config_centralized.png diff --git a/doc/concepts/configuration/tarantool_config_centralized_tcm.png b/doc/tarantool_cluster/cluster_configuration/tarantool_config_centralized_tcm.png similarity index 100% rename from doc/concepts/configuration/tarantool_config_centralized_tcm.png rename to doc/tarantool_cluster/cluster_configuration/tarantool_config_centralized_tcm.png diff --git a/doc/concepts/configuration/tarantool_config_local.png b/doc/tarantool_cluster/cluster_configuration/tarantool_config_local.png similarity index 100% rename from doc/concepts/configuration/tarantool_config_local.png rename to doc/tarantool_cluster/cluster_configuration/tarantool_config_local.png diff --git a/doc/concepts/configuration/configuration_authentication.rst b/doc/tarantool_cluster/connections_and_auth/configuration_authentication.rst similarity index 100% rename from doc/concepts/configuration/configuration_authentication.rst rename to doc/tarantool_cluster/connections_and_auth/configuration_authentication.rst diff --git a/doc/concepts/configuration/configuration_connections.rst b/doc/tarantool_cluster/connections_and_auth/configuration_connections.rst similarity index 100% rename from doc/concepts/configuration/configuration_connections.rst rename to doc/tarantool_cluster/connections_and_auth/configuration_connections.rst diff --git a/doc/concepts/configuration/configuration_credentials.rst b/doc/tarantool_cluster/connections_and_auth/configuration_credentials.rst similarity index 100% rename from doc/concepts/configuration/configuration_credentials.rst rename to doc/tarantool_cluster/connections_and_auth/configuration_credentials.rst diff --git a/doc/tarantool_cluster/connections_and_auth/index.rst b/doc/tarantool_cluster/connections_and_auth/index.rst new file mode 100644 index 0000000000..bc2b828d3e --- /dev/null +++ b/doc/tarantool_cluster/connections_and_auth/index.rst @@ -0,0 +1,11 @@ +.. _connections_and_authentication: + +Connections and authentication +============================== + +.. toctree:: + :maxdepth: 1 + + configuration_connections + configuration_credentials + configuration_authentication diff --git a/doc/concepts/configuration/configuration_memtx.rst b/doc/tarantool_cluster/data_storage/configuration_memtx.rst similarity index 100% rename from doc/concepts/configuration/configuration_memtx.rst rename to doc/tarantool_cluster/data_storage/configuration_memtx.rst diff --git a/doc/concepts/engines/index.rst b/doc/tarantool_cluster/data_storage/engines/index.rst similarity index 100% rename from doc/concepts/engines/index.rst rename to doc/tarantool_cluster/data_storage/engines/index.rst diff --git a/doc/concepts/engines/memtx.rst b/doc/tarantool_cluster/data_storage/engines/memtx.rst similarity index 100% rename from doc/concepts/engines/memtx.rst rename to doc/tarantool_cluster/data_storage/engines/memtx.rst diff --git a/doc/concepts/engines/memtx/arena2.svg b/doc/tarantool_cluster/data_storage/engines/memtx/arena2.svg similarity index 100% rename from doc/concepts/engines/memtx/arena2.svg rename to doc/tarantool_cluster/data_storage/engines/memtx/arena2.svg diff --git a/doc/concepts/engines/memtx/fibers-channels.svg b/doc/tarantool_cluster/data_storage/engines/memtx/fibers-channels.svg similarity index 100% rename from doc/concepts/engines/memtx/fibers-channels.svg rename to doc/tarantool_cluster/data_storage/engines/memtx/fibers-channels.svg diff --git a/doc/concepts/engines/memtx/iproto.svg b/doc/tarantool_cluster/data_storage/engines/memtx/iproto.svg similarity index 100% rename from doc/concepts/engines/memtx/iproto.svg rename to doc/tarantool_cluster/data_storage/engines/memtx/iproto.svg diff --git a/doc/concepts/engines/memtx/replica-xlogs.svg b/doc/tarantool_cluster/data_storage/engines/memtx/replica-xlogs.svg similarity index 100% rename from doc/concepts/engines/memtx/replica-xlogs.svg rename to doc/tarantool_cluster/data_storage/engines/memtx/replica-xlogs.svg diff --git a/doc/concepts/engines/memtx/snapshot03.svg b/doc/tarantool_cluster/data_storage/engines/memtx/snapshot03.svg similarity index 100% rename from doc/concepts/engines/memtx/snapshot03.svg rename to doc/tarantool_cluster/data_storage/engines/memtx/snapshot03.svg diff --git a/doc/concepts/engines/memtx/spaces_indexes.svg b/doc/tarantool_cluster/data_storage/engines/memtx/spaces_indexes.svg similarity index 100% rename from doc/concepts/engines/memtx/spaces_indexes.svg rename to doc/tarantool_cluster/data_storage/engines/memtx/spaces_indexes.svg diff --git a/doc/concepts/engines/memtx/wal.svg b/doc/tarantool_cluster/data_storage/engines/memtx/wal.svg similarity index 100% rename from doc/concepts/engines/memtx/wal.svg rename to doc/tarantool_cluster/data_storage/engines/memtx/wal.svg diff --git a/doc/concepts/engines/memtx_vinyl_diff.rst b/doc/tarantool_cluster/data_storage/engines/memtx_vinyl_diff.rst similarity index 100% rename from doc/concepts/engines/memtx_vinyl_diff.rst rename to doc/tarantool_cluster/data_storage/engines/memtx_vinyl_diff.rst diff --git a/doc/concepts/engines/vinyl.rst b/doc/tarantool_cluster/data_storage/engines/vinyl.rst similarity index 100% rename from doc/concepts/engines/vinyl.rst rename to doc/tarantool_cluster/data_storage/engines/vinyl.rst diff --git a/doc/concepts/engines/vinyl/1.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/1.svg similarity index 100% rename from doc/concepts/engines/vinyl/1.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/1.svg diff --git a/doc/concepts/engines/vinyl/10.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/10.svg similarity index 100% rename from doc/concepts/engines/vinyl/10.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/10.svg diff --git a/doc/concepts/engines/vinyl/11.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/11.svg similarity index 100% rename from doc/concepts/engines/vinyl/11.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/11.svg diff --git a/doc/concepts/engines/vinyl/12.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/12.svg similarity index 100% rename from doc/concepts/engines/vinyl/12.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/12.svg diff --git a/doc/concepts/engines/vinyl/13.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/13.svg similarity index 100% rename from doc/concepts/engines/vinyl/13.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/13.svg diff --git a/doc/concepts/engines/vinyl/14.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/14.svg similarity index 100% rename from doc/concepts/engines/vinyl/14.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/14.svg diff --git a/doc/concepts/engines/vinyl/15.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/15.svg similarity index 100% rename from doc/concepts/engines/vinyl/15.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/15.svg diff --git a/doc/concepts/engines/vinyl/16.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/16.svg similarity index 100% rename from doc/concepts/engines/vinyl/16.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/16.svg diff --git a/doc/concepts/engines/vinyl/17.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/17.svg similarity index 100% rename from doc/concepts/engines/vinyl/17.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/17.svg diff --git a/doc/concepts/engines/vinyl/2.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/2.svg similarity index 100% rename from doc/concepts/engines/vinyl/2.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/2.svg diff --git a/doc/concepts/engines/vinyl/3.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/3.svg similarity index 100% rename from doc/concepts/engines/vinyl/3.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/3.svg diff --git a/doc/concepts/engines/vinyl/4.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/4.svg similarity index 100% rename from doc/concepts/engines/vinyl/4.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/4.svg diff --git a/doc/concepts/engines/vinyl/5.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/5.svg similarity index 100% rename from doc/concepts/engines/vinyl/5.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/5.svg diff --git a/doc/concepts/engines/vinyl/6.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/6.svg similarity index 100% rename from doc/concepts/engines/vinyl/6.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/6.svg diff --git a/doc/concepts/engines/vinyl/7.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/7.svg similarity index 100% rename from doc/concepts/engines/vinyl/7.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/7.svg diff --git a/doc/concepts/engines/vinyl/8.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/8.svg similarity index 100% rename from doc/concepts/engines/vinyl/8.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/8.svg diff --git a/doc/concepts/engines/vinyl/9.svg b/doc/tarantool_cluster/data_storage/engines/vinyl/9.svg similarity index 100% rename from doc/concepts/engines/vinyl/9.svg rename to doc/tarantool_cluster/data_storage/engines/vinyl/9.svg diff --git a/doc/concepts/engines/vinyl/actor_threads.png b/doc/tarantool_cluster/data_storage/engines/vinyl/actor_threads.png similarity index 100% rename from doc/concepts/engines/vinyl/actor_threads.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/actor_threads.png diff --git a/doc/concepts/engines/vinyl/classical_b_tree.png b/doc/tarantool_cluster/data_storage/engines/vinyl/classical_b_tree.png similarity index 100% rename from doc/concepts/engines/vinyl/classical_b_tree.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/classical_b_tree.png diff --git a/doc/concepts/engines/vinyl/compaction.png b/doc/tarantool_cluster/data_storage/engines/vinyl/compaction.png similarity index 100% rename from doc/concepts/engines/vinyl/compaction.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/compaction.png diff --git a/doc/concepts/engines/vinyl/curve.png b/doc/tarantool_cluster/data_storage/engines/vinyl/curve.png similarity index 100% rename from doc/concepts/engines/vinyl/curve.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/curve.png diff --git a/doc/concepts/engines/vinyl/deletion_1.png b/doc/tarantool_cluster/data_storage/engines/vinyl/deletion_1.png similarity index 100% rename from doc/concepts/engines/vinyl/deletion_1.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/deletion_1.png diff --git a/doc/concepts/engines/vinyl/deletion_2.png b/doc/tarantool_cluster/data_storage/engines/vinyl/deletion_2.png similarity index 100% rename from doc/concepts/engines/vinyl/deletion_2.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/deletion_2.png diff --git a/doc/concepts/engines/vinyl/deletion_3.png b/doc/tarantool_cluster/data_storage/engines/vinyl/deletion_3.png similarity index 100% rename from doc/concepts/engines/vinyl/deletion_3.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/deletion_3.png diff --git a/doc/concepts/engines/vinyl/dump_from_shadow.png b/doc/tarantool_cluster/data_storage/engines/vinyl/dump_from_shadow.png similarity index 100% rename from doc/concepts/engines/vinyl/dump_from_shadow.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/dump_from_shadow.png diff --git a/doc/concepts/engines/vinyl/dumps.png b/doc/tarantool_cluster/data_storage/engines/vinyl/dumps.png similarity index 100% rename from doc/concepts/engines/vinyl/dumps.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/dumps.png diff --git a/doc/concepts/engines/vinyl/factor_lsm.png b/doc/tarantool_cluster/data_storage/engines/vinyl/factor_lsm.png similarity index 100% rename from doc/concepts/engines/vinyl/factor_lsm.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/factor_lsm.png diff --git a/doc/concepts/engines/vinyl/lsm.png b/doc/tarantool_cluster/data_storage/engines/vinyl/lsm.png similarity index 100% rename from doc/concepts/engines/vinyl/lsm.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/lsm.png diff --git a/doc/concepts/engines/vinyl/lsm_single.png b/doc/tarantool_cluster/data_storage/engines/vinyl/lsm_single.png similarity index 100% rename from doc/concepts/engines/vinyl/lsm_single.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/lsm_single.png diff --git a/doc/concepts/engines/vinyl/purge.png b/doc/tarantool_cluster/data_storage/engines/vinyl/purge.png similarity index 100% rename from doc/concepts/engines/vinyl/purge.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/purge.png diff --git a/doc/concepts/engines/vinyl/range_search.png b/doc/tarantool_cluster/data_storage/engines/vinyl/range_search.png similarity index 100% rename from doc/concepts/engines/vinyl/range_search.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/range_search.png diff --git a/doc/concepts/engines/vinyl/read_speed.png b/doc/tarantool_cluster/data_storage/engines/vinyl/read_speed.png similarity index 100% rename from doc/concepts/engines/vinyl/read_speed.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/read_speed.png diff --git a/doc/concepts/engines/vinyl/search.png b/doc/tarantool_cluster/data_storage/engines/vinyl/search.png similarity index 100% rename from doc/concepts/engines/vinyl/search.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/search.png diff --git a/doc/concepts/engines/vinyl/secondary.png b/doc/tarantool_cluster/data_storage/engines/vinyl/secondary.png similarity index 100% rename from doc/concepts/engines/vinyl/secondary.png rename to doc/tarantool_cluster/data_storage/engines/vinyl/secondary.png diff --git a/doc/tarantool_cluster/data_storage/index.rst b/doc/tarantool_cluster/data_storage/index.rst new file mode 100644 index 0000000000..174916ff49 --- /dev/null +++ b/doc/tarantool_cluster/data_storage/index.rst @@ -0,0 +1,12 @@ +.. _data_storage_base: + +Storage +======= + +.. toctree:: + :maxdepth: 1 + + engines/index + configuration_memtx + persistence + wal_extensions diff --git a/doc/concepts/configuration/configuration_persistence.rst b/doc/tarantool_cluster/data_storage/persistence.rst similarity index 99% rename from doc/concepts/configuration/configuration_persistence.rst rename to doc/tarantool_cluster/data_storage/persistence.rst index 7a5011fb9e..4860470b80 100644 --- a/doc/concepts/configuration/configuration_persistence.rst +++ b/doc/tarantool_cluster/data_storage/persistence.rst @@ -1,4 +1,5 @@ -.. _configuration_persistence: +.. _concepts-data_model-persistence: +.. _index-box_persistence: Persistence =========== diff --git a/doc/enterprise/wal_extensions.rst b/doc/tarantool_cluster/data_storage/wal_extensions.rst similarity index 100% rename from doc/enterprise/wal_extensions.rst rename to doc/tarantool_cluster/data_storage/wal_extensions.rst diff --git a/doc/how-to/db/crud.rst b/doc/tarantool_cluster/defining_manipulating_data/crud.rst similarity index 100% rename from doc/how-to/db/crud.rst rename to doc/tarantool_cluster/defining_manipulating_data/crud.rst diff --git a/doc/concepts/data_model/data_model.png b/doc/tarantool_cluster/defining_manipulating_data/data_model.png similarity index 100% rename from doc/concepts/data_model/data_model.png rename to doc/tarantool_cluster/defining_manipulating_data/data_model.png diff --git a/doc/concepts/data_model/data_model.svg b/doc/tarantool_cluster/defining_manipulating_data/data_model.svg similarity index 100% rename from doc/concepts/data_model/data_model.svg rename to doc/tarantool_cluster/defining_manipulating_data/data_model.svg diff --git a/doc/concepts/data_model/foreign_key.svg b/doc/tarantool_cluster/defining_manipulating_data/foreign_key.svg similarity index 100% rename from doc/concepts/data_model/foreign_key.svg rename to doc/tarantool_cluster/defining_manipulating_data/foreign_key.svg diff --git a/doc/tarantool_cluster/defining_manipulating_data/index.rst b/doc/tarantool_cluster/defining_manipulating_data/index.rst new file mode 100644 index 0000000000..6b4df17933 --- /dev/null +++ b/doc/tarantool_cluster/defining_manipulating_data/index.rst @@ -0,0 +1,17 @@ +.. _data_storage_base: + +Defining and manipulating data +============================== + +.. toctree:: + :maxdepth: 1 + + value_store + schema_desc + operations + migrations + read_views + sql/index + + + diff --git a/doc/concepts/data_model/indexes.rst b/doc/tarantool_cluster/defining_manipulating_data/indexes.rst similarity index 100% rename from doc/concepts/data_model/indexes.rst rename to doc/tarantool_cluster/defining_manipulating_data/indexes.rst diff --git a/doc/concepts/data_model/migrations.rst b/doc/tarantool_cluster/defining_manipulating_data/migrations.rst similarity index 99% rename from doc/concepts/data_model/migrations.rst rename to doc/tarantool_cluster/defining_manipulating_data/migrations.rst index 8237be789e..58a8078c9d 100644 --- a/doc/concepts/data_model/migrations.rst +++ b/doc/tarantool_cluster/defining_manipulating_data/migrations.rst @@ -147,3 +147,9 @@ This method is described in the README file of the to deploy a Tarantool cluster, you can use ``eval``. You can find more information about it `in the Ansible role documentation `_. + + +.. toctree:: + :hidden: + + space_upgrade diff --git a/doc/concepts/data_model/operations.rst b/doc/tarantool_cluster/defining_manipulating_data/operations.rst similarity index 99% rename from doc/concepts/data_model/operations.rst rename to doc/tarantool_cluster/defining_manipulating_data/operations.rst index 30a8243066..0fd4a620b4 100644 --- a/doc/concepts/data_model/operations.rst +++ b/doc/tarantool_cluster/defining_manipulating_data/operations.rst @@ -156,3 +156,9 @@ resource usage of each function. setting causes every data-change request to wait for writing to finish on a slow device, this factor is more important than all the others. + +.. toctree:: + :hidden: + + crud + sequences diff --git a/doc/enterprise/read_views.rst b/doc/tarantool_cluster/defining_manipulating_data/read_views.rst similarity index 97% rename from doc/enterprise/read_views.rst rename to doc/tarantool_cluster/defining_manipulating_data/read_views.rst index 8316473dbf..8aa25f7083 100644 --- a/doc/enterprise/read_views.rst +++ b/doc/tarantool_cluster/defining_manipulating_data/read_views.rst @@ -3,6 +3,11 @@ Read views ========== +.. admonition:: Enterprise Edition + :class: fact + + Read views are supported by the `Enterprise Edition `_ only. + A read view is an in-memory snapshot of the entire database that isn't affected by future :ref:`data modifications `. Read views provide access to database spaces and their indexes and enable you to @@ -200,12 +205,3 @@ as described in :ref:`Using data operations read_view1:close() --- ... - - - -.. toctree:: - :maxdepth: 2 - :hidden: - - read_views/lua_api - read_views/c_api \ No newline at end of file diff --git a/doc/concepts/data_model/schema_desc.rst b/doc/tarantool_cluster/defining_manipulating_data/schema_desc.rst similarity index 100% rename from doc/concepts/data_model/schema_desc.rst rename to doc/tarantool_cluster/defining_manipulating_data/schema_desc.rst diff --git a/doc/how-to/db/sequences.rst b/doc/tarantool_cluster/defining_manipulating_data/sequences.rst similarity index 100% rename from doc/how-to/db/sequences.rst rename to doc/tarantool_cluster/defining_manipulating_data/sequences.rst diff --git a/doc/enterprise/space_upgrade.rst b/doc/tarantool_cluster/defining_manipulating_data/space_upgrade.rst similarity index 99% rename from doc/enterprise/space_upgrade.rst rename to doc/tarantool_cluster/defining_manipulating_data/space_upgrade.rst index f8eb00c082..b4f51c43e2 100644 --- a/doc/enterprise/space_upgrade.rst +++ b/doc/tarantool_cluster/defining_manipulating_data/space_upgrade.rst @@ -3,6 +3,11 @@ Upgrading space schema ====================== +.. admonition:: Enterprise Edition + :class: fact + + ``space:upgrade()`` is supported by the `Enterprise Edition `_ only. + In Tarantool, :ref:`migration ` refers to any change in a data schema, for example, creating an index, adding a field, or changing a field format. If you need to change a data schema, there are several possible cases: diff --git a/doc/how-to/sql/improving_mysql.rst b/doc/tarantool_cluster/defining_manipulating_data/sql/improving_mysql.rst similarity index 100% rename from doc/how-to/sql/improving_mysql.rst rename to doc/tarantool_cluster/defining_manipulating_data/sql/improving_mysql.rst diff --git a/doc/how-to/sql/index.rst b/doc/tarantool_cluster/defining_manipulating_data/sql/index.rst similarity index 100% rename from doc/how-to/sql/index.rst rename to doc/tarantool_cluster/defining_manipulating_data/sql/index.rst diff --git a/doc/how-to/sql/sql_beginners_guide.rst b/doc/tarantool_cluster/defining_manipulating_data/sql/sql_beginners_guide.rst similarity index 100% rename from doc/how-to/sql/sql_beginners_guide.rst rename to doc/tarantool_cluster/defining_manipulating_data/sql/sql_beginners_guide.rst diff --git a/doc/how-to/sql/sql_tutorial.rst b/doc/tarantool_cluster/defining_manipulating_data/sql/sql_tutorial.rst similarity index 100% rename from doc/how-to/sql/sql_tutorial.rst rename to doc/tarantool_cluster/defining_manipulating_data/sql/sql_tutorial.rst diff --git a/doc/enterprise/tuple_compression.rst b/doc/tarantool_cluster/defining_manipulating_data/tuple_compression.rst similarity index 97% rename from doc/enterprise/tuple_compression.rst rename to doc/tarantool_cluster/defining_manipulating_data/tuple_compression.rst index ec53e8114e..0ed0aa0c63 100644 --- a/doc/enterprise/tuple_compression.rst +++ b/doc/tarantool_cluster/defining_manipulating_data/tuple_compression.rst @@ -3,6 +3,11 @@ Tuple compression ================= +.. admonition:: Enterprise Edition + :class: fact + + Tuple compression is supported by the `Enterprise Edition `_ only. + Tuple compression, introduced in Tarantool Enterprise Edition 2.10.0, aims to save memory space. Typically, it decreases the volume of stored data by 15%. However, the exact volume saved depends on the type of data. @@ -173,11 +178,3 @@ Performance is measured in requests per second. - 325k - 107k - 20,768,548 - - - -.. toctree:: - :maxdepth: 2 - :hidden: - - tuple_compression/api/compress diff --git a/doc/how-to/db/indexes.rst b/doc/tarantool_cluster/defining_manipulating_data/using_indexes.rst similarity index 100% rename from doc/how-to/db/indexes.rst rename to doc/tarantool_cluster/defining_manipulating_data/using_indexes.rst diff --git a/doc/concepts/data_model/value_store.rst b/doc/tarantool_cluster/defining_manipulating_data/value_store.rst similarity index 99% rename from doc/concepts/data_model/value_store.rst rename to doc/tarantool_cluster/defining_manipulating_data/value_store.rst index 1419f36c58..5e33b9ccfd 100644 --- a/doc/concepts/data_model/value_store.rst +++ b/doc/tarantool_cluster/defining_manipulating_data/value_store.rst @@ -762,3 +762,11 @@ you will get an error. Renaming parent spaces or referenced fields may break the corresponding foreign keys and prevent further insertions or modifications in the child spaces. + + +.. toctree:: + :hidden: + + indexes + using_indexes + tuple_compression diff --git a/doc/how-to/app/app_roles.rst b/doc/tarantool_cluster/developing_apps/app_roles.rst similarity index 100% rename from doc/how-to/app/app_roles.rst rename to doc/tarantool_cluster/developing_apps/app_roles.rst diff --git a/doc/how-to/app/aster.svg b/doc/tarantool_cluster/developing_apps/aster.svg similarity index 100% rename from doc/how-to/app/aster.svg rename to doc/tarantool_cluster/developing_apps/aster.svg diff --git a/doc/how-to/app/c_tutorial.rst b/doc/tarantool_cluster/developing_apps/c_tutorial.rst similarity index 100% rename from doc/how-to/app/c_tutorial.rst rename to doc/tarantool_cluster/developing_apps/c_tutorial.rst diff --git a/doc/how-to/app/cookbook.rst b/doc/tarantool_cluster/developing_apps/cookbook.rst similarity index 100% rename from doc/how-to/app/cookbook.rst rename to doc/tarantool_cluster/developing_apps/cookbook.rst diff --git a/doc/how-to/app/cookbook/main.go b/doc/tarantool_cluster/developing_apps/cookbook/main.go similarity index 100% rename from doc/how-to/app/cookbook/main.go rename to doc/tarantool_cluster/developing_apps/cookbook/main.go diff --git a/doc/concepts/coop_multitasking.rst b/doc/tarantool_cluster/developing_apps/coop_multitasking.rst similarity index 100% rename from doc/concepts/coop_multitasking.rst rename to doc/tarantool_cluster/developing_apps/coop_multitasking.rst diff --git a/doc/how-to/app/creating_app.rst b/doc/tarantool_cluster/developing_apps/creating_app.rst similarity index 100% rename from doc/how-to/app/creating_app.rst rename to doc/tarantool_cluster/developing_apps/creating_app.rst diff --git a/doc/how-to/app/creating_app/GIS.rst b/doc/tarantool_cluster/developing_apps/creating_app/GIS.rst similarity index 100% rename from doc/how-to/app/creating_app/GIS.rst rename to doc/tarantool_cluster/developing_apps/creating_app/GIS.rst diff --git a/doc/how-to/app/creating_app/aster.svg b/doc/tarantool_cluster/developing_apps/creating_app/aster.svg similarity index 100% rename from doc/how-to/app/creating_app/aster.svg rename to doc/tarantool_cluster/developing_apps/creating_app/aster.svg diff --git a/doc/how-to/app/creating_app/avro_schemas.rst b/doc/tarantool_cluster/developing_apps/creating_app/avro_schemas.rst similarity index 100% rename from doc/how-to/app/creating_app/avro_schemas.rst rename to doc/tarantool_cluster/developing_apps/creating_app/avro_schemas.rst diff --git a/doc/how-to/app/creating_app/bootstrapping_a_database.rst b/doc/tarantool_cluster/developing_apps/creating_app/bootstrapping_a_database.rst similarity index 100% rename from doc/how-to/app/creating_app/bootstrapping_a_database.rst rename to doc/tarantool_cluster/developing_apps/creating_app/bootstrapping_a_database.rst diff --git a/doc/how-to/app/creating_app/fibers.rst b/doc/tarantool_cluster/developing_apps/creating_app/fibers.rst similarity index 100% rename from doc/how-to/app/creating_app/fibers.rst rename to doc/tarantool_cluster/developing_apps/creating_app/fibers.rst diff --git a/doc/how-to/app/creating_app/index_iterators.rst b/doc/tarantool_cluster/developing_apps/creating_app/index_iterators.rst similarity index 100% rename from doc/how-to/app/creating_app/index_iterators.rst rename to doc/tarantool_cluster/developing_apps/creating_app/index_iterators.rst diff --git a/doc/how-to/app/creating_app/logging.rst b/doc/tarantool_cluster/developing_apps/creating_app/logging.rst similarity index 100% rename from doc/how-to/app/creating_app/logging.rst rename to doc/tarantool_cluster/developing_apps/creating_app/logging.rst diff --git a/doc/how-to/app/creating_app/modules_rocks_and_applications.rst b/doc/tarantool_cluster/developing_apps/creating_app/modules_rocks_and_applications.rst similarity index 100% rename from doc/how-to/app/creating_app/modules_rocks_and_applications.rst rename to doc/tarantool_cluster/developing_apps/creating_app/modules_rocks_and_applications.rst diff --git a/doc/how-to/app/creating_app/nginx.rst b/doc/tarantool_cluster/developing_apps/creating_app/nginx.rst similarity index 100% rename from doc/how-to/app/creating_app/nginx.rst rename to doc/tarantool_cluster/developing_apps/creating_app/nginx.rst diff --git a/doc/how-to/app/creating_app/non-blockng_io.rst b/doc/tarantool_cluster/developing_apps/creating_app/non-blockng_io.rst similarity index 100% rename from doc/how-to/app/creating_app/non-blockng_io.rst rename to doc/tarantool_cluster/developing_apps/creating_app/non-blockng_io.rst diff --git a/doc/how-to/app/ide_1.png b/doc/tarantool_cluster/developing_apps/ide_1.png similarity index 100% rename from doc/how-to/app/ide_1.png rename to doc/tarantool_cluster/developing_apps/ide_1.png diff --git a/doc/how-to/app/ide_2.png b/doc/tarantool_cluster/developing_apps/ide_2.png similarity index 100% rename from doc/how-to/app/ide_2.png rename to doc/tarantool_cluster/developing_apps/ide_2.png diff --git a/doc/how-to/app/ide_3.png b/doc/tarantool_cluster/developing_apps/ide_3.png similarity index 100% rename from doc/how-to/app/ide_3.png rename to doc/tarantool_cluster/developing_apps/ide_3.png diff --git a/doc/how-to/app/ide_4.png b/doc/tarantool_cluster/developing_apps/ide_4.png similarity index 100% rename from doc/how-to/app/ide_4.png rename to doc/tarantool_cluster/developing_apps/ide_4.png diff --git a/doc/how-to/app/ide_5.png b/doc/tarantool_cluster/developing_apps/ide_5.png similarity index 100% rename from doc/how-to/app/ide_5.png rename to doc/tarantool_cluster/developing_apps/ide_5.png diff --git a/doc/how-to/app/ide_6.png b/doc/tarantool_cluster/developing_apps/ide_6.png similarity index 100% rename from doc/how-to/app/ide_6.png rename to doc/tarantool_cluster/developing_apps/ide_6.png diff --git a/doc/how-to/app/ide_7.png b/doc/tarantool_cluster/developing_apps/ide_7.png similarity index 100% rename from doc/how-to/app/ide_7.png rename to doc/tarantool_cluster/developing_apps/ide_7.png diff --git a/doc/how-to/app/ide_8.png b/doc/tarantool_cluster/developing_apps/ide_8.png similarity index 100% rename from doc/how-to/app/ide_8.png rename to doc/tarantool_cluster/developing_apps/ide_8.png diff --git a/doc/how-to/app/ide_9.png b/doc/tarantool_cluster/developing_apps/ide_9.png similarity index 100% rename from doc/how-to/app/ide_9.png rename to doc/tarantool_cluster/developing_apps/ide_9.png diff --git a/doc/how-to/app/index.rst b/doc/tarantool_cluster/developing_apps/index.rst similarity index 79% rename from doc/how-to/app/index.rst rename to doc/tarantool_cluster/developing_apps/index.rst index 452b4caf7e..cc564a6bfb 100644 --- a/doc/how-to/app/index.rst +++ b/doc/tarantool_cluster/developing_apps/index.rst @@ -1,7 +1,11 @@ .. _how-to-app-server: -Developing applications with Tarantool -====================================== +Applications +============ + +.. important:: + + Will be updated to 3.0. Using Tarantool as an application server, you can write your own applications. Tarantool’s native language for writing applications is @@ -19,3 +23,6 @@ in C or C++. cookbook lua_tutorials c_tutorial + coop_multitasking + modules + lua_tips diff --git a/doc/how-to/app/launching_app.rst b/doc/tarantool_cluster/developing_apps/launching_app.rst similarity index 100% rename from doc/how-to/app/launching_app.rst rename to doc/tarantool_cluster/developing_apps/launching_app.rst diff --git a/doc/reference/lua_tips.rst b/doc/tarantool_cluster/developing_apps/lua_tips.rst similarity index 100% rename from doc/reference/lua_tips.rst rename to doc/tarantool_cluster/developing_apps/lua_tips.rst diff --git a/doc/how-to/app/lua_tutorials.rst b/doc/tarantool_cluster/developing_apps/lua_tutorials.rst similarity index 100% rename from doc/how-to/app/lua_tutorials.rst rename to doc/tarantool_cluster/developing_apps/lua_tutorials.rst diff --git a/doc/concepts/modules.rst b/doc/tarantool_cluster/developing_apps/modules.rst similarity index 100% rename from doc/concepts/modules.rst rename to doc/tarantool_cluster/developing_apps/modules.rst diff --git a/doc/how-to/app/using_ide.rst b/doc/tarantool_cluster/developing_apps/using_ide.rst similarity index 100% rename from doc/how-to/app/using_ide.rst rename to doc/tarantool_cluster/developing_apps/using_ide.rst diff --git a/doc/concepts/yields.svg b/doc/tarantool_cluster/developing_apps/yields.svg similarity index 100% rename from doc/concepts/yields.svg rename to doc/tarantool_cluster/developing_apps/yields.svg diff --git a/doc/tarantool_cluster/index.rst b/doc/tarantool_cluster/index.rst new file mode 100644 index 0000000000..5b80d913f4 --- /dev/null +++ b/doc/tarantool_cluster/index.rst @@ -0,0 +1,18 @@ +.. _tarantool_cluster: + +Database & application server +============================= + +.. toctree:: + :maxdepth: 1 + + data_storage/index + defining_manipulating_data/index + cluster_configuration/configuration + connections_and_auth/index + replication/index + transactions/atomic + sharding/index + security/index + triggers + developing_apps/index diff --git a/doc/concepts/replication/images/cascade-problem-1.svg b/doc/tarantool_cluster/replication/images/cascade-problem-1.svg similarity index 100% rename from doc/concepts/replication/images/cascade-problem-1.svg rename to doc/tarantool_cluster/replication/images/cascade-problem-1.svg diff --git a/doc/concepts/replication/images/cascade-problem-2.svg b/doc/tarantool_cluster/replication/images/cascade-problem-2.svg similarity index 100% rename from doc/concepts/replication/images/cascade-problem-2.svg rename to doc/tarantool_cluster/replication/images/cascade-problem-2.svg diff --git a/doc/concepts/replication/images/cascade-to-ring.svg b/doc/tarantool_cluster/replication/images/cascade-to-ring.svg similarity index 100% rename from doc/concepts/replication/images/cascade-to-ring.svg rename to doc/tarantool_cluster/replication/images/cascade-to-ring.svg diff --git a/doc/concepts/replication/images/mm-3m-mesh-add.svg b/doc/tarantool_cluster/replication/images/mm-3m-mesh-add.svg similarity index 100% rename from doc/concepts/replication/images/mm-3m-mesh-add.svg rename to doc/tarantool_cluster/replication/images/mm-3m-mesh-add.svg diff --git a/doc/concepts/replication/images/mm-3m-mesh.svg b/doc/tarantool_cluster/replication/images/mm-3m-mesh.svg similarity index 100% rename from doc/concepts/replication/images/mm-3m-mesh.svg rename to doc/tarantool_cluster/replication/images/mm-3m-mesh.svg diff --git a/doc/concepts/replication/images/mr-1m-2r-mesh-add.svg b/doc/tarantool_cluster/replication/images/mr-1m-2r-mesh-add.svg similarity index 100% rename from doc/concepts/replication/images/mr-1m-2r-mesh-add.svg rename to doc/tarantool_cluster/replication/images/mr-1m-2r-mesh-add.svg diff --git a/doc/concepts/replication/images/mr-1m-2r-mesh.svg b/doc/tarantool_cluster/replication/images/mr-1m-2r-mesh.svg similarity index 100% rename from doc/concepts/replication/images/mr-1m-2r-mesh.svg rename to doc/tarantool_cluster/replication/images/mr-1m-2r-mesh.svg diff --git a/doc/concepts/replication/images/mr-1m-2r-oneway.svg b/doc/tarantool_cluster/replication/images/mr-1m-2r-oneway.svg similarity index 100% rename from doc/concepts/replication/images/mr-1m-2r-oneway.svg rename to doc/tarantool_cluster/replication/images/mr-1m-2r-oneway.svg diff --git a/doc/concepts/replication/images/no-cascade.svg b/doc/tarantool_cluster/replication/images/no-cascade.svg similarity index 100% rename from doc/concepts/replication/images/no-cascade.svg rename to doc/tarantool_cluster/replication/images/no-cascade.svg diff --git a/doc/concepts/replication/images/replication.svg b/doc/tarantool_cluster/replication/images/replication.svg similarity index 100% rename from doc/concepts/replication/images/replication.svg rename to doc/tarantool_cluster/replication/images/replication.svg diff --git a/doc/concepts/replication/index.rst b/doc/tarantool_cluster/replication/index.rst similarity index 88% rename from doc/concepts/replication/index.rst rename to doc/tarantool_cluster/replication/index.rst index 5d0e33f501..fe757acb70 100644 --- a/doc/concepts/replication/index.rst +++ b/doc/tarantool_cluster/replication/index.rst @@ -1,7 +1,7 @@ :noindex: :fullwidth: -.. _replication: +.. _replication_base: Replication =========== @@ -13,12 +13,12 @@ its changes to all the other instances. This section includes the following topics: .. toctree:: - :maxdepth: 2 - :numbered: 0 + :maxdepth: 1 repl_architecture repl_sync repl_leader_elect + replication_tutorials/index For practical guides to replication, see :ref:`Replication tutorials `. You can learn about bootstrapping a replica set, adding instances to the replica set, or removing them. diff --git a/doc/concepts/replication/repl_architecture.rst b/doc/tarantool_cluster/replication/repl_architecture.rst similarity index 100% rename from doc/concepts/replication/repl_architecture.rst rename to doc/tarantool_cluster/replication/repl_architecture.rst diff --git a/doc/concepts/replication/repl_leader_elect.rst b/doc/tarantool_cluster/replication/repl_leader_elect.rst similarity index 100% rename from doc/concepts/replication/repl_leader_elect.rst rename to doc/tarantool_cluster/replication/repl_leader_elect.rst diff --git a/doc/concepts/replication/repl_sync.rst b/doc/tarantool_cluster/replication/repl_sync.rst similarity index 100% rename from doc/concepts/replication/repl_sync.rst rename to doc/tarantool_cluster/replication/repl_sync.rst diff --git a/doc/how-to/replication/box_info_replication_instance002_disconnected.png b/doc/tarantool_cluster/replication/replication_tutorials/box_info_replication_instance002_disconnected.png similarity index 100% rename from doc/how-to/replication/box_info_replication_instance002_disconnected.png rename to doc/tarantool_cluster/replication/replication_tutorials/box_info_replication_instance002_disconnected.png diff --git a/doc/how-to/replication/box_info_replication_master_master_follow_stopped.png b/doc/tarantool_cluster/replication/replication_tutorials/box_info_replication_master_master_follow_stopped.png similarity index 100% rename from doc/how-to/replication/box_info_replication_master_master_follow_stopped.png rename to doc/tarantool_cluster/replication/replication_tutorials/box_info_replication_master_master_follow_stopped.png diff --git a/doc/how-to/replication/box_info_replication_master_master_stopped.png b/doc/tarantool_cluster/replication/replication_tutorials/box_info_replication_master_master_stopped.png similarity index 100% rename from doc/how-to/replication/box_info_replication_master_master_stopped.png rename to doc/tarantool_cluster/replication/replication_tutorials/box_info_replication_master_master_stopped.png diff --git a/doc/how-to/replication/index.rst b/doc/tarantool_cluster/replication/replication_tutorials/index.rst similarity index 89% rename from doc/how-to/replication/index.rst rename to doc/tarantool_cluster/replication/replication_tutorials/index.rst index a7cfc1f561..f73743bcc4 100644 --- a/doc/how-to/replication/index.rst +++ b/doc/tarantool_cluster/replication/replication_tutorials/index.rst @@ -5,9 +5,8 @@ Replication tutorials ===================== .. toctree:: - :maxdepth: 2 + :maxdepth: 1 repl_bootstrap repl_bootstrap_auto repl_bootstrap_master_master - \ No newline at end of file diff --git a/doc/how-to/replication/mm-2m-mesh.png b/doc/tarantool_cluster/replication/replication_tutorials/mm-2m-mesh.png similarity index 100% rename from doc/how-to/replication/mm-2m-mesh.png rename to doc/tarantool_cluster/replication/replication_tutorials/mm-2m-mesh.png diff --git a/doc/how-to/replication/mm-2m-mesh.svg b/doc/tarantool_cluster/replication/replication_tutorials/mm-2m-mesh.svg similarity index 100% rename from doc/how-to/replication/mm-2m-mesh.svg rename to doc/tarantool_cluster/replication/replication_tutorials/mm-2m-mesh.svg diff --git a/doc/how-to/replication/mm-3m-mesh-add.png b/doc/tarantool_cluster/replication/replication_tutorials/mm-3m-mesh-add.png similarity index 100% rename from doc/how-to/replication/mm-3m-mesh-add.png rename to doc/tarantool_cluster/replication/replication_tutorials/mm-3m-mesh-add.png diff --git a/doc/how-to/replication/mr-1m-1r-twoway.png b/doc/tarantool_cluster/replication/replication_tutorials/mr-1m-1r-twoway.png similarity index 100% rename from doc/how-to/replication/mr-1m-1r-twoway.png rename to doc/tarantool_cluster/replication/replication_tutorials/mr-1m-1r-twoway.png diff --git a/doc/how-to/replication/mr-1m-1r-twoway.svg b/doc/tarantool_cluster/replication/replication_tutorials/mr-1m-1r-twoway.svg similarity index 100% rename from doc/how-to/replication/mr-1m-1r-twoway.svg rename to doc/tarantool_cluster/replication/replication_tutorials/mr-1m-1r-twoway.svg diff --git a/doc/how-to/replication/mr-1m-2r-mesh-add.png b/doc/tarantool_cluster/replication/replication_tutorials/mr-1m-2r-mesh-add.png similarity index 100% rename from doc/how-to/replication/mr-1m-2r-mesh-add.png rename to doc/tarantool_cluster/replication/replication_tutorials/mr-1m-2r-mesh-add.png diff --git a/doc/how-to/replication/repl_bootstrap.rst b/doc/tarantool_cluster/replication/replication_tutorials/repl_bootstrap.rst similarity index 100% rename from doc/how-to/replication/repl_bootstrap.rst rename to doc/tarantool_cluster/replication/replication_tutorials/repl_bootstrap.rst diff --git a/doc/how-to/replication/repl_bootstrap_auto.rst b/doc/tarantool_cluster/replication/replication_tutorials/repl_bootstrap_auto.rst similarity index 100% rename from doc/how-to/replication/repl_bootstrap_auto.rst rename to doc/tarantool_cluster/replication/replication_tutorials/repl_bootstrap_auto.rst diff --git a/doc/how-to/replication/repl_bootstrap_master_master.rst b/doc/tarantool_cluster/replication/replication_tutorials/repl_bootstrap_master_master.rst similarity index 100% rename from doc/how-to/replication/repl_bootstrap_master_master.rst rename to doc/tarantool_cluster/replication/replication_tutorials/repl_bootstrap_master_master.rst diff --git a/doc/how-to/replication/replicationX.svg b/doc/tarantool_cluster/replication/replication_tutorials/replicationX.svg similarity index 100% rename from doc/how-to/replication/replicationX.svg rename to doc/tarantool_cluster/replication/replication_tutorials/replicationX.svg diff --git a/doc/enterprise/audit.rst b/doc/tarantool_cluster/security/audit.rst similarity index 100% rename from doc/enterprise/audit.rst rename to doc/tarantool_cluster/security/audit.rst diff --git a/doc/enterprise/audit_log.rst b/doc/tarantool_cluster/security/audit_log.rst similarity index 99% rename from doc/enterprise/audit_log.rst rename to doc/tarantool_cluster/security/audit_log.rst index fb3c8aff1c..3249cc2352 100644 --- a/doc/enterprise/audit_log.rst +++ b/doc/tarantool_cluster/security/audit_log.rst @@ -3,6 +3,11 @@ Audit module ============ +.. admonition:: Enterprise Edition + :class: fact + + The audit module is available in the `Enterprise Edition `_ only. + **Example on GitHub**: `audit_log `_ The audit module available in Tarantool Enterprise Edition allows you to record various events occurred in Tarantool. diff --git a/doc/tarantool_cluster/security/index.rst b/doc/tarantool_cluster/security/index.rst new file mode 100644 index 0000000000..f6c05dcae6 --- /dev/null +++ b/doc/tarantool_cluster/security/index.rst @@ -0,0 +1,11 @@ +.. _security_base: + +Security +======== + +.. toctree:: + :maxdepth: 1 + + audit_log + audit + security diff --git a/doc/enterprise/security.rst b/doc/tarantool_cluster/security/security.rst similarity index 100% rename from doc/enterprise/security.rst rename to doc/tarantool_cluster/security/security.rst diff --git a/doc/concepts/sharding/bucket.svg b/doc/tarantool_cluster/sharding/bucket.svg similarity index 100% rename from doc/concepts/sharding/bucket.svg rename to doc/tarantool_cluster/sharding/bucket.svg diff --git a/doc/concepts/sharding/buckets.svg b/doc/tarantool_cluster/sharding/buckets.svg similarity index 100% rename from doc/concepts/sharding/buckets.svg rename to doc/tarantool_cluster/sharding/buckets.svg diff --git a/doc/concepts/sharding/hierarchy.png b/doc/tarantool_cluster/sharding/hierarchy.png similarity index 100% rename from doc/concepts/sharding/hierarchy.png rename to doc/tarantool_cluster/sharding/hierarchy.png diff --git a/doc/concepts/sharding/index.rst b/doc/tarantool_cluster/sharding/index.rst similarity index 98% rename from doc/concepts/sharding/index.rst rename to doc/tarantool_cluster/sharding/index.rst index c447f70beb..6514d9e4fe 100644 --- a/doc/concepts/sharding/index.rst +++ b/doc/tarantool_cluster/sharding/index.rst @@ -39,9 +39,10 @@ Check out the :ref:`quick start guide ` or learn more about :ref:`how sharding works ` in Tarantool: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 vshard_architecture + vshard_admin You can also find out more about :ref:`sharding administration ` or dive into the ``vshard`` configuration and API :ref:`reference `. diff --git a/doc/concepts/sharding/master_replica.svg b/doc/tarantool_cluster/sharding/master_replica.svg similarity index 100% rename from doc/concepts/sharding/master_replica.svg rename to doc/tarantool_cluster/sharding/master_replica.svg diff --git a/doc/concepts/sharding/schema.svg b/doc/tarantool_cluster/sharding/schema.svg similarity index 100% rename from doc/concepts/sharding/schema.svg rename to doc/tarantool_cluster/sharding/schema.svg diff --git a/doc/concepts/sharding/states.svg b/doc/tarantool_cluster/sharding/states.svg similarity index 100% rename from doc/concepts/sharding/states.svg rename to doc/tarantool_cluster/sharding/states.svg diff --git a/doc/concepts/sharding/vbuckets.svg b/doc/tarantool_cluster/sharding/vbuckets.svg similarity index 100% rename from doc/concepts/sharding/vbuckets.svg rename to doc/tarantool_cluster/sharding/vbuckets.svg diff --git a/doc/book/admin/vshard_admin.rst b/doc/tarantool_cluster/sharding/vshard_admin.rst similarity index 100% rename from doc/book/admin/vshard_admin.rst rename to doc/tarantool_cluster/sharding/vshard_admin.rst diff --git a/doc/concepts/sharding/vshard_architecture.rst b/doc/tarantool_cluster/sharding/vshard_architecture.rst similarity index 100% rename from doc/concepts/sharding/vshard_architecture.rst rename to doc/tarantool_cluster/sharding/vshard_architecture.rst diff --git a/doc/concepts/atomic.rst b/doc/tarantool_cluster/transactions/atomic.rst similarity index 90% rename from doc/concepts/atomic.rst rename to doc/tarantool_cluster/transactions/atomic.rst index e3ee0e9bf3..a8d7d0a9ce 100644 --- a/doc/concepts/atomic.rst +++ b/doc/tarantool_cluster/transactions/atomic.rst @@ -1,20 +1,20 @@ -:noindex: -:fullwidth: - -.. _atomic-atomic_execution: - -Transactions -============ - -Transactions allow users to perform multiple operations atomically. - -For more information on how transactions work in Tarantool, see the following sections: - -.. toctree:: - :maxdepth: 2 - - atomic/transaction_model - atomic/thread_model - atomic/txn_mode_default - atomic/txn_mode_mvcc - +:noindex: +:fullwidth: + +.. _atomic-atomic_execution: + +Transactions +============ + +Transactions allow users to perform multiple operations atomically. + +For more information on how transactions work in Tarantool, see the following sections: + +.. toctree:: + :maxdepth: 1 + + atomic/transaction_model + atomic/thread_model + atomic/txn_mode_default + atomic/txn_mode_mvcc + diff --git a/doc/concepts/atomic/thread_model.rst b/doc/tarantool_cluster/transactions/atomic/thread_model.rst similarity index 100% rename from doc/concepts/atomic/thread_model.rst rename to doc/tarantool_cluster/transactions/atomic/thread_model.rst diff --git a/doc/concepts/atomic/transaction_model.rst b/doc/tarantool_cluster/transactions/atomic/transaction_model.rst similarity index 100% rename from doc/concepts/atomic/transaction_model.rst rename to doc/tarantool_cluster/transactions/atomic/transaction_model.rst diff --git a/doc/concepts/atomic/txn_mode_default.rst b/doc/tarantool_cluster/transactions/atomic/txn_mode_default.rst similarity index 100% rename from doc/concepts/atomic/txn_mode_default.rst rename to doc/tarantool_cluster/transactions/atomic/txn_mode_default.rst diff --git a/doc/concepts/atomic/txn_mode_mvcc.rst b/doc/tarantool_cluster/transactions/atomic/txn_mode_mvcc.rst similarity index 100% rename from doc/concepts/atomic/txn_mode_mvcc.rst rename to doc/tarantool_cluster/transactions/atomic/txn_mode_mvcc.rst diff --git a/doc/concepts/triggers.rst b/doc/tarantool_cluster/triggers.rst similarity index 100% rename from doc/concepts/triggers.rst rename to doc/tarantool_cluster/triggers.rst diff --git a/doc/toctree.rst b/doc/toctree.rst index e85d81075d..b9f63573b9 100644 --- a/doc/toctree.rst +++ b/doc/toctree.rst @@ -7,12 +7,11 @@ overview getting_started/index - how-to/index - concepts/index - CRUD operations + tarantool_cluster/index + developing_apps/index + connectors/index book/admin/index - book/connectors - enterprise/index + tooling/index reference/index release/index contributing/index diff --git a/doc/reference/tooling/index.rst b/doc/tooling/index.rst similarity index 77% rename from doc/reference/tooling/index.rst rename to doc/tooling/index.rst index f3b8d598c1..ded6d9efd1 100644 --- a/doc/reference/tooling/index.rst +++ b/doc/tooling/index.rst @@ -10,6 +10,4 @@ to work with Tarantool. tt_cli/index tcm/index interactive_console - tarantoolctl - luajit_memprof - luajit_getmetrics + luajit diff --git a/doc/reference/tooling/interactive_console.rst b/doc/tooling/interactive_console.rst similarity index 100% rename from doc/reference/tooling/interactive_console.rst rename to doc/tooling/interactive_console.rst diff --git a/doc/tooling/luajit.rst b/doc/tooling/luajit.rst new file mode 100644 index 0000000000..bccbe04323 --- /dev/null +++ b/doc/tooling/luajit.rst @@ -0,0 +1,8 @@ +LuaJIT +====== + +.. toctree:: + :maxdepth: 1 + + luajit_memprof + luajit_getmetrics diff --git a/doc/reference/tooling/luajit_getmetrics.rst b/doc/tooling/luajit_getmetrics.rst similarity index 100% rename from doc/reference/tooling/luajit_getmetrics.rst rename to doc/tooling/luajit_getmetrics.rst diff --git a/doc/reference/tooling/luajit_memprof.rst b/doc/tooling/luajit_memprof.rst similarity index 100% rename from doc/reference/tooling/luajit_memprof.rst rename to doc/tooling/luajit_memprof.rst diff --git a/doc/reference/tooling/tarantoolctl.rst b/doc/tooling/tarantoolctl.rst similarity index 100% rename from doc/reference/tooling/tarantoolctl.rst rename to doc/tooling/tarantoolctl.rst diff --git a/doc/reference/tooling/tcm/index.rst b/doc/tooling/tcm/index.rst similarity index 100% rename from doc/reference/tooling/tcm/index.rst rename to doc/tooling/tcm/index.rst diff --git a/doc/reference/tooling/tcm/tcm_access_control.rst b/doc/tooling/tcm/tcm_access_control.rst similarity index 100% rename from doc/reference/tooling/tcm/tcm_access_control.rst rename to doc/tooling/tcm/tcm_access_control.rst diff --git a/doc/reference/tooling/tcm/tcm_audit_log.rst b/doc/tooling/tcm/tcm_audit_log.rst similarity index 100% rename from doc/reference/tooling/tcm/tcm_audit_log.rst rename to doc/tooling/tcm/tcm_audit_log.rst diff --git a/doc/reference/tooling/tcm/tcm_backend_store.rst b/doc/tooling/tcm/tcm_backend_store.rst similarity index 100% rename from doc/reference/tooling/tcm/tcm_backend_store.rst rename to doc/tooling/tcm/tcm_backend_store.rst diff --git a/doc/reference/tooling/tcm/tcm_cluster_config.rst b/doc/tooling/tcm/tcm_cluster_config.rst similarity index 100% rename from doc/reference/tooling/tcm/tcm_cluster_config.rst rename to doc/tooling/tcm/tcm_cluster_config.rst diff --git a/doc/reference/tooling/tcm/tcm_cluster_metrics.rst b/doc/tooling/tcm/tcm_cluster_metrics.rst similarity index 100% rename from doc/reference/tooling/tcm/tcm_cluster_metrics.rst rename to doc/tooling/tcm/tcm_cluster_metrics.rst diff --git a/doc/reference/tooling/tcm/tcm_cluster_monitoring.rst b/doc/tooling/tcm/tcm_cluster_monitoring.rst similarity index 100% rename from doc/reference/tooling/tcm/tcm_cluster_monitoring.rst rename to doc/tooling/tcm/tcm_cluster_monitoring.rst diff --git a/doc/reference/tooling/tcm/tcm_configuration.rst b/doc/tooling/tcm/tcm_configuration.rst similarity index 100% rename from doc/reference/tooling/tcm/tcm_configuration.rst rename to doc/tooling/tcm/tcm_configuration.rst diff --git a/doc/reference/tooling/tcm/tcm_configuration_reference.rst b/doc/tooling/tcm/tcm_configuration_reference.rst similarity index 100% rename from doc/reference/tooling/tcm/tcm_configuration_reference.rst rename to doc/tooling/tcm/tcm_configuration_reference.rst diff --git a/doc/reference/tooling/tcm/tcm_connect_clusters.rst b/doc/tooling/tcm/tcm_connect_clusters.rst similarity index 100% rename from doc/reference/tooling/tcm/tcm_connect_clusters.rst rename to doc/tooling/tcm/tcm_connect_clusters.rst diff --git a/doc/reference/tooling/tcm/tcm_releases/index.rst b/doc/tooling/tcm/tcm_releases/index.rst similarity index 100% rename from doc/reference/tooling/tcm/tcm_releases/index.rst rename to doc/tooling/tcm/tcm_releases/index.rst diff --git a/doc/reference/tooling/tcm/tcm_releases/tcm_1.0.rst b/doc/tooling/tcm/tcm_releases/tcm_1.0.rst similarity index 100% rename from doc/reference/tooling/tcm/tcm_releases/tcm_1.0.rst rename to doc/tooling/tcm/tcm_releases/tcm_1.0.rst diff --git a/doc/reference/tooling/tcm/tcm_releases/tcm_1.1.rst b/doc/tooling/tcm/tcm_releases/tcm_1.1.rst similarity index 100% rename from doc/reference/tooling/tcm/tcm_releases/tcm_1.1.rst rename to doc/tooling/tcm/tcm_releases/tcm_1.1.rst diff --git a/doc/reference/tooling/tt_cli/_includes/cartridge_deprecation_note.rst b/doc/tooling/tt_cli/_includes/cartridge_deprecation_note.rst similarity index 100% rename from doc/reference/tooling/tt_cli/_includes/cartridge_deprecation_note.rst rename to doc/tooling/tt_cli/_includes/cartridge_deprecation_note.rst diff --git a/doc/reference/tooling/tt_cli/binaries.rst b/doc/tooling/tt_cli/binaries.rst similarity index 100% rename from doc/reference/tooling/tt_cli/binaries.rst rename to doc/tooling/tt_cli/binaries.rst diff --git a/doc/reference/tooling/tt_cli/build.rst b/doc/tooling/tt_cli/build.rst similarity index 100% rename from doc/reference/tooling/tt_cli/build.rst rename to doc/tooling/tt_cli/build.rst diff --git a/doc/reference/tooling/tt_cli/cartridge.rst b/doc/tooling/tt_cli/cartridge.rst similarity index 100% rename from doc/reference/tooling/tt_cli/cartridge.rst rename to doc/tooling/tt_cli/cartridge.rst diff --git a/doc/reference/tooling/tt_cli/cat.rst b/doc/tooling/tt_cli/cat.rst similarity index 100% rename from doc/reference/tooling/tt_cli/cat.rst rename to doc/tooling/tt_cli/cat.rst diff --git a/doc/reference/tooling/tt_cli/cfg.rst b/doc/tooling/tt_cli/cfg.rst similarity index 100% rename from doc/reference/tooling/tt_cli/cfg.rst rename to doc/tooling/tt_cli/cfg.rst diff --git a/doc/reference/tooling/tt_cli/check.rst b/doc/tooling/tt_cli/check.rst similarity index 100% rename from doc/reference/tooling/tt_cli/check.rst rename to doc/tooling/tt_cli/check.rst diff --git a/doc/reference/tooling/tt_cli/clean.rst b/doc/tooling/tt_cli/clean.rst similarity index 100% rename from doc/reference/tooling/tt_cli/clean.rst rename to doc/tooling/tt_cli/clean.rst diff --git a/doc/reference/tooling/tt_cli/cluster.rst b/doc/tooling/tt_cli/cluster.rst similarity index 100% rename from doc/reference/tooling/tt_cli/cluster.rst rename to doc/tooling/tt_cli/cluster.rst diff --git a/doc/reference/tooling/tt_cli/commands.rst b/doc/tooling/tt_cli/commands.rst similarity index 100% rename from doc/reference/tooling/tt_cli/commands.rst rename to doc/tooling/tt_cli/commands.rst diff --git a/doc/reference/tooling/tt_cli/completion.rst b/doc/tooling/tt_cli/completion.rst similarity index 100% rename from doc/reference/tooling/tt_cli/completion.rst rename to doc/tooling/tt_cli/completion.rst diff --git a/doc/reference/tooling/tt_cli/configuration.rst b/doc/tooling/tt_cli/configuration.rst similarity index 100% rename from doc/reference/tooling/tt_cli/configuration.rst rename to doc/tooling/tt_cli/configuration.rst diff --git a/doc/reference/tooling/tt_cli/connect.rst b/doc/tooling/tt_cli/connect.rst similarity index 100% rename from doc/reference/tooling/tt_cli/connect.rst rename to doc/tooling/tt_cli/connect.rst diff --git a/doc/reference/tooling/tt_cli/coredump.rst b/doc/tooling/tt_cli/coredump.rst similarity index 100% rename from doc/reference/tooling/tt_cli/coredump.rst rename to doc/tooling/tt_cli/coredump.rst diff --git a/doc/reference/tooling/tt_cli/create.rst b/doc/tooling/tt_cli/create.rst similarity index 100% rename from doc/reference/tooling/tt_cli/create.rst rename to doc/tooling/tt_cli/create.rst diff --git a/doc/reference/tooling/tt_cli/crud.rst b/doc/tooling/tt_cli/crud.rst similarity index 100% rename from doc/reference/tooling/tt_cli/crud.rst rename to doc/tooling/tt_cli/crud.rst diff --git a/doc/tooling/tt_cli/developing_applications.rst b/doc/tooling/tt_cli/developing_applications.rst new file mode 100644 index 0000000000..d44790090c --- /dev/null +++ b/doc/tooling/tt_cli/developing_applications.rst @@ -0,0 +1,11 @@ +.. _tt_developing_apps: + +Developing applications +======================= + +.. toctree:: + :maxdepth: 1 + + instance_config + start_stop_instance + diff --git a/doc/reference/tooling/tt_cli/export.rst b/doc/tooling/tt_cli/export.rst similarity index 100% rename from doc/reference/tooling/tt_cli/export.rst rename to doc/tooling/tt_cli/export.rst diff --git a/doc/reference/tooling/tt_cli/external_modules.rst b/doc/tooling/tt_cli/external_modules.rst similarity index 100% rename from doc/reference/tooling/tt_cli/external_modules.rst rename to doc/tooling/tt_cli/external_modules.rst diff --git a/doc/reference/tooling/tt_cli/global_options.rst b/doc/tooling/tt_cli/global_options.rst similarity index 100% rename from doc/reference/tooling/tt_cli/global_options.rst rename to doc/tooling/tt_cli/global_options.rst diff --git a/doc/reference/tooling/tt_cli/help.rst b/doc/tooling/tt_cli/help.rst similarity index 100% rename from doc/reference/tooling/tt_cli/help.rst rename to doc/tooling/tt_cli/help.rst diff --git a/doc/reference/tooling/tt_cli/import.rst b/doc/tooling/tt_cli/import.rst similarity index 100% rename from doc/reference/tooling/tt_cli/import.rst rename to doc/tooling/tt_cli/import.rst diff --git a/doc/reference/tooling/tt_cli/index.rst b/doc/tooling/tt_cli/index.rst similarity index 99% rename from doc/reference/tooling/tt_cli/index.rst rename to doc/tooling/tt_cli/index.rst index 1c646a2cd9..83dfd66c2c 100644 --- a/doc/reference/tooling/tt_cli/index.rst +++ b/doc/tooling/tt_cli/index.rst @@ -25,6 +25,7 @@ concept explanation, and the ``tt`` command reference. installation configuration global_options + developing_applications commands external_modules tt_interactive_console diff --git a/doc/reference/tooling/tt_cli/init.rst b/doc/tooling/tt_cli/init.rst similarity index 100% rename from doc/reference/tooling/tt_cli/init.rst rename to doc/tooling/tt_cli/init.rst diff --git a/doc/reference/tooling/tt_cli/install.rst b/doc/tooling/tt_cli/install.rst similarity index 100% rename from doc/reference/tooling/tt_cli/install.rst rename to doc/tooling/tt_cli/install.rst diff --git a/doc/reference/tooling/tt_cli/installation.rst b/doc/tooling/tt_cli/installation.rst similarity index 100% rename from doc/reference/tooling/tt_cli/installation.rst rename to doc/tooling/tt_cli/installation.rst diff --git a/doc/book/admin/instance_config.rst b/doc/tooling/tt_cli/instance_config.rst similarity index 100% rename from doc/book/admin/instance_config.rst rename to doc/tooling/tt_cli/instance_config.rst diff --git a/doc/reference/tooling/tt_cli/instances.rst b/doc/tooling/tt_cli/instances.rst similarity index 100% rename from doc/reference/tooling/tt_cli/instances.rst rename to doc/tooling/tt_cli/instances.rst diff --git a/doc/reference/tooling/tt_cli/logrotate.rst b/doc/tooling/tt_cli/logrotate.rst similarity index 100% rename from doc/reference/tooling/tt_cli/logrotate.rst rename to doc/tooling/tt_cli/logrotate.rst diff --git a/doc/reference/tooling/tt_cli/pack.rst b/doc/tooling/tt_cli/pack.rst similarity index 100% rename from doc/reference/tooling/tt_cli/pack.rst rename to doc/tooling/tt_cli/pack.rst diff --git a/doc/reference/tooling/tt_cli/play.rst b/doc/tooling/tt_cli/play.rst similarity index 100% rename from doc/reference/tooling/tt_cli/play.rst rename to doc/tooling/tt_cli/play.rst diff --git a/doc/reference/tooling/tt_cli/replicaset.rst b/doc/tooling/tt_cli/replicaset.rst similarity index 100% rename from doc/reference/tooling/tt_cli/replicaset.rst rename to doc/tooling/tt_cli/replicaset.rst diff --git a/doc/reference/tooling/tt_cli/restart.rst b/doc/tooling/tt_cli/restart.rst similarity index 100% rename from doc/reference/tooling/tt_cli/restart.rst rename to doc/tooling/tt_cli/restart.rst diff --git a/doc/reference/tooling/tt_cli/rocks.rst b/doc/tooling/tt_cli/rocks.rst similarity index 100% rename from doc/reference/tooling/tt_cli/rocks.rst rename to doc/tooling/tt_cli/rocks.rst diff --git a/doc/reference/tooling/tt_cli/run.rst b/doc/tooling/tt_cli/run.rst similarity index 100% rename from doc/reference/tooling/tt_cli/run.rst rename to doc/tooling/tt_cli/run.rst diff --git a/doc/reference/tooling/tt_cli/search.rst b/doc/tooling/tt_cli/search.rst similarity index 100% rename from doc/reference/tooling/tt_cli/search.rst rename to doc/tooling/tt_cli/search.rst diff --git a/doc/reference/tooling/tt_cli/start.rst b/doc/tooling/tt_cli/start.rst similarity index 100% rename from doc/reference/tooling/tt_cli/start.rst rename to doc/tooling/tt_cli/start.rst diff --git a/doc/book/admin/start_stop_instance.rst b/doc/tooling/tt_cli/start_stop_instance.rst similarity index 100% rename from doc/book/admin/start_stop_instance.rst rename to doc/tooling/tt_cli/start_stop_instance.rst diff --git a/doc/reference/tooling/tt_cli/status.rst b/doc/tooling/tt_cli/status.rst similarity index 100% rename from doc/reference/tooling/tt_cli/status.rst rename to doc/tooling/tt_cli/status.rst diff --git a/doc/reference/tooling/tt_cli/stop.rst b/doc/tooling/tt_cli/stop.rst similarity index 100% rename from doc/reference/tooling/tt_cli/stop.rst rename to doc/tooling/tt_cli/stop.rst diff --git a/doc/reference/tooling/tt_cli/tdg2.rst b/doc/tooling/tt_cli/tdg2.rst similarity index 100% rename from doc/reference/tooling/tt_cli/tdg2.rst rename to doc/tooling/tt_cli/tdg2.rst diff --git a/doc/reference/tooling/tt_cli/tt_interactive_console.rst b/doc/tooling/tt_cli/tt_interactive_console.rst similarity index 100% rename from doc/reference/tooling/tt_cli/tt_interactive_console.rst rename to doc/tooling/tt_cli/tt_interactive_console.rst diff --git a/doc/reference/tooling/tt_cli/uninstall.rst b/doc/tooling/tt_cli/uninstall.rst similarity index 100% rename from doc/reference/tooling/tt_cli/uninstall.rst rename to doc/tooling/tt_cli/uninstall.rst diff --git a/doc/reference/tooling/tt_cli/version.rst b/doc/tooling/tt_cli/version.rst similarity index 100% rename from doc/reference/tooling/tt_cli/version.rst rename to doc/tooling/tt_cli/version.rst