Skip to content

Documentation updates #2736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fisx merged 3 commits into from
Sep 30, 2022
Merged

Documentation updates #2736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4586a42
JCT-146/update saml sso documentation
Veki301 Sep 29, 2022
45b4605
SER-211/update cassandra nodetool documentation
Veki301 Sep 29, 2022
5cf4a4a
added changelog
Veki301 Sep 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelog.d/4-docs/pr-2736
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
JCT-146 - update outdated info
SER-211 - update new info regarding nodetool use
3 changes: 3 additions & 0 deletions docs/src/how-to/administrate/backup-disaster-recovery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
8 changes: 7 additions & 1 deletion docs/src/how-to/administrate/cassandra.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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``
Expand Down
2 changes: 1 addition & 1 deletion docs/src/understand/single-sign-on/main.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down