From 4586a42f74d0856a00514ec2ea60243c94bbbf5e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vedran=20Ivankovi=C4=87?= <33936733+Veki301@users.noreply.github.com> Date: Thu, 29 Sep 2022 10:20:27 +0200 Subject: [PATCH 1/4] JCT-146/update saml sso documentation --- docs/src/understand/single-sign-on/main.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/understand/single-sign-on/main.rst b/docs/src/understand/single-sign-on/main.rst index e12c4c69a00..8603a8fd71f 100644 --- a/docs/src/understand/single-sign-on/main.rst +++ b/docs/src/understand/single-sign-on/main.rst @@ -256,7 +256,7 @@ You need to configure your SCIM client to use the following mandatory SCIM attri 3. The ``externalId`` attribute: - a. If you are using Wire's SAML SSO feature then set ``externalId`` attribute to the same identifier used for ``NameID`` in your SAML configuration (both fields must match case sensitively). + a. If you are using Wire's SAML SSO feature then set ``externalId`` attribute to the same identifier used for ``NameID`` in your SAML configuration. b. If you are using email/password authentication then set the ``externalId`` attribute to the user's email address. The user will receive an invitation email during provisioning. Also note that the account will be set to ``"active": false`` until the user has accepted the invitation and activated the account. From 45b4605ba558c17aad279b0a648f567f5dfdaee8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vedran=20Ivankovi=C4=87?= <33936733+Veki301@users.noreply.github.com> Date: Thu, 29 Sep 2022 10:21:04 +0200 Subject: [PATCH 2/4] SER-211/update cassandra nodetool documentation --- docs/src/how-to/administrate/backup-disaster-recovery.md | 3 +++ docs/src/how-to/administrate/cassandra.rst | 8 +++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/src/how-to/administrate/backup-disaster-recovery.md b/docs/src/how-to/administrate/backup-disaster-recovery.md index 5d525b66017..d714036be8f 100644 --- a/docs/src/how-to/administrate/backup-disaster-recovery.md +++ b/docs/src/how-to/administrate/backup-disaster-recovery.md @@ -71,6 +71,9 @@ Make sure (while connected via ssh) your Cassandra installation is doing well wi nodetool status +or (in newer versions) + + nodetool ::FFFF:127.0.0.1 status You should see a list of nodes like this: diff --git a/docs/src/how-to/administrate/cassandra.rst b/docs/src/how-to/administrate/cassandra.rst index cdb8fe8930a..3ecc423ea5a 100644 --- a/docs/src/how-to/administrate/cassandra.rst +++ b/docs/src/how-to/administrate/cassandra.rst @@ -15,6 +15,12 @@ To check the health of a Cassandra node, run the following command: ssh <ip of cassandra node> /opt/cassandra/bin/nodetool status +or if you are running a newer version of wire-server (altough it should be backwards compatibile) + +.. code:: sh + + ssh <ip of cassandra node> /opt/cassandra/bin/nodetool ::FFFF:127.0.0.1 status + You should see a list of nodes like this: .. code:: sh @@ -49,7 +55,7 @@ For maintenance you may need to restart the cluster. On each server one by one: -1. check your cluster is healthy: ``nodetool status`` +1. check your cluster is healthy: ``nodetool status`` or ``nodetool ::FFFF:127.0.0.1 status`` (in newer versions) 2. ``nodetool drain && systemctl stop cassandra`` (to stop accepting writes and flush data to disk; then stop the process) 3. do any operation you need, if any 4. Start the cassandra daemon process: ``systemctl start cassandra`` From 5cf4a4a999403d4422816fa52f5f96fbbaff4949 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vedran=20Ivankovi=C4=87?= <33936733+Veki301@users.noreply.github.com> Date: Thu, 29 Sep 2022 10:24:56 +0200 Subject: [PATCH 3/4] added changelog --- changelog.d/4-docs/pr-2736 | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 changelog.d/4-docs/pr-2736 diff --git a/changelog.d/4-docs/pr-2736 b/changelog.d/4-docs/pr-2736 new file mode 100644 index 00000000000..72a2a4159e4 --- /dev/null +++ b/changelog.d/4-docs/pr-2736 @@ -0,0 +1,2 @@ +JCT-146 - update outdated info +SER-211 - update new info regarding nodetool use From 9625693028fa3158ca31da459ffbaff11ad6c32d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vedran=20Ivankovi=C4=87?= <33936733+Veki301@users.noreply.github.com> Date: Wed, 5 Oct 2022 10:59:00 +0200 Subject: [PATCH 4/4] fix: missing -h param in nodetool docs --- docs/src/how-to/administrate/backup-disaster-recovery.md | 2 +- docs/src/how-to/administrate/cassandra.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/how-to/administrate/backup-disaster-recovery.md b/docs/src/how-to/administrate/backup-disaster-recovery.md index d714036be8f..43f2e19833f 100644 --- a/docs/src/how-to/administrate/backup-disaster-recovery.md +++ b/docs/src/how-to/administrate/backup-disaster-recovery.md @@ -73,7 +73,7 @@ Make sure (while connected via ssh) your Cassandra installation is doing well wi or (in newer versions) - nodetool ::FFFF:127.0.0.1 status + nodetool -h ::FFFF:127.0.0.1 status You should see a list of nodes like this: diff --git a/docs/src/how-to/administrate/cassandra.rst b/docs/src/how-to/administrate/cassandra.rst index 3ecc423ea5a..180a8f2a8c7 100644 --- a/docs/src/how-to/administrate/cassandra.rst +++ b/docs/src/how-to/administrate/cassandra.rst @@ -19,7 +19,7 @@ or if you are running a newer version of wire-server (altough it should be backw .. code:: sh - ssh <ip of cassandra node> /opt/cassandra/bin/nodetool ::FFFF:127.0.0.1 status + ssh <ip of cassandra node> /opt/cassandra/bin/nodetool -h ::FFFF:127.0.0.1 status You should see a list of nodes like this: @@ -55,7 +55,7 @@ For maintenance you may need to restart the cluster. On each server one by one: -1. check your cluster is healthy: ``nodetool status`` or ``nodetool ::FFFF:127.0.0.1 status`` (in newer versions) +1. check your cluster is healthy: ``nodetool status`` or ``nodetool -h ::FFFF:127.0.0.1 status`` (in newer versions) 2. ``nodetool drain && systemctl stop cassandra`` (to stop accepting writes and flush data to disk; then stop the process) 3. do any operation you need, if any 4. Start the cassandra daemon process: ``systemctl start cassandra``