Skip to content

Commit

Permalink
docs: fix do command name
Browse files Browse the repository at this point in the history
  • Loading branch information
Danyal-Faheem committed Sep 16, 2024
1 parent 24e8872 commit d56029f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/local.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,11 +150,11 @@ As of MySQL v8.4.0, the ``mysql_native_password`` authentication plugin has been

Tutor makes it easy do so with this handy command::

tutor local do update_mysql_authentication_plugin
tutor local do update-mysql-authentication-plugin

The above command will update all the database users created by Tutor. If you only want to update the authentication plugin of specific users, you can use the ``--users`` option. This option takes comma seperated names of users to upgrade::

tutor local do update_mysql_authentication_plugin --users=discovery,ecommerce
tutor local do update-mysql-authentication-plugin --users=discovery,ecommerce

For this command, Tutor expects specific entries in the configuration for the mysql username and password of a database user. For example, if you are trying to update the user ``myuser``, the following case sensitive entries need to be present in the configuration::

Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -222,4 +222,4 @@ The detailed steps are mentioned in `tutor-mfe <https://github.com/overhangio/tu

This issue can occur when Tutor is upgraded from v15 (Olive) or earlier to v18 (Redwood) because the users created in Tutor v15 utilize the mysql_native_password authentication plugin by default. This plugin has been deprecated as of MySQL v8.4.0 which is the default MySQL server used in Tutor v18.

The handy :ref:`update_mysql_authentication_plugin <update_mysql_authentication_plugin>` do command in tutor can be used to fix this issue.
The handy :ref:`update-mysql-authentication-plugin <update_mysql_authentication_plugin>` do command in tutor can be used to fix this issue.

0 comments on commit d56029f

Please sign in to comment.