diff --git a/docs/_utils/redirects.yaml b/docs/_utils/redirects.yaml index c309cef2c7..03328f41ed 100644 --- a/docs/_utils/redirects.yaml +++ b/docs/_utils/redirects.yaml @@ -14,6 +14,44 @@ /stable/operating-scylla/scylla-operator/index.html: https://operator.docs.scylladb.com/stable/ +### removing the old Scylla Manager documentation from the ScyllaDB docs + +/stable/operating-scylla/manager/index.html: https://manager.docs.scylladb.com/ +/stable/upgrade/upgrade-manager/index.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-maintenance-1.x.y-to-1.x.z/index.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-maintenance-1.x.y-to-1.x.z/upgrade-guide-from-manager-1.x.y-to-1.x.z-CentOS.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-maintenance-1.x.y-to-1.x.z/upgrade-guide-from-manager-1.x.y-to-1.x.z-ubuntu.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-manager-1.0.x-to-1.1.x.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-manager-1.1.x-to-1.2.x.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-1.2-to-1.3/index.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-1.2-to-1.3/upgrade-guide-from-manager-1.2.x-to-1.3.x-CentOS.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-1.2-to-1.3/upgrade-guide-from-manager-1.2.x-to-1.3.x-ubuntu.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-1.2-to-1.3/manager-metric-update-1.2-to-1.3.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-1.3-to-1.4/index.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-1.3-to-1.4/upgrade-guide-from-manager-1.3.x-to-1.4.x-CentOS.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-1.3-to-1.4/upgrade-guide-from-manager-1.3.x-to-1.4.x-ubuntu.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-1.3-to-1.4/manager-metric-update-1.3-to-1.4.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-1.4-to-2.0/index.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-1.4-to-2.0/upgrade-guide-from-manager-1.4.x-to-2.0.x.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-1.4-to-2.0/manager-metric-update-1.4-to-2.0.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-2.x.a-to-2.y.b/index.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-2.x.a-to-2.y.b/upgrade-2.x.a-to-2.y.b.html: https://manager.docs.scylladb.com/stable/upgrade/index.html +/stable/upgrade/upgrade-manager/upgrade-guide-from-2.x.a-to-2.y.b/upgrade-row-level-repair.html: https://www.scylladb.com/2019/08/13/scylla-open-source-3-1-efficiently-maintaining-consistency-with-row-level-repair/ +stable/operating-scylla/manager/2.1/index.html: https://manager.docs.scylladb.com/ +/stable/operating-scylla/manager/2.1/architecture.html: https://manager.docs.scylladb.com/ +/stable/operating-scylla/manager/2.1/install.html: https://manager.docs.scylladb.com/stable/install-scylla-manager.html +/stable/operating-scylla/manager/2.1/install-agent.html: https://manager.docs.scylladb.com/stable/install-scylla-manager-agent.html +/stable/operating-scylla/manager/2.1/add-a-cluster.html: https://manager.docs.scylladb.com/stable/add-a-cluster.html +/stable/operating-scylla/manager/2.1/repair.html: https://manager.docs.scylladb.com/stable/repair/index.html +/stable/operating-scylla/manager/2.1/backup.html: https://manager.docs.scylladb.com/stable/backup/index.html +/stable/operating-scylla/manager/2.1/extract-schema-from-backup.html: https://manager.docs.scylladb.com/stable/sctool/backup.html +/stable/operating-scylla/manager/2.1/restore-a-backup.html: https://manager.docs.scylladb.com/stable/restore/index.html +/stable/operating-scylla/manager/2.1/health-check.html: https://manager.docs.scylladb.com/stable/health-check.html +/stable/operating-scylla/manager/2.1/sctool.html: https://manager.docs.scylladb.com/stable/sctool/index.html +/stable/operating-scylla/manager/2.1/monitoring-manager-integration.html: https://manager.docs.scylladb.com/stable/scylla-monitoring.html +/stable/operating-scylla/manager/2.1/use-a-remote-db.html: https://manager.docs.scylladb.com/ +/stable/operating-scylla/manager/2.1/configuration-file.html: https://manager.docs.scylladb.com/stable/config/scylla-manager-config.html +/stable/operating-scylla/manager/2.1/agent-configuration-file.html: https://manager.docs.scylladb.com/stable/config/scylla-manager-agent-config.html ### moving the CQL reference files to the new cql folder diff --git a/docs/faq.rst b/docs/faq.rst index 9a2b2ef9bd..fa5b5ede78 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -431,7 +431,7 @@ Is ``Nodetool Repair`` a Local (One Node) Operation or a Global (Full Cluster) O When running :doc:`nodetool repair ` on a node, it performs a repair on every token range this node owns; this will also repair other nodes that share the same range. -If you wish to repair the entire cluster, it is recommended to run ``nodetool repair -pr`` on each node in the cluster, sequentially, or use the :doc:`Scylla Manager `. +If you wish to repair the entire cluster, it is recommended to run ``nodetool repair -pr`` on each node in the cluster, sequentially, or use the `ScyllaDB Manager `_. How can I change the maximum number of IN restrictions? diff --git a/docs/kb/compaction.rst b/docs/kb/compaction.rst index a8d9fcec4d..e358043baf 100644 --- a/docs/kb/compaction.rst +++ b/docs/kb/compaction.rst @@ -34,7 +34,7 @@ There are two types of compactions: View Compaction Statistics -------------------------- -Scylla has tools you can use to see the status of your compactions. These include nodetool (:doc:`compactionhistory ` and :doc:`compactionstats `) and the Grafana dashboards which are part of the `Scylla Monitoring Stack `_ which display the compaction statistics on a per cluster and per node basis. Compaction errors can be seen in the :ref:`logs `. +Scylla has tools you can use to see the status of your compactions. These include nodetool (:doc:`compactionhistory ` and :doc:`compactionstats `) and the Grafana dashboards which are part of the `Scylla Monitoring Stack `_ which display the compaction statistics on a per cluster and per node basis. Compaction errors can be seen in the `logs `_. Compaction strategy ------------------- diff --git a/docs/kb/gc-grace-seconds.rst b/docs/kb/gc-grace-seconds.rst index ea07ca7967..1c437ba5f0 100644 --- a/docs/kb/gc-grace-seconds.rst +++ b/docs/kb/gc-grace-seconds.rst @@ -23,11 +23,11 @@ In addition, you should follow the procedure below in order to avoid data resurr Resolution ---------- -#. Run a :doc:`full repair ` for the table in question. +#. Run a `full repair `_ for the table in question. #. Change the ``gc_grace_seconds`` value for the table using the :ref:`ALTER table ` command. #. Verify that the schema is in sync after the change by issuing :doc:`nodetool describecluster ` command from all nodes. Verify that only a single schema version is reported. Read the :doc:`Schema Mismatch Troubleshooting Guide ` if it's not the case. -#. Make sure that you run at least one :doc:`full repair ` for the table in question during the ``gc_grace_seconds`` time window. +#. Make sure that you run at least one `full repair `_ for the table in question during the ``gc_grace_seconds`` time window. For example, if the ``gc_grace_seconds`` is set to 10 days, you should run a full repair on your tables every 8-9 days to make sure your tables are repaired before the ``gc_grace_seconds`` threshold is reached. diff --git a/docs/kb/stop-local-repair.rst b/docs/kb/stop-local-repair.rst index 1eb75e806b..c098685891 100644 --- a/docs/kb/stop-local-repair.rst +++ b/docs/kb/stop-local-repair.rst @@ -40,4 +40,4 @@ Please check if the aborted repair stays in RUNNING forever before forcing a sto curl -X POST "http://127.0.0.2:10000/storage_service/force_terminate_repair" -**NOTE:** If you are using :doc:`Scylla Manager ` for repairs, a simple stop command via sctool already implements all the needed logic to gracefully stop a repair. +**NOTE:** If you are using `ScyllaDB Manager `_ for repairs, a simple stop command via sctool already implements all the needed logic to gracefully stop a repair. diff --git a/docs/operating-scylla/index.rst b/docs/operating-scylla/index.rst index e5a72914fb..23a5f4a3b7 100644 --- a/docs/operating-scylla/index.rst +++ b/docs/operating-scylla/index.rst @@ -12,6 +12,9 @@ Scylla for Administrators manager/index ScyllaDB Monitoring Stack ScyllaDB Operator + ScyllaDB Manager + Scylla Monitoring Stack + Scylla Operator Upgrade Procedures System Configuration benchmarking-scylla @@ -33,9 +36,15 @@ Scylla for Administrators :class: my-panel * :doc:`Scylla Tools ` - Tools for Administrating and integrating with Scylla +<<<<<<< HEAD * :doc:`Scylla Manager ` - Tool for cluster administration and automation * `ScyllaDB Monitoring Stack `_ - Tool for cluster monitoring and alerting * `ScyllaDB Operator `_ - Tool to run Scylla on Kubernetes +======= + * `ScyllaDB Manager `_ - Tool for cluster administration and automation + * :doc:`Scylla Monitoring Stack ` - Tool for cluster monitoring and alerting + * :doc:`Scylla Operator ` - Tool to run Scylla on Kubernetes +>>>>>>> 40050f951 (doc: add the link to manager.docs.scylladb.com to the toctree) * :doc:`Scylla Logs ` .. panel-box:: diff --git a/docs/operating-scylla/manager/2.1/_common/cluster-params.rst b/docs/operating-scylla/manager/2.1/_common/cluster-params.rst deleted file mode 100644 index 21c16738fb..0000000000 --- a/docs/operating-scylla/manager/2.1/_common/cluster-params.rst +++ /dev/null @@ -1,40 +0,0 @@ -``--host `` - -Specifies the hostname or IP of the node that will be used to discover other nodes belonging to the cluster. -Note that this will be persisted and used every time Scylla Manager starts. You can use either an IPv4 or IPv6 address. - -===== - -``-n, --name `` - -When a cluster is added, it is assigned a unique identifier. -Use this parameter to identify the cluster by an alias name which is more meaningful. -This alias name can be used with all commands that accept ``-c, --cluster`` parameter. - -===== - -``--auth-token `` - -Specifies the :ref:`authentication token ` you identified in ``/etc/scylla-manager-agent/scylla-manager-agent.yaml`` - -===== - -``-u, --username `` - -Optional CQL username, for security reasons this user should NOT have access to your data. -If you specify the CQL username and password, the CQL health check you see in `status`_ would try to login and execute a query against system keyspace. -Otherwise CQL health check is based on sending `CQL OPTIONS frame `_ and does not start a CQL session. - -===== - -``-p, --password `` - -CQL password associated with username. - -===== - -``--without-repair`` - -When cluster is added, Manager schedules repair to repeat every 7 days. To create a cluster without a scheduled repair, use this flag. - - diff --git a/docs/operating-scylla/manager/2.1/_common/glob.rst b/docs/operating-scylla/manager/2.1/_common/glob.rst deleted file mode 100644 index 63f25dea23..0000000000 --- a/docs/operating-scylla/manager/2.1/_common/glob.rst +++ /dev/null @@ -1,10 +0,0 @@ -The following syntax is supported: - -* ``*`` - matches any number of any characters including none -* ``?`` - matches any single character -* ``[abc]`` - matches one character given in the bracket -* ``[a-z]`` - matches one character from the range given in the bracket - -Patterns are evaluated from left to right. -If a pattern starts with ``!`` it unselects items that were selected by previous patterns -i.e. ``a?,!aa`` selects *ab* but not *aa*. diff --git a/docs/operating-scylla/manager/2.1/_common/manager-description.rst b/docs/operating-scylla/manager/2.1/_common/manager-description.rst deleted file mode 100644 index 5e30033865..0000000000 --- a/docs/operating-scylla/manager/2.1/_common/manager-description.rst +++ /dev/null @@ -1,6 +0,0 @@ -Scylla Manager is a product for database operations automation, it can schedule tasks such as repairs and backups. -Scylla Manager can manage multiple Scylla clusters and run cluster-wide tasks in a controlled and predictable way. - -Scylla Manager is available for Scylla Enterprise customers and Scylla Open Source users. -With Scylla Open Source, Scylla Manager is limited to 5 nodes. -See the Scylla Manager Proprietary Software `License Agreement `_ for details. diff --git a/docs/operating-scylla/manager/2.1/_common/param-cluster.rst b/docs/operating-scylla/manager/2.1/_common/param-cluster.rst deleted file mode 100644 index 1a848a4978..0000000000 --- a/docs/operating-scylla/manager/2.1/_common/param-cluster.rst +++ /dev/null @@ -1,3 +0,0 @@ -``-c`` , ``--cluster`` - -This is the cluster name is the name you assigned when you created the cluster (`cluster add`_). You can see the cluster name and ID by running the command `cluster list`_. \ No newline at end of file diff --git a/docs/operating-scylla/manager/2.1/_common/task-id-note.rst b/docs/operating-scylla/manager/2.1/_common/task-id-note.rst deleted file mode 100644 index 11a5150bf6..0000000000 --- a/docs/operating-scylla/manager/2.1/_common/task-id-note.rst +++ /dev/null @@ -1,3 +0,0 @@ -A task ID with a type (repair, for example) is **required** for this command. -This is a unique ID which is created when the task was made. -To display the ID, run the command ``sctool task list`` (see `task list`_). \ No newline at end of file diff --git a/docs/operating-scylla/manager/2.1/_common/task-params.rst b/docs/operating-scylla/manager/2.1/_common/task-params.rst deleted file mode 100644 index 8de540d0ce..0000000000 --- a/docs/operating-scylla/manager/2.1/_common/task-params.rst +++ /dev/null @@ -1,41 +0,0 @@ -``--interval