From 3b5add05a7a2a8b10371547b4ea1726a87c24fef Mon Sep 17 00:00:00 2001 From: Anna Stuchlik Date: Fri, 29 Jul 2022 10:02:37 +0200 Subject: [PATCH 1/8] doc: add redirections to manager.docs.scylladb.com --- docs/_utils/redirects.yaml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/_utils/redirects.yaml b/docs/_utils/redirects.yaml index c309cef2c7..e8e0b4b2a8 100644 --- a/docs/_utils/redirects.yaml +++ b/docs/_utils/redirects.yaml @@ -14,6 +14,29 @@ /stable/operating-scylla/scylla-operator/index.html: https://operator.docs.scylladb.com/stable/ +### removing the old Monitoring Stack 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/ ### moving the CQL reference files to the new cql folder From c9db3bd7ea5d64d9d489aabcaf2371712725a116 Mon Sep 17 00:00:00 2001 From: Anna Stuchlik Date: Fri, 29 Jul 2022 10:24:58 +0200 Subject: [PATCH 2/8] doc: add redirections from Manager 2.1 to the Manager docs --- docs/_utils/redirects.yaml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/_utils/redirects.yaml b/docs/_utils/redirects.yaml index e8e0b4b2a8..7eb50d68ec 100644 --- a/docs/_utils/redirects.yaml +++ b/docs/_utils/redirects.yaml @@ -37,6 +37,21 @@ /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 From f72e16b013efb0eb11ef864477a8d0553b974a73 Mon Sep 17 00:00:00 2001 From: Anna Stuchlik Date: Fri, 29 Jul 2022 11:10:49 +0200 Subject: [PATCH 3/8] doc: remove the docs for Manager - the Manager page, the guide for Manager 2.1, Manger upgrade guides --- .../manager/2.1/_common/cluster-params.rst | 40 - .../manager/2.1/_common/glob.rst | 10 - .../2.1/_common/manager-description.rst | 6 - .../manager/2.1/_common/param-cluster.rst | 3 - .../manager/2.1/_common/task-id-note.rst | 3 - .../manager/2.1/_common/task-params.rst | 41 - .../manager/2.1/add-a-cluster.rst | 162 -- .../manager/2.1/agent-configuration-file.rst | 205 --- .../manager/2.1/architecture.jpg | Bin 153995 -> 0 bytes .../manager/2.1/architecture.png | Bin 228611 -> 0 bytes .../manager/2.1/architecture.rst | 57 - docs/operating-scylla/manager/2.1/backup.rst | 330 ---- .../manager/2.1/configuration-file.rst | 181 -- .../2.1/extract-schema-from-backup.rst | 40 - .../manager/2.1/health-check.rst | 85 - docs/operating-scylla/manager/2.1/index.rst | 46 - .../manager/2.1/install-agent.rst | 181 -- docs/operating-scylla/manager/2.1/install.rst | 132 -- .../2.1/monitoring-manager-integration.rst | 11 - docs/operating-scylla/manager/2.1/repair.rst | 186 -- .../manager/2.1/restore-a-backup.rst | 348 ---- docs/operating-scylla/manager/2.1/sctool.rst | 1607 ----------------- .../manager/2.1/use-a-remote-db.rst | 123 -- .../manager/_common/manager-description.rst | 4 - .../manager/_common/manager-index.rst | 4 - .../manager/_common/note-versions.rst | 2 - docs/operating-scylla/manager/index.rst | 27 - .../manager/scylla-manager@2x.png | Bin 39177 -> 0 bytes docs/upgrade/upgrade-manager/index.rst | 39 - .../upgrade-guide-from-1.2-to-1.3/index.rst | 34 - .../manager-metric-update-1.2-to-1.3.rst | 32 - ...ide-from-manager-1.2.x-to-1.3.x-CentOS.rst | 179 -- ...ide-from-manager-1.2.x-to-1.3.x-ubuntu.rst | 188 -- .../upgrade-guide-from-1.3-to-1.4/index.rst | 34 - .../manager-metric-update-1.3-to-1.4.rst | 21 - ...ide-from-manager-1.3.x-to-1.4.x-CentOS.rst | 181 -- ...ide-from-manager-1.3.x-to-1.4.x-ubuntu.rst | 189 -- .../upgrade-guide-from-1.4-to-2.0/index.rst | 31 - .../manager-metric-update-1.4-to-2.0.rst | 17 - ...rade-guide-from-manager-1.4.x-to-2.0.x.rst | 243 --- .../index.rst | 21 - .../upgrade-2.x.a-to-2.y.b.rst | 492 ----- .../upgrade-row-level-repair.rst | 26 - ...rade-guide-from-manager-1.0.x-to-1.1.x.rst | 159 -- ...rade-guide-from-manager-1.1.x-to-1.2.x.rst | 170 -- .../index.rst | 35 - ...ide-from-manager-1.x.y-to-1.x.z-CentOS.rst | 178 -- ...ide-from-manager-1.x.y-to-1.x.z-ubuntu.rst | 188 -- 48 files changed, 6291 deletions(-) delete mode 100644 docs/operating-scylla/manager/2.1/_common/cluster-params.rst delete mode 100644 docs/operating-scylla/manager/2.1/_common/glob.rst delete mode 100644 docs/operating-scylla/manager/2.1/_common/manager-description.rst delete mode 100644 docs/operating-scylla/manager/2.1/_common/param-cluster.rst delete mode 100644 docs/operating-scylla/manager/2.1/_common/task-id-note.rst delete mode 100644 docs/operating-scylla/manager/2.1/_common/task-params.rst delete mode 100644 docs/operating-scylla/manager/2.1/add-a-cluster.rst delete mode 100644 docs/operating-scylla/manager/2.1/agent-configuration-file.rst delete mode 100644 docs/operating-scylla/manager/2.1/architecture.jpg delete mode 100644 docs/operating-scylla/manager/2.1/architecture.png delete mode 100644 docs/operating-scylla/manager/2.1/architecture.rst delete mode 100644 docs/operating-scylla/manager/2.1/backup.rst delete mode 100644 docs/operating-scylla/manager/2.1/configuration-file.rst delete mode 100644 docs/operating-scylla/manager/2.1/extract-schema-from-backup.rst delete mode 100644 docs/operating-scylla/manager/2.1/health-check.rst delete mode 100644 docs/operating-scylla/manager/2.1/index.rst delete mode 100644 docs/operating-scylla/manager/2.1/install-agent.rst delete mode 100644 docs/operating-scylla/manager/2.1/install.rst delete mode 100644 docs/operating-scylla/manager/2.1/monitoring-manager-integration.rst delete mode 100644 docs/operating-scylla/manager/2.1/repair.rst delete mode 100644 docs/operating-scylla/manager/2.1/restore-a-backup.rst delete mode 100644 docs/operating-scylla/manager/2.1/sctool.rst delete mode 100644 docs/operating-scylla/manager/2.1/use-a-remote-db.rst delete mode 100644 docs/operating-scylla/manager/_common/manager-description.rst delete mode 100644 docs/operating-scylla/manager/_common/manager-index.rst delete mode 100644 docs/operating-scylla/manager/_common/note-versions.rst delete mode 100644 docs/operating-scylla/manager/index.rst delete mode 100644 docs/operating-scylla/manager/scylla-manager@2x.png delete mode 100644 docs/upgrade/upgrade-manager/index.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-1.2-to-1.3/index.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-1.2-to-1.3/manager-metric-update-1.2-to-1.3.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-1.2-to-1.3/upgrade-guide-from-manager-1.2.x-to-1.3.x-CentOS.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-1.2-to-1.3/upgrade-guide-from-manager-1.2.x-to-1.3.x-ubuntu.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-1.3-to-1.4/index.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-1.3-to-1.4/manager-metric-update-1.3-to-1.4.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-1.3-to-1.4/upgrade-guide-from-manager-1.3.x-to-1.4.x-CentOS.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-1.3-to-1.4/upgrade-guide-from-manager-1.3.x-to-1.4.x-ubuntu.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-1.4-to-2.0/index.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-1.4-to-2.0/manager-metric-update-1.4-to-2.0.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-1.4-to-2.0/upgrade-guide-from-manager-1.4.x-to-2.0.x.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-2.x.a-to-2.y.b/index.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-2.x.a-to-2.y.b/upgrade-2.x.a-to-2.y.b.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-2.x.a-to-2.y.b/upgrade-row-level-repair.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-manager-1.0.x-to-1.1.x.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-from-manager-1.1.x-to-1.2.x.rst delete mode 100644 docs/upgrade/upgrade-manager/upgrade-guide-maintenance-1.x.y-to-1.x.z/index.rst delete mode 100644 docs/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.rst delete mode 100644 docs/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.rst 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